JMenuBar.AccessibleJMenuBar (Java 2 Platform SE 5.0) (original) (raw)

javax.swing

Class JMenuBar.AccessibleJMenuBar

java.lang.Object extended by javax.accessibility.AccessibleContext java.awt.Component.AccessibleAWTComponent java.awt.Container.AccessibleAWTContainer javax.swing.JComponent.AccessibleJComponent javax.swing.JMenuBar.AccessibleJMenuBar

All Implemented Interfaces:

Serializable, AccessibleComponent, AccessibleExtendedComponent, AccessibleSelection

Enclosing class:

JMenuBar

protected class JMenuBar.AccessibleJMenuBar

extends JComponent.AccessibleJComponent

implements AccessibleSelection

This class implements accessibility support for the JMenuBar class. It provides an implementation of the Java Accessibility API appropriate to menu bar user-interface elements.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent.AccessibleJComponent
JComponent.AccessibleJComponent.AccessibleContainerHandler, JComponent.AccessibleJComponent.AccessibleFocusHandler

Nested classes/interfaces inherited from class java.awt.Component.AccessibleAWTComponent
Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler

Field Summary

Fields inherited from class javax.swing.JComponent.AccessibleJComponent
accessibleContainerHandler, accessibleFocusHandler

Fields inherited from class java.awt.Component.AccessibleAWTComponent
accessibleAWTComponentHandler, accessibleAWTFocusHandler

Fields inherited from class javax.accessibility.AccessibleContext
ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_COMPONENT_BOUNDS_CHANGED, ACCESSIBLE_DESCRIPTION_PROPERTY, ACCESSIBLE_HYPERTEXT_OFFSET, ACCESSIBLE_INVALIDATE_CHILDREN, ACCESSIBLE_NAME_PROPERTY, ACCESSIBLE_SELECTION_PROPERTY, ACCESSIBLE_STATE_PROPERTY, ACCESSIBLE_TABLE_CAPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED, ACCESSIBLE_TABLE_MODEL_CHANGED, ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_ROW_HEADER_CHANGED, ACCESSIBLE_TABLE_SUMMARY_CHANGED, ACCESSIBLE_TEXT_ATTRIBUTES_CHANGED, ACCESSIBLE_TEXT_PROPERTY, ACCESSIBLE_VALUE_PROPERTY, ACCESSIBLE_VISIBLE_DATA_PROPERTY, accessibleDescription, accessibleName, accessibleParent

Fields inherited from class javax.accessibility.AccessibleContext

Constructor Summary
protected	JMenuBar.AccessibleJMenuBar()

Method Summary
void	addAccessibleSelection(int i) Selects the nth menu in the menu bar, forcing it to pop up.
void	clearAccessibleSelection() Clears the selection in the object, so that nothing in the object is selected.
AccessibleRole	getAccessibleRole() Get the role of this object.
AccessibleSelection	getAccessibleSelection() Get the AccessibleSelection associated with this object.
Accessible	getAccessibleSelection(int i) Returns the currently selected menu if one is selected, otherwise null.
int	getAccessibleSelectionCount() Returns 1 if a menu is currently selected in this menu bar.
AccessibleStateSet	getAccessibleStateSet() Get the accessible state set of this object.
boolean	isAccessibleChildSelected(int i) Returns true if the current child of this object is selected.
void	removeAccessibleSelection(int i) Removes the nth selected item in the object from the object's selection.
void	selectAllAccessibleSelection() Normally causes every selected item in the object to be selected if the object supports multiple selections.

Methods inherited from class javax.swing.JComponent.AccessibleJComponent
addPropertyChangeListener, getAccessibleChild, getAccessibleChildrenCount, getAccessibleDescription, getAccessibleKeyBinding, getAccessibleName, getBorderTitle, getTitledBorderText, getToolTipText, removePropertyChangeListener

Methods inherited from class java.awt.Container.AccessibleAWTContainer
getAccessibleAt

Methods inherited from class java.awt.Component.AccessibleAWTComponent
addFocusListener, contains, getAccessibleComponent, getAccessibleIndexInParent, getAccessibleParent, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible

Methods inherited from class java.awt.Component.AccessibleAWTComponent

addFocusListener, contains, getAccessibleComponent, getAccessibleIndexInParent, getAccessibleParent, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible

Methods inherited from class javax.accessibility.AccessibleContext
[firePropertyChange](../../javax/accessibility/AccessibleContext.html#firePropertyChange%28java.lang.String, java.lang.Object, java.lang.Object%29), getAccessibleAction, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleTable, getAccessibleText, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29)

Methods inherited from interface javax.accessibility.AccessibleComponent
addFocusListener, contains, getAccessibleAt, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible

Constructor Detail

JMenuBar.AccessibleJMenuBar

protected JMenuBar.AccessibleJMenuBar()

Method Detail

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()

Get the accessible state set of this object.

Overrides:

[getAccessibleStateSet](../../javax/swing/JComponent.AccessibleJComponent.html#getAccessibleStateSet%28%29) in class [JComponent.AccessibleJComponent](../../javax/swing/JComponent.AccessibleJComponent.html "class in javax.swing")

Returns:

an instance of AccessibleState containing the current state of the object

See Also:

AccessibleState

getAccessibleRole

public AccessibleRole getAccessibleRole()

Get the role of this object.

Overrides:

[getAccessibleRole](../../javax/swing/JComponent.AccessibleJComponent.html#getAccessibleRole%28%29) in class [JComponent.AccessibleJComponent](../../javax/swing/JComponent.AccessibleJComponent.html "class in javax.swing")

Returns:

an instance of AccessibleRole describing the role of the object

See Also:

AccessibleRole

getAccessibleSelection

public AccessibleSelection getAccessibleSelection()

Get the AccessibleSelection associated with this object. In the implementation of the Java Accessibility API for this class, return this object, which is responsible for implementing the AccessibleSelection interface on behalf of itself.

Overrides:

[getAccessibleSelection](../../javax/accessibility/AccessibleContext.html#getAccessibleSelection%28%29) in class [AccessibleContext](../../javax/accessibility/AccessibleContext.html "class in javax.accessibility")

Returns:

this object

See Also:

AccessibleSelection

getAccessibleSelectionCount

public int getAccessibleSelectionCount()

Returns 1 if a menu is currently selected in this menu bar.

Specified by:

[getAccessibleSelectionCount](../../javax/accessibility/AccessibleSelection.html#getAccessibleSelectionCount%28%29) in interface [AccessibleSelection](../../javax/accessibility/AccessibleSelection.html "interface in javax.accessibility")

Returns:

1 if a menu is currently selected, else 0

getAccessibleSelection

public Accessible getAccessibleSelection(int i)

Returns the currently selected menu if one is selected, otherwise null.

Specified by:

[getAccessibleSelection](../../javax/accessibility/AccessibleSelection.html#getAccessibleSelection%28int%29) in interface [AccessibleSelection](../../javax/accessibility/AccessibleSelection.html "interface in javax.accessibility")

Parameters:

i - the zero-based index of selected children

Returns:

the i-th selected child

isAccessibleChildSelected

public boolean isAccessibleChildSelected(int i)

Returns true if the current child of this object is selected.

Specified by:

[isAccessibleChildSelected](../../javax/accessibility/AccessibleSelection.html#isAccessibleChildSelected%28int%29) in interface [AccessibleSelection](../../javax/accessibility/AccessibleSelection.html "interface in javax.accessibility")

Parameters:

i - the zero-based index of the child in this Accessible object.

Returns:

true if the current child of this object is selected; else false.

addAccessibleSelection

public void addAccessibleSelection(int i)

Selects the nth menu in the menu bar, forcing it to pop up. If another menu is popped up, this will force it to close. If the nth menu is already selected, this method has no effect.

Specified by:

[addAccessibleSelection](../../javax/accessibility/AccessibleSelection.html#addAccessibleSelection%28int%29) in interface [AccessibleSelection](../../javax/accessibility/AccessibleSelection.html "interface in javax.accessibility")

Parameters:

i - the zero-based index of selectable items

See Also:

getAccessibleStateSet()

removeAccessibleSelection

public void removeAccessibleSelection(int i)

Removes the nth selected item in the object from the object's selection. If the nth item isn't currently selected, this method has no effect. Otherwise, it closes the popup menu.

Specified by:

[removeAccessibleSelection](../../javax/accessibility/AccessibleSelection.html#removeAccessibleSelection%28int%29) in interface [AccessibleSelection](../../javax/accessibility/AccessibleSelection.html "interface in javax.accessibility")

Parameters:

i - the zero-based index of selectable items

clearAccessibleSelection

public void clearAccessibleSelection()

Clears the selection in the object, so that nothing in the object is selected. This will close any open menu.

Specified by:

[clearAccessibleSelection](../../javax/accessibility/AccessibleSelection.html#clearAccessibleSelection%28%29) in interface [AccessibleSelection](../../javax/accessibility/AccessibleSelection.html "interface in javax.accessibility")

selectAllAccessibleSelection

public void selectAllAccessibleSelection()

Normally causes every selected item in the object to be selected if the object supports multiple selections. This method makes no sense in a menu bar, and so does nothing.

Specified by:

[selectAllAccessibleSelection](../../javax/accessibility/AccessibleSelection.html#selectAllAccessibleSelection%28%29) in interface [AccessibleSelection](../../javax/accessibility/AccessibleSelection.html "interface in javax.accessibility")

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.