summaryrefslogtreecommitdiff
path: root/libjava/classpath/javax/accessibility/AccessibleRelation.java
diff options
context:
space:
mode:
authorupstream source tree <ports@midipix.org>2015-03-15 20:14:05 -0400
committerupstream source tree <ports@midipix.org>2015-03-15 20:14:05 -0400
commit554fd8c5195424bdbcabf5de30fdc183aba391bd (patch)
tree976dc5ab7fddf506dadce60ae936f43f58787092 /libjava/classpath/javax/accessibility/AccessibleRelation.java
downloadcbb-gcc-4.6.4-554fd8c5195424bdbcabf5de30fdc183aba391bd.tar.bz2
cbb-gcc-4.6.4-554fd8c5195424bdbcabf5de30fdc183aba391bd.tar.xz
obtained gcc-4.6.4.tar.bz2 from upstream website;upstream
verified gcc-4.6.4.tar.bz2.sig; imported gcc-4.6.4 source tree from verified upstream tarball. downloading a git-generated archive based on the 'upstream' tag should provide you with a source tree that is binary identical to the one extracted from the above tarball. if you have obtained the source via the command 'git clone', however, do note that line-endings of files in your working directory might differ from line-endings of the respective files in the upstream repository.
Diffstat (limited to 'libjava/classpath/javax/accessibility/AccessibleRelation.java')
-rw-r--r--libjava/classpath/javax/accessibility/AccessibleRelation.java318
1 files changed, 318 insertions, 0 deletions
diff --git a/libjava/classpath/javax/accessibility/AccessibleRelation.java b/libjava/classpath/javax/accessibility/AccessibleRelation.java
new file mode 100644
index 000000000..9e1b0da37
--- /dev/null
+++ b/libjava/classpath/javax/accessibility/AccessibleRelation.java
@@ -0,0 +1,318 @@
+/* AccessibleRelation.java -- the relation between accessible objects
+ Copyright (C) 2002, 2005 Free Software Foundation
+
+This file is part of GNU Classpath.
+
+GNU Classpath is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
+
+GNU Classpath 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 for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Classpath; see the file COPYING. If not, write to the
+Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+02110-1301 USA.
+
+Linking this library statically or dynamically with other modules is
+making a combined work based on this library. Thus, the terms and
+conditions of the GNU General Public License cover the whole
+combination.
+
+As a special exception, the copyright holders of this library give you
+permission to link this library with independent modules to produce an
+executable, regardless of the license terms of these independent
+modules, and to copy and distribute the resulting executable under
+terms of your choice, provided that you also meet, for each linked
+independent module, the terms and conditions of the license of that
+module. An independent module is a module which is not derived from
+or based on this library. If you modify this library, you may extend
+this exception to your version of the library, but you are not
+obligated to do so. If you do not wish to do so, delete this
+exception statement from your version. */
+
+package javax.accessibility;
+
+import java.util.Locale;
+
+/**
+ * The relation between one accessible object and one or more other objects.
+ * For example, a button may control an action. An AccessibleRelationSet
+ * summarizes all relations of the object. This strongly typed "enumeration"
+ * supports localized strings. If the constants of this class are not
+ * adequate, new ones may be added in a similar matter.
+ *
+ * @author Eric Blake (ebb9@email.byu.edu)
+ * @since 1.2
+ * @status updated to 1.4
+ */
+public class AccessibleRelation extends AccessibleBundle
+{
+ /**
+ * Indicates the object labels other objects.
+ *
+ * @see #getTarget()
+ * @see #CONTROLLER_FOR
+ * @see #CONTROLLED_BY
+ * @see #LABELED_BY
+ * @see #MEMBER_OF
+ */
+ public static final String LABEL_FOR;
+
+ /**
+ * Indicates the object is labeled by other objects.
+ *
+ * @see #getTarget()
+ * @see #CONTROLLER_FOR
+ * @see #CONTROLLED_BY
+ * @see #LABEL_FOR
+ * @see #MEMBER_OF
+ */
+ public static final String LABELED_BY;
+
+ /**
+ * Indicates an object is a member of a group of target objects.
+ *
+ * @see #getTarget()
+ * @see #CONTROLLER_FOR
+ * @see #CONTROLLED_BY
+ * @see #LABEL_FOR
+ * @see #LABELED_BY
+ */
+ public static final String MEMBER_OF;
+
+ /**
+ * Indicates an object is a controller for other objects.
+ *
+ * @see #getTarget()
+ * @see #CONTROLLED_BY
+ * @see #LABEL_FOR
+ * @see #LABELED_BY
+ * @see #MEMBER_OF
+ */
+ public static final String CONTROLLER_FOR;
+
+ /**
+ * Indicates an object is controlled by other objects.
+ *
+ * @see #getTarget()
+ * @see #CONTROLLER_FOR
+ * @see #LABEL_FOR
+ * @see #LABELED_BY
+ * @see #MEMBER_OF
+ */
+ public static final String CONTROLLED_BY;
+
+ /** Indicates that the label target group has changed. */
+ public static final String LABEL_FOR_PROPERTY = "labelForProperty";
+
+ /** Indicates that the labelling objects have changed. */
+ public static final String LABELED_BY_PROPERTY = "labeledByProperty";
+
+ /** Indicates that group membership has changed. */
+ public static final String MEMBER_OF_PROPERTY = "memberOfProperty";
+
+ /** Indicates that the controller target group has changed. */
+ public static final String CONTROLLER_FOR_PROPERTY = "controllerForProperty";
+
+ /** Indicates that the controlling objects have changed. */
+ public static final String CONTROLLED_BY_PROPERTY = "controlledByProperty";
+
+ /**
+ * Indicates that an object is a child of another object.
+ * @since 1.5
+ */
+ public static final String CHILD_NODE_OF = "childNodeOf";
+
+ /**
+ * Indicates that the ancestry relationship has changed.
+ * @since 1.5
+ */
+ public static final String CHILD_NODE_OF_PROPERTY = "childNodeOfProperty";
+
+ /**
+ * Indicates that an object is embedded by another object.
+ * @since 1.5
+ */
+ public static final String EMBEDDED_BY = "embeddedBy";
+
+ /**
+ * Indicates that the {@link #EMBEDDED_BY} property changed.
+ * @since 1.5
+ */
+ public static final String EMBEDDED_BY_PROPERTY = "embeddedByProperty";
+
+ /**
+ * Indicates that an object embeds another object.
+ * @since 1.5
+ */
+ public static final String EMBEDS = "embeds";
+
+ /**
+ * Indicates that the {@link #EMBEDS} property changed.
+ * @since 1.5
+ */
+ public static final String EMBEDS_PROPERTY = "embedsProperty";
+
+ /**
+ * Indicates that one object directly follows another object,
+ * as in a paragraph flow.
+ * @since 1.5
+ */
+ public static final String FLOWS_FROM = "flowsFrom";
+
+ /**
+ * Indicates that the {@link #FLOWS_FROM} property changed.
+ * @since 1.5
+ */
+ public static final String FLOWS_FROM_PROPERTY = "flowsFromProperty";
+
+ /**
+ * Indicates that one object comes directly before another object,
+ * as in a paragraph flow.
+ * @since 1.5
+ */
+ public static final String FLOWS_TO = "flowsTo";
+
+ /**
+ * Indicates that the {@link #FLOWS_TO} property changed.
+ * @since 1.5
+ */
+ public static final String FLOWS_TO_PROPERTY = "flowsToProperty";
+
+ /**
+ * Indicates that one object is a parent window of another object.
+ * @since 1.5
+ */
+ public static final String PARENT_WINDOW_OF = "parentWindowOf";
+
+ /**
+ * Indicates that the {@link #PARENT_WINDOW_OF} property changed.
+ * @since 1.5
+ */
+ public static final String PARENT_WINDOW_OF_PROPERTY = "parentWindowOfProperty";
+
+ /**
+ * Indicates that one object is a subwindow of another object.
+ * @since 1.5
+ */
+ public static final String SUBWINDOW_OF = "subwindowOf";
+
+ /**
+ * Indicates that the {@link #SUBWINDOW_OF} property changed.
+ * @since 1.5
+ */
+ public static final String SUBWINDOW_OF_PROPERTY = "subwindowOfProperty";
+
+ /** An empty set of targets. */
+ private static final Object[] EMPTY_TARGETS = { };
+
+ static
+ {
+ // not constants in JDK
+ LABEL_FOR = "labelFor";
+ LABELED_BY = "labeledBy";
+ MEMBER_OF = "memberOf";
+ CONTROLLER_FOR = "controllerFor";
+ CONTROLLED_BY = "controlledBy";
+ }
+
+ /**
+ * The related objects.
+ *
+ * @see #getTarget()
+ * @see #setTarget(Object)
+ * @see #setTarget(Object[])
+ */
+ Object[] targets;
+
+ /**
+ * Create a new relation with a locale independent key, and no related
+ * objects.
+ *
+ * @param key the name of the role
+ * @see #toDisplayString(String, Locale)
+ */
+ public AccessibleRelation(String key)
+ {
+ this.key = key;
+ targets = EMPTY_TARGETS;
+ }
+
+ /**
+ * Create a new relation with a locale independent key, and a single related
+ * object.
+ *
+ * @param key the name of the role
+ * @param target the related object
+ * @see #toDisplayString(String, Locale)
+ */
+ public AccessibleRelation(String key, Object target)
+ {
+ this.key = key;
+ targets = new Object[] { target };
+ }
+
+ /**
+ * Create a new relation with a locale independent key, and the given
+ * related objects.
+ *
+ * @param key the name of the role
+ * @param targets the related objects
+ * @see #toDisplayString(String, Locale)
+ */
+ public AccessibleRelation(String key, Object[] targets)
+ {
+ this.key = key;
+ this.targets = targets == null ? EMPTY_TARGETS : targets;
+ }
+
+ /**
+ * Return the key for this relation.
+ *
+ * @return the key
+ * @see #CONTROLLER_FOR
+ * @see #CONTROLLED_BY
+ * @see #LABEL_FOR
+ * @see #LABELED_BY
+ * @see #MEMBER_OF
+ */
+ public String getKey()
+ {
+ return key;
+ }
+
+ /**
+ * Return the targets of this relation.
+ *
+ * @return the targets, may be empty, but never null
+ */
+ public Object[] getTarget()
+ {
+ return targets;
+ }
+
+ /**
+ * Set the target to a single object.
+ *
+ * @param target the new target
+ */
+ public void setTarget(Object target)
+ {
+ targets = new Object[] { target };
+ }
+
+ /**
+ * Set the target to an array of objects.
+ *
+ * @param targets the new targets
+ */
+ public void setTarget(Object[] targets)
+ {
+ this.targets = targets == null ? EMPTY_TARGETS : targets;
+ }
+} // class AccessibleRelation