AccessibleContext.java revision 4632
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami/*
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Copyright (c) 1997, 2006, Oracle and/or its affiliates. All rights reserved.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * This code is free software; you can redistribute it and/or modify it
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * under the terms of the GNU General Public License version 2 only, as
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * published by the Free Software Foundation. Oracle designates this
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * particular file as subject to the "Classpath" exception as provided
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * by Oracle in the LICENSE file that accompanied this code.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * This code is distributed in the hope that it will be useful, but WITHOUT
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * version 2 for more details (a copy is included in the LICENSE file that
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * accompanied this code).
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * You should have received a copy of the GNU General Public License version
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * 2 along with this work; if not, write to the Free Software Foundation,
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * or visit www.oracle.com if you need additional information or have any
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * questions.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahramipackage javax.accessibility;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahramiimport java.util.Locale;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahramiimport java.beans.PropertyChangeListener;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahramiimport java.beans.PropertyChangeSupport;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahramiimport java.beans.PropertyChangeEvent;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahramiimport java.awt.IllegalComponentStateException;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami/**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * AccessibleContext represents the minimum information all accessible objects
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * return. This information includes the accessible name, description, role,
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * and state of the object, as well as information about its parent and
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * children. AccessibleContext also contains methods for
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * obtaining more specific accessibility information about a component.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * If the component supports them, these methods will return an object that
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * implements one or more of the following interfaces:
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * <P><ul>
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * <li>{@link AccessibleAction} - the object can perform one or more actions.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * This interface provides the standard mechanism for an assistive
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * technology to determine what those actions are and tell the object
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * to perform them. Any object that can be manipulated should
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * support this interface.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * <li>{@link AccessibleComponent} - the object has a graphical representation.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * This interface provides the standard mechanism for an assistive
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * technology to determine and set the graphical representation of the
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * object. Any object that is rendered on the screen should support
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * this interface.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * <li>{@link AccessibleSelection} - the object allows its children to be
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * selected. This interface provides the standard mechanism for an
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * assistive technology to determine the currently selected children of the object
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * as well as modify its selection set. Any object that has children
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * that can be selected should support this interface.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * <li>{@link AccessibleText} - the object presents editable textual information
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * on the display. This interface provides the standard mechanism for
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * an assistive technology to access that text via its content, attributes,
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * and spatial location. Any object that contains editable text should
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * support this interface.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * <li>{@link AccessibleValue} - the object supports a numerical value. This
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * interface provides the standard mechanism for an assistive technology
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * to determine and set the current value of the object, as well as obtain its
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * minimum and maximum values. Any object that supports a numerical value
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * should support this interface.</ul>
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @beaninfo
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * attribute: isContainer false
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * description: Minimal information that all accessible objects return
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @author Peter Korn
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @author Hans Muller
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @author Willie Walker
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @author Lynn Monsanto
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahramipublic abstract class AccessibleContext {
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to determine when the accessibleName property has
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * changed. The old value in the PropertyChangeEvent will be the old
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * accessibleName and the new value will be the new accessibleName.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleName
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_NAME_PROPERTY = "AccessibleName";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to determine when the accessibleDescription property has
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * changed. The old value in the PropertyChangeEvent will be the
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * old accessibleDescription and the new value will be the new
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * accessibleDescription.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleDescription
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_DESCRIPTION_PROPERTY = "AccessibleDescription";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to determine when the accessibleStateSet property has
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * changed. The old value will be the old AccessibleState and the new
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * value will be the new AccessibleState in the accessibleStateSet.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * For example, if a component that supports the vertical and horizontal
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * states changes its orientation from vertical to horizontal, the old
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * value will be AccessibleState.VERTICAL and the new value will be
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * AccessibleState.HORIZONTAL. Please note that either value can also
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * be null. For example, when a component changes from being enabled
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * to disabled, the old value will be AccessibleState.ENABLED
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * and the new value will be null.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleStateSet
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleState
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleStateSet
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_STATE_PROPERTY = "AccessibleState";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to determine when the accessibleValue property has
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * changed. The old value in the PropertyChangeEvent will be a Number
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * representing the old value and the new value will be a Number
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * representing the new value
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see #getAccessibleValue
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see #addPropertyChangeListener
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami */
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami public static final String ACCESSIBLE_VALUE_PROPERTY = "AccessibleValue";
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami /**
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * Constant used to determine when the accessibleSelection has changed.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * The old and new values in the PropertyChangeEvent are currently
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * reserved for future use.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleSelection
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_SELECTION_PROPERTY = "AccessibleSelection";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to determine when the accessibleText caret has changed.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * The old value in the PropertyChangeEvent will be an
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * integer representing the old caret position, and the new value will
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * be an integer representing the new/current caret position.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_CARET_PROPERTY = "AccessibleCaret";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to determine when the visual appearance of the object
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * has changed. The old and new values in the PropertyChangeEvent are
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * currently reserved for future use.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_VISIBLE_DATA_PROPERTY = "AccessibleVisibleData";
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami /**
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * Constant used to determine when Accessible children are added/removed
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * from the object. If an Accessible child is being added, the old
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * value will be null and the new value will be the Accessible child. If an
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * Accessible child is being removed, the old value will be the Accessible
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * child, and the new value will be null.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami *
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see #addPropertyChangeListener
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami */
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami public static final String ACCESSIBLE_CHILD_PROPERTY = "AccessibleChild";
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to determine when the active descendant of a component
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * has changed. The active descendant is used for objects such as
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * list, tree, and table, which may have transient children. When the
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * active descendant has changed, the old value of the property change
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * event will be the Accessible representing the previous active child, and
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * the new value will be the Accessible representing the current active
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * child.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY = "AccessibleActiveDescendant";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to indicate that the table caption has changed
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * The old value in the PropertyChangeEvent will be an Accessible
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * representing the previous table caption and the new value will
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * be an Accessible representing the new table caption.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see Accessible
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleTable
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami */
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami public static final String ACCESSIBLE_TABLE_CAPTION_CHANGED =
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami "accessibleTableCaptionChanged";
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami /**
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * Constant used to indicate that the table summary has changed
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * The old value in the PropertyChangeEvent will be an Accessible
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * representing the previous table summary and the new value will
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * be an Accessible representing the new table summary.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see Accessible
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see AccessibleTable
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_TABLE_SUMMARY_CHANGED =
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami "accessibleTableSummaryChanged";
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami /**
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * Constant used to indicate that table data has changed.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * The old value in the PropertyChangeEvent will be null and the
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * new value will be an AccessibleTableModelChange representing
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * the table change.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleTable
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleTableModelChange
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami */
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami public static final String ACCESSIBLE_TABLE_MODEL_CHANGED =
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami "accessibleTableModelChanged";
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami /**
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * Constant used to indicate that the row header has changed
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * The old value in the PropertyChangeEvent will be null and the
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * new value will be an AccessibleTableModelChange representing
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * the header change.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleTable
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see AccessibleTableModelChange
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami */
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami public static final String ACCESSIBLE_TABLE_ROW_HEADER_CHANGED =
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami "accessibleTableRowHeaderChanged";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to indicate that the row description has changed
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * The old value in the PropertyChangeEvent will be null and the
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * new value will be an Integer representing the row index.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleTable
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED =
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami "accessibleTableRowDescriptionChanged";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * Constant used to indicate that the column header has changed
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * The old value in the PropertyChangeEvent will be null and the
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * new value will be an AccessibleTableModelChange representing
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * the header change.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleTable
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleTableModelChange
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami public static final String ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED =
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami "accessibleTableColumnHeaderChanged";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to indicate that the column description has changed
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * The old value in the PropertyChangeEvent will be null and the
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * new value will be an Integer representing the column index.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleTable
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED =
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami "accessibleTableColumnDescriptionChanged";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * Constant used to indicate that the supported set of actions
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * has changed. The old value in the PropertyChangeEvent will
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * be an Integer representing the old number of actions supported
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * and the new value will be an Integer representing the new
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * number of actions supported.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleAction
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_ACTION_PROPERTY =
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami "accessibleActionProperty";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Constant used to indicate that a hypertext element has received focus.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * The old value in the PropertyChangeEvent will be an Integer
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * representing the start index in the document of the previous element
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * that had focus and the new value will be an Integer representing
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * the start index in the document of the current element that has
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * focus. A value of -1 indicates that an element does not or did
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * not have focus.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see AccessibleHyperlink
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_HYPERTEXT_OFFSET =
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami "AccessibleHypertextOffset";
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami /**
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * PropertyChangeEvent which indicates that text has changed.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * <br>
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * For text insertion, the oldValue is null and the newValue
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * is an AccessibleTextSequence specifying the text that was
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * inserted.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * <br>
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * For text deletion, the oldValue is an AccessibleTextSequence
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * specifying the text that was deleted and the newValue is null.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * <br>
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * For text replacement, the oldValue is an AccessibleTextSequence
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * specifying the old text and the newValue is an AccessibleTextSequence
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * specifying the new text.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleText
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleTextSequence
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_TEXT_PROPERTY
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami = "AccessibleText";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * PropertyChangeEvent which indicates that a significant change
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * has occurred to the children of a component like a tree or text.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * This change notifies the event listener that it needs to
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * reacquire the state of the subcomponents. The oldValue is
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * null and the newValue is the component whose children have
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * become invalid.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleText
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleTextSequence
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @since 1.5
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_INVALIDATE_CHILDREN =
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami "accessibleInvalidateChildren";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * PropertyChangeEvent which indicates that text attributes have changed.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * <br>
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * For attribute insertion, the oldValue is null and the newValue
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * is an AccessibleAttributeSequence specifying the attributes that were
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * inserted.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * <br>
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * For attribute deletion, the oldValue is an AccessibleAttributeSequence
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * specifying the attributes that were deleted and the newValue is null.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * <br>
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * For attribute replacement, the oldValue is an AccessibleAttributeSequence
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * specifying the old attributes and the newValue is an
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * AccessibleAttributeSequence specifying the new attributes.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleText
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see AccessibleAttributeSequence
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @since 1.5
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED =
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami "accessibleTextAttributesChanged";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * PropertyChangeEvent which indicates that a change has occurred
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * in a component's bounds.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * The oldValue is the old component bounds and the newValue is
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * the new component bounds.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @since 1.5
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public static final String ACCESSIBLE_COMPONENT_BOUNDS_CHANGED =
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami "accessibleComponentBoundsChanged";
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * The accessible parent of this object.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleParent
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #setAccessibleParent
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami protected Accessible accessibleParent = null;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * A localized String containing the name of the object.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleName
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #setAccessibleName
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami protected String accessibleName = null;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * A localized String containing the description of the object.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleDescription
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #setAccessibleDescription
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami protected String accessibleDescription = null;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Used to handle the listener list for property change events.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #removePropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #firePropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami private PropertyChangeSupport accessibleChangeSupport = null;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Used to represent the context's relation set
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #getAccessibleRelationSet
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami private AccessibleRelationSet relationSet
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami = new AccessibleRelationSet();
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami private Object nativeAXResource;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Gets the accessibleName property of this object. The accessibleName
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * property of an object is a localized String that designates the purpose
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * of the object. For example, the accessibleName property of a label
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * or button might be the text of the label or button itself. In the
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * case of an object that doesn't display its name, the accessibleName
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * should still be set. For example, in the case of a text field used
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * to enter the name of a city, the accessibleName for the en_US locale
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * could be 'city.'
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @return the localized name of the object; null if this
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * object does not have a name
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #setAccessibleName
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public String getAccessibleName() {
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami return accessibleName;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami }
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami /**
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * Sets the localized accessible name of this object. Changing the
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * name will cause a PropertyChangeEvent to be fired for the
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * ACCESSIBLE_NAME_PROPERTY property.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @param s the new localized name of the object.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see #getAccessibleName
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @beaninfo
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * preferred: true
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * description: Sets the accessible name for the component.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public void setAccessibleName(String s) {
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami String oldName = accessibleName;
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami accessibleName = s;
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami firePropertyChange(ACCESSIBLE_NAME_PROPERTY,oldName,accessibleName);
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami }
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami /**
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * Gets the accessibleDescription property of this object. The
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * accessibleDescription property of this object is a short localized
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * phrase describing the purpose of the object. For example, in the
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * case of a 'Cancel' button, the accessibleDescription could be
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * 'Ignore changes and close dialog box.'
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami *
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @return the localized description of the object; null if
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * this object does not have a description
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami *
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see #setAccessibleDescription
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami */
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami public String getAccessibleDescription() {
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami return accessibleDescription;
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami }
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Sets the accessible description of this object. Changing the
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * name will cause a PropertyChangeEvent to be fired for the
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * ACCESSIBLE_DESCRIPTION_PROPERTY property.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @param s the new localized description of the object
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #setAccessibleName
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @see #addPropertyChangeListener
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @beaninfo
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * preferred: true
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * description: Sets the accessible description for the component.
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public void setAccessibleDescription(String s) {
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami String oldDescription = accessibleDescription;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami accessibleDescription = s;
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami firePropertyChange(ACCESSIBLE_DESCRIPTION_PROPERTY,
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami oldDescription,accessibleDescription);
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami }
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Gets the role of this object. The role of the object is the generic
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * purpose or use of the class of this object. For example, the role
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * of a push button is AccessibleRole.PUSH_BUTTON. The roles in
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * AccessibleRole are provided so component developers can pick from
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * a set of predefined roles. This enables assistive technologies to
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * provide a consistent interface to various tweaked subclasses of
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * components (e.g., use AccessibleRole.PUSH_BUTTON for all components
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * that act like a push button) as well as distinguish between sublasses
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * that behave differently (e.g., AccessibleRole.CHECK_BOX for check boxes
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * and AccessibleRole.RADIO_BUTTON for radio buttons).
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * <p>Note that the AccessibleRole class is also extensible, so
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * custom component developers can define their own AccessibleRole's
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * if the set of predefined roles is inadequate.
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami *
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * @return an instance of AccessibleRole describing the role of the object
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami * @see AccessibleRole
5253169e90b276216b53d82f9ba4c56334db5740Ali Bahrami */
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami public abstract AccessibleRole getAccessibleRole();
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami /**
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * Gets the state set of this object. The AccessibleStateSet of an object
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * is composed of a set of unique AccessibleStates. A change in the
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * AccessibleStateSet of an object will cause a PropertyChangeEvent to
75ce41a57ff334bd8fe2cb9ed51eea835892f944Ali Bahrami * be fired for the ACCESSIBLE_STATE_PROPERTY property.
*
* @return an instance of AccessibleStateSet containing the
* current state set of the object
* @see AccessibleStateSet
* @see AccessibleState
* @see #addPropertyChangeListener
*/
public abstract AccessibleStateSet getAccessibleStateSet();
/**
* Gets the Accessible parent of this object.
*
* @return the Accessible parent of this object; null if this
* object does not have an Accessible parent
*/
public Accessible getAccessibleParent() {
return accessibleParent;
}
/**
* Sets the Accessible parent of this object. This is meant to be used
* only in the situations where the actual component's parent should
* not be treated as the component's accessible parent and is a method
* that should only be called by the parent of the accessible child.
*
* @param a - Accessible to be set as the parent
*/
public void setAccessibleParent(Accessible a) {
accessibleParent = a;
}
/**
* Gets the 0-based index of this object in its accessible parent.
*
* @return the 0-based index of this object in its parent; -1 if this
* object does not have an accessible parent.
*
* @see #getAccessibleParent
* @see #getAccessibleChildrenCount
* @see #getAccessibleChild
*/
public abstract int getAccessibleIndexInParent();
/**
* Returns the number of accessible children of the object.
*
* @return the number of accessible children of the object.
*/
public abstract int getAccessibleChildrenCount();
/**
* Returns the specified Accessible child of the object. The Accessible
* children of an Accessible object are zero-based, so the first child
* of an Accessible child is at index 0, the second child is at index 1,
* and so on.
*
* @param i zero-based index of child
* @return the Accessible child of the object
* @see #getAccessibleChildrenCount
*/
public abstract Accessible getAccessibleChild(int i);
/**
* Gets the locale of the component. If the component does not have a
* locale, then the locale of its parent is returned.
*
* @return this component's locale. If this component does not have
* a locale, the locale of its parent is returned.
*
* @exception IllegalComponentStateException
* If the Component does not have its own locale and has not yet been
* added to a containment hierarchy such that the locale can be
* determined from the containing parent.
*/
public abstract Locale getLocale() throws IllegalComponentStateException;
/**
* Adds a PropertyChangeListener to the listener list.
* The listener is registered for all Accessible properties and will
* be called when those properties change.
*
* @see #ACCESSIBLE_NAME_PROPERTY
* @see #ACCESSIBLE_DESCRIPTION_PROPERTY
* @see #ACCESSIBLE_STATE_PROPERTY
* @see #ACCESSIBLE_VALUE_PROPERTY
* @see #ACCESSIBLE_SELECTION_PROPERTY
* @see #ACCESSIBLE_TEXT_PROPERTY
* @see #ACCESSIBLE_VISIBLE_DATA_PROPERTY
*
* @param listener The PropertyChangeListener to be added
*/
public void addPropertyChangeListener(PropertyChangeListener listener) {
if (accessibleChangeSupport == null) {
accessibleChangeSupport = new PropertyChangeSupport(this);
}
accessibleChangeSupport.addPropertyChangeListener(listener);
}
/**
* Removes a PropertyChangeListener from the listener list.
* This removes a PropertyChangeListener that was registered
* for all properties.
*
* @param listener The PropertyChangeListener to be removed
*/
public void removePropertyChangeListener(PropertyChangeListener listener) {
if (accessibleChangeSupport != null) {
accessibleChangeSupport.removePropertyChangeListener(listener);
}
}
/**
* Gets the AccessibleAction associated with this object that supports
* one or more actions.
*
* @return AccessibleAction if supported by object; else return null
* @see AccessibleAction
*/
public AccessibleAction getAccessibleAction() {
return null;
}
/**
* Gets the AccessibleComponent associated with this object that has a
* graphical representation.
*
* @return AccessibleComponent if supported by object; else return null
* @see AccessibleComponent
*/
public AccessibleComponent getAccessibleComponent() {
return null;
}
/**
* Gets the AccessibleSelection associated with this object which allows its
* Accessible children to be selected.
*
* @return AccessibleSelection if supported by object; else return null
* @see AccessibleSelection
*/
public AccessibleSelection getAccessibleSelection() {
return null;
}
/**
* Gets the AccessibleText associated with this object presenting
* text on the display.
*
* @return AccessibleText if supported by object; else return null
* @see AccessibleText
*/
public AccessibleText getAccessibleText() {
return null;
}
/**
* Gets the AccessibleEditableText associated with this object
* presenting editable text on the display.
*
* @return AccessibleEditableText if supported by object; else return null
* @see AccessibleEditableText
* @since 1.4
*/
public AccessibleEditableText getAccessibleEditableText() {
return null;
}
/**
* Gets the AccessibleValue associated with this object that supports a
* Numerical value.
*
* @return AccessibleValue if supported by object; else return null
* @see AccessibleValue
*/
public AccessibleValue getAccessibleValue() {
return null;
}
/**
* Gets the AccessibleIcons associated with an object that has
* one or more associated icons
*
* @return an array of AccessibleIcon if supported by object;
* otherwise return null
* @see AccessibleIcon
* @since 1.3
*/
public AccessibleIcon [] getAccessibleIcon() {
return null;
}
/**
* Gets the AccessibleRelationSet associated with an object
*
* @return an AccessibleRelationSet if supported by object;
* otherwise return null
* @see AccessibleRelationSet
* @since 1.3
*/
public AccessibleRelationSet getAccessibleRelationSet() {
return relationSet;
}
/**
* Gets the AccessibleTable associated with an object
*
* @return an AccessibleTable if supported by object;
* otherwise return null
* @see AccessibleTable
* @since 1.3
*/
public AccessibleTable getAccessibleTable() {
return null;
}
/**
* Support for reporting bound property changes. If oldValue and
* newValue are not equal and the PropertyChangeEvent listener list
* is not empty, then fire a PropertyChange event to each listener.
* In general, this is for use by the Accessible objects themselves
* and should not be called by an application program.
* @param propertyName The programmatic name of the property that
* was changed.
* @param oldValue The old value of the property.
* @param newValue The new value of the property.
* @see java.beans.PropertyChangeSupport
* @see #addPropertyChangeListener
* @see #removePropertyChangeListener
* @see #ACCESSIBLE_NAME_PROPERTY
* @see #ACCESSIBLE_DESCRIPTION_PROPERTY
* @see #ACCESSIBLE_STATE_PROPERTY
* @see #ACCESSIBLE_VALUE_PROPERTY
* @see #ACCESSIBLE_SELECTION_PROPERTY
* @see #ACCESSIBLE_TEXT_PROPERTY
* @see #ACCESSIBLE_VISIBLE_DATA_PROPERTY
*/
public void firePropertyChange(String propertyName,
Object oldValue,
Object newValue) {
if (accessibleChangeSupport != null) {
if (newValue instanceof PropertyChangeEvent) {
PropertyChangeEvent pce = (PropertyChangeEvent)newValue;
accessibleChangeSupport.firePropertyChange(pce);
} else {
accessibleChangeSupport.firePropertyChange(propertyName,
oldValue,
newValue);
}
}
}
}