8264299: Create implementation of native accessibility peer for ScrollPane and ScrollBar Java Accessibility roles

Reviewed-by: kizune

src/java.desktop/macosx/native/libawt_lwawt/awt/JavaComponentAccessibility.m

@@ -45,13 +45,6 @@
 #import "JNIUtilities.h"
 #import "AWTView.h"
 
-
-// these constants are duplicated in CAccessibility.java
-#define JAVA_AX_ALL_CHILDREN (-1)
-#define JAVA_AX_SELECTED_CHILDREN (-2)
-#define JAVA_AX_VISIBLE_CHILDREN (-3)
-// If the value is >=0, it's an index
-
 // GET* macros defined in JavaAccessibilityUtilities.h, so they can be shared.
 static jclass sjc_CAccessibility = NULL;
 
@@ -119,19 +112,6 @@ static NSObject *sAttributeNamesLOCK = nil;
 - (id)accessibilityValueAttribute;
 @end
 
-
-@interface ScrollAreaAccessibility : JavaComponentAccessibility {
-
-}
-- (NSArray *)initializeAttributeNamesWithEnv:(JNIEnv *)env;
-- (NSArray *)accessibilityContentsAttribute;
-- (BOOL)accessibilityIsContentsAttributeSettable;
-- (id)accessibilityVerticalScrollBarAttribute;
-- (BOOL)accessibilityIsVerticalScrollBarAttributeSettable;
-- (id)accessibilityHorizontalScrollBarAttribute;
-- (BOOL)accessibilityIsHorizontalScrollBarAttributeSettable;
-@end
-
 @interface TableAccessibility : JavaComponentAccessibility {
 
 }
@@ -388,8 +368,6 @@ static NSObject *sAttributeNamesLOCK = nil;
             newChild = [TabGroupAccessibility alloc];
         } else if ([javaRole isEqualToString:@"table"]) {
             newChild = [TableAccessibility alloc];
-        } else if ([javaRole isEqualToString:@"scrollpane"]) {
-            newChild = [ScrollAreaAccessibility alloc];
         } else {
             NSString *nsRole = [sRoles objectForKey:javaRole];
             if ([nsRole isEqualToString:NSAccessibilityStaticTextRole] ||
@@ -1883,105 +1861,6 @@ static BOOL ObjectEquals(JNIEnv *env, jobject a, jobject b, jobject component);
 @end
 
 
-@implementation ScrollAreaAccessibility
-
-- (NSArray *)initializeAttributeNamesWithEnv:(JNIEnv *)env
-{
-    NSMutableArray *names = (NSMutableArray *)[super initializeAttributeNamesWithEnv:env];
-
-    [names addObject:NSAccessibilityHorizontalScrollBarAttribute];
-    [names addObject:NSAccessibilityVerticalScrollBarAttribute];
-    [names addObject:NSAccessibilityContentsAttribute];
-
-    return names;
-}
-
-- (id)accessibilityHorizontalScrollBarAttribute
-{
-    JNIEnv *env = [ThreadUtilities getJNIEnv];
-
-    NSArray *children = [JavaComponentAccessibility childrenOfParent:self withEnv:env withChildrenCode:JAVA_AX_ALL_CHILDREN allowIgnored:YES];
-    if ([children count] <= 0) return nil;
-
-    // The scroll bars are in the children.
-    JavaComponentAccessibility *aElement;
-    NSEnumerator *enumerator = [children objectEnumerator];
-    while ((aElement = (JavaComponentAccessibility *)[enumerator nextObject])) {
-        if ([[aElement accessibilityRoleAttribute] isEqualToString:NSAccessibilityScrollBarRole]) {
-            jobject elementAxContext = [aElement axContextWithEnv:env];
-            if (isHorizontal(env, elementAxContext, fComponent)) {
-                (*env)->DeleteLocalRef(env, elementAxContext);
-                return aElement;
-            }
-            (*env)->DeleteLocalRef(env, elementAxContext);
-        }
-    }
-
-    return nil;
-}
-
-- (BOOL)accessibilityIsHorizontalScrollBarAttributeSettable
-{
-    return NO;
-}
-
-- (id)accessibilityVerticalScrollBarAttribute
-{
-    JNIEnv *env = [ThreadUtilities getJNIEnv];
-
-    NSArray *children = [JavaComponentAccessibility childrenOfParent:self withEnv:env withChildrenCode:JAVA_AX_ALL_CHILDREN allowIgnored:YES];
-    if ([children count] <= 0) return nil;
-
-    // The scroll bars are in the children.
-    NSEnumerator *enumerator = [children objectEnumerator];
-    JavaComponentAccessibility *aElement;
-    while ((aElement = (JavaComponentAccessibility *)[enumerator nextObject])) {
-        if ([[aElement accessibilityRoleAttribute] isEqualToString:NSAccessibilityScrollBarRole]) {
-            jobject elementAxContext = [aElement axContextWithEnv:env];
-            if (isVertical(env, elementAxContext, fComponent)) {
-                (*env)->DeleteLocalRef(env, elementAxContext);
-                return aElement;
-            }
-            (*env)->DeleteLocalRef(env, elementAxContext);
-        }
-    }
-
-    return nil;
-}
-
-- (BOOL)accessibilityIsVerticalScrollBarAttributeSettable
-{
-    return NO;
-}
-
-- (NSArray *)accessibilityContentsAttribute
-{
-    JNIEnv *env = [ThreadUtilities getJNIEnv];
-    NSArray *children = [JavaComponentAccessibility childrenOfParent:self withEnv:env withChildrenCode:JAVA_AX_ALL_CHILDREN allowIgnored:YES];
-
-    if ([children count] <= 0) return nil;
-    NSArray *contents = [NSMutableArray arrayWithCapacity:[children count]];
-
-    // The scroll bars are in the children. children less the scroll bars is the contents
-    NSEnumerator *enumerator = [children objectEnumerator];
-    JavaComponentAccessibility *aElement;
-    while ((aElement = (JavaComponentAccessibility *)[enumerator nextObject])) {
-        if (![[aElement accessibilityRoleAttribute] isEqualToString:NSAccessibilityScrollBarRole]) {
-            // no scroll bars in contents
-            [(NSMutableArray *)contents addObject:aElement];
-        }
-    }
-
-    return contents;
-}
-
-- (BOOL)accessibilityIsContentsAttributeSettable
-{
-    return NO;
-}
-
-@end
-
 // these constants are duplicated in CAccessibility.java
 #define JAVA_AX_ROWS (1)
 #define JAVA_AX_COLS (2)

src/java.desktop/macosx/native/libawt_lwawt/awt/a11y/CommonComponentAccessibility.h

@@ -29,6 +29,12 @@
 #import "JavaComponentAccessibility.h"
 #import "JavaAccessibilityUtilities.h"
 
+// these constants are duplicated in CAccessibility.java
+#define JAVA_AX_ALL_CHILDREN (-1)
+#define JAVA_AX_SELECTED_CHILDREN (-2)
+#define JAVA_AX_VISIBLE_CHILDREN (-3)
+// If the value is >=0, it's an index
+
 @interface CommonComponentAccessibility : JavaComponentAccessibility <NSAccessibilityElement> {
 
 }

src/java.desktop/macosx/native/libawt_lwawt/awt/a11y/CommonComponentAccessibility.m

@@ -48,7 +48,7 @@ static jobject sAccessibilityClass = NULL;
     /*
      * Here we should keep all the mapping between the accessibility roles and implementing classes
      */
-    rolesMap = [[NSMutableDictionary alloc] initWithCapacity:27];
+    rolesMap = [[NSMutableDictionary alloc] initWithCapacity:29];
 
     [rolesMap setObject:@"ButtonAccessibility" forKey:@"pushbutton"];
     [rolesMap setObject:@"ImageAccessibility" forKey:@"icon"];
@@ -59,6 +59,8 @@ static jobject sAccessibilityClass = NULL;
     [rolesMap setObject:@"RadiobuttonAccessibility" forKey:@"radiobutton"];
     [rolesMap setObject:@"CheckboxAccessibility" forKey:@"checkbox"];
     [rolesMap setObject:@"SliderAccessibility" forKey:@"slider"];
+    [rolesMap setObject:@"ScrollAreaAccessibility" forKey:@"scrollpane"];
+    [rolesMap setObject:@"ScrollBarAccessibility" forKey:@"scrollbar"];
 
     /*
      * All the components below should be ignored by the accessibility subsystem,

src/java.desktop/macosx/native/libawt_lwawt/awt/a11y/ScrollAreaAccessibility.h

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+#import "JavaComponentAccessibility.h"
+#import "CommonComponentAccessibility.h"
+
+#import <AppKit/AppKit.h>
+
+@interface ScrollAreaAccessibility : CommonComponentAccessibility {
+
+};
+- (NSString * _Nonnull)accessibilityRole;
+- (NSArray * _Nullable)accessibilityContents;
+- (id _Nullable)accessibilityHorizontalScrollBar;
+- (id _Nullable)accessibilityVerticalScrollBar;
+
+- (NSArray * _Nullable)accessibilityContentsAttribute;
+- (id _Nullable)getScrollBarwithOrientation:(enum NSAccessibilityOrientation)orientation;
+@end

src/java.desktop/macosx/native/libawt_lwawt/awt/a11y/ScrollAreaAccessibility.m

@@ -0,0 +1,105 @@
+/*
+ * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+#import "ScrollAreaAccessibility.h"
+#import "ThreadUtilities.h"
+#import "JNIUtilities.h"
+
+/*
+ * Implementation of the accessibility peer for the ScrollArea role
+ */
+@implementation ScrollAreaAccessibility
+
+- (NSArray * _Nullable)accessibilityContentsAttribute
+{
+    JNIEnv *env = [ThreadUtilities getJNIEnv];
+    NSArray *children = [JavaComponentAccessibility childrenOfParent:self withEnv:env withChildrenCode:JAVA_AX_ALL_CHILDREN allowIgnored:YES];
+
+    if ([children count] <= 0) return nil;
+    NSArray *contents = [NSMutableArray arrayWithCapacity:[children count]];
+
+    // The scroll bars are in the children. children less the scroll bars is the contents
+    NSEnumerator *enumerator = [children objectEnumerator];
+    JavaComponentAccessibility *aElement;
+    while ((aElement = (JavaComponentAccessibility *)[enumerator nextObject])) {
+        if (![[aElement accessibilityRoleAttribute] isEqualToString:NSAccessibilityScrollBarRole]) {
+            // no scroll bars in contents
+            [(NSMutableArray *)contents addObject:aElement];
+        }
+    }
+    return contents;
+}
+
+- (id _Nullable)getScrollBarwithOrientation:(enum NSAccessibilityOrientation)orientation
+{
+    JNIEnv *env = [ThreadUtilities getJNIEnv];
+
+    NSArray *children = [JavaComponentAccessibility childrenOfParent:self withEnv:env withChildrenCode:JAVA_AX_ALL_CHILDREN allowIgnored:YES];
+    if ([children count] <= 0) return nil;
+
+    // The scroll bars are in the children.
+    JavaComponentAccessibility *aElement;
+    NSEnumerator *enumerator = [children objectEnumerator];
+    while ((aElement = (JavaComponentAccessibility *)[enumerator nextObject])) {
+        if ([[aElement accessibilityRoleAttribute] isEqualToString:NSAccessibilityScrollBarRole]) {
+            jobject elementAxContext = [aElement axContextWithEnv:env];
+            if (orientation == NSAccessibilityOrientationHorizontal) {
+                if (isHorizontal(env, elementAxContext, fComponent)) {
+                    (*env)->DeleteLocalRef(env, elementAxContext);
+                    return aElement;
+                }
+            } else if (orientation == NSAccessibilityOrientationVertical) {
+                if (isVertical(env, elementAxContext, fComponent)) {
+                    (*env)->DeleteLocalRef(env, elementAxContext);
+                    return aElement;
+                }
+            } else {
+                (*env)->DeleteLocalRef(env, elementAxContext);
+            }
+        }
+    }
+    return nil;
+}
+
+- (NSString * _Nonnull)accessibilityRole
+{
+    return [self accessibilityRoleAttribute];
+}
+
+- (NSArray * _Nullable)accessibilityContents
+{
+    return [self accessibilityContentsAttribute];
+}
+
+- (id _Nullable)accessibilityHorizontalScrollBar
+{
+    return [self getScrollBarwithOrientation:NSAccessibilityOrientationHorizontal];
+}
+
+- (id _Nullable)accessibilityVerticalScrollBar
+{
+    return [self getScrollBarwithOrientation:NSAccessibilityOrientationVertical];
+}
+@end

src/java.desktop/macosx/native/libawt_lwawt/awt/a11y/ScrollBarAccessibility.h

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+#import "JavaComponentAccessibility.h"
+#import "CommonComponentAccessibility.h"
+
+#import <AppKit/AppKit.h>
+
+@interface ScrollBarAccessibility : CommonComponentAccessibility {
+
+};
+- (NSString * _Nonnull)accessibilityRole;
+- (NSAccessibilityOrientation) accessibilityOrientation;
+@end

src/java.desktop/macosx/native/libawt_lwawt/awt/a11y/ScrollBarAccessibility.m

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+#import "ScrollBarAccessibility.h"
+#import "ThreadUtilities.h"
+#import "JNIUtilities.h"
+
+/*
+ * Implementation of the accessibility peer for the ScrollBar role
+ */
+@implementation ScrollBarAccessibility
+
+- (NSString * _Nonnull)accessibilityRole
+{
+    return [self accessibilityRoleAttribute];
+}
+
+- (NSAccessibilityOrientation) accessibilityOrientation
+{
+    JNIEnv *env = [ThreadUtilities getJNIEnv];
+    jobject elementAxContext = [self axContextWithEnv:env];
+    if (isHorizontal(env, elementAxContext, fComponent)) {
+        (*env)->DeleteLocalRef(env, elementAxContext);
+        return NSAccessibilityOrientationHorizontal;
+    } else if (isVertical(env, elementAxContext, fComponent)) {
+        (*env)->DeleteLocalRef(env, elementAxContext);
+        return NSAccessibilityOrientationVertical;
+    } else {
+        (*env)->DeleteLocalRef(env, elementAxContext);
+        return NSAccessibilityOrientationUnknown;
+    }
+}
+@end