java.lang.Object
javax.accessibility.AccessibleContext
java.awt.MenuComponent.AccessibleAWTMenuComponent
- All Implemented Interfaces:
- Serializable,- AccessibleComponent,- AccessibleSelection
- Direct Known Subclasses:
- MenuBar.AccessibleAWTMenuBar,- MenuItem.AccessibleAWTMenuItem
- Enclosing class:
- MenuComponent
protected abstract class MenuComponent.AccessibleAWTMenuComponent
extends AccessibleContext
implements Serializable, AccessibleComponent, AccessibleSelection
Inner class of 
MenuComponent used to provide
 default support for accessibility.  This class is not meant
 to be used directly by application developers, but is instead
 meant only to be subclassed by menu component developers.
 The class used to obtain the accessible role for this object.
- Since:
- 1.3
- See Also:
- 
Field SummaryFields declared in class javax.accessibility.AccessibleContextACCESSIBLE_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
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedAlthough the class is abstract, this should be called by all sub-classes.
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddAccessibleSelection(int i) Adds the specifiedAccessiblechild of the object to the object's selection.voidAdds the specified focus listener to receive focus events from this component.voidClears the selection in the object, so that no children in the object are selected.booleanChecks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be relative to the coordinate system of the object.Returns theAccessiblechild, if one exists, contained at the local coordinatePoint.getAccessibleChild(int i) Returns the nthAccessiblechild of the object.intReturns the number of accessible children in the object.Gets theAccessibleComponentassociated with this object if one exists.Gets the accessible description of this object.intGets the index of this object in its accessible parent.Gets the accessible name of this object.Gets theAccessibleparent of this object.Gets the role of this object.Gets theAccessibleSelectionassociated with this object which allows itsAccessiblechildren to be selected.getAccessibleSelection(int i) Returns anAccessiblerepresenting the specified selected child in the object.intReturns the number ofAccessiblechildren currently selected.Gets the state of this object.Gets the background color of this object.Gets the bounds of this object in the form of aRectangleobject.Gets theCursorof this object.getFont()Gets theFontof this object.Gets theFontMetricsof this object.Gets the foreground color of this object.Returns the locale of this object.Gets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space.Returns the location of the object on the screen.getSize()Returns the size of this object in the form of aDimensionobject.booleanisAccessibleChildSelected(int i) Determines if the current child of this object is selected.booleanDetermines if the object is enabled.booleanReturns whether this object can accept focus or not.booleanDetermines if the object is showing.booleanDetermines if the object is visible.voidremoveAccessibleSelection(int i) Removes the specified child of the object from the object's selection.voidRemoves the specified focus listener so it no longer receives focus events from this component.voidRequests focus for this object.voidCauses every child of the object to be selected if the object supports multiple selections.voidSets the background color of this object.voidSets the bounds of this object in the form of aRectangleobject.voidSets theCursorof this object.voidsetEnabled(boolean b) Sets the enabled state of the object.voidSets theFontof this object.voidSets the foreground color of this object.voidsetLocation(Point p) Sets the location of the object relative to the parent.voidResizes this object.voidsetVisible(boolean b) Sets the visible state of the object.Methods declared in class javax.accessibility.AccessibleContextaddPropertyChangeListener, firePropertyChange, getAccessibleAction, getAccessibleEditableText, getAccessibleIcon, getAccessibleRelationSet, getAccessibleTable, getAccessibleText, getAccessibleValue, removePropertyChangeListener, setAccessibleDescription, setAccessibleName, setAccessibleParent
- 
Constructor Details- 
AccessibleAWTMenuComponentprotected AccessibleAWTMenuComponent()Although the class is abstract, this should be called by all sub-classes.
 
- 
- 
Method Details- 
getAccessibleSelectionGets theAccessibleSelectionassociated with this object which allows itsAccessiblechildren to be selected.- Overrides:
- getAccessibleSelectionin class- AccessibleContext
- Returns:
- AccessibleSelectionif supported by object; else return- null
- See Also:
 
- 
getAccessibleNameGets the accessible name of this object. This should almost never returnjava.awt.MenuComponent.getName, as that generally isn't a localized name, and doesn't have meaning for the user. If the object is fundamentally a text object (e.g. a menu item), the accessible name should be the text of the object (e.g. "save"). If the object has a tooltip, the tooltip text may also be an appropriate String to return.- Overrides:
- getAccessibleNamein class- AccessibleContext
- Returns:
- the localized name of the object -- can be nullif this object does not have a name
- See Also:
 
- 
getAccessibleDescriptionGets the accessible description of this object. This should be a concise, localized description of what this object is - what is its meaning to the user. If the object has a tooltip, the tooltip text may be an appropriate string to return, assuming it contains a concise description of the object (instead of just the name of the object - e.g. a "Save" icon on a toolbar that had "save" as the tooltip text shouldn't return the tooltip text as the description, but something like "Saves the current text document" instead).- Overrides:
- getAccessibleDescriptionin class- AccessibleContext
- Returns:
- the localized description of the object -- can be
     nullif this object does not have a description
- See Also:
 
- 
getAccessibleRoleGets the role of this object.- Specified by:
- getAccessibleRolein class- AccessibleContext
- Returns:
- an instance of AccessibleRoledescribing the role of the object
- See Also:
 
- 
getAccessibleStateSetGets the state of this object.- Specified by:
- getAccessibleStateSetin class- AccessibleContext
- Returns:
- an instance of AccessibleStateSetcontaining the current state set of the object
- See Also:
 
- 
getAccessibleParentGets theAccessibleparent of this object. If the parent of this object implementsAccessible, this method should simply returngetParent.- Overrides:
- getAccessibleParentin class- AccessibleContext
- Returns:
- the Accessibleparent of this object -- can benullif this object does not have anAccessibleparent
 
- 
getAccessibleIndexInParentpublic int getAccessibleIndexInParent()Gets the index of this object in its accessible parent.- Specified by:
- getAccessibleIndexInParentin class- AccessibleContext
- Returns:
- the index of this object in its parent; -1 if this object does not have an accessible parent
- See Also:
 
- 
getAccessibleChildrenCountpublic int getAccessibleChildrenCount()Returns the number of accessible children in the object. If all of the children of this object implementAccessible, then this method should return the number of children of this object.- Specified by:
- getAccessibleChildrenCountin class- AccessibleContext
- Returns:
- the number of accessible children in the object
 
- 
getAccessibleChildReturns the nthAccessiblechild of the object.- Specified by:
- getAccessibleChildin class- AccessibleContext
- Parameters:
- i- zero-based index of child
- Returns:
- the nth Accessible child of the object
- See Also:
 
- 
getLocaleReturns the locale of this object.- Specified by:
- getLocalein class- AccessibleContext
- Returns:
- the locale of this object
 
- 
getAccessibleComponentGets theAccessibleComponentassociated with this object if one exists. Otherwise returnnull.- Overrides:
- getAccessibleComponentin class- AccessibleContext
- Returns:
- the component
- See Also:
 
- 
getBackgroundGets the background color of this object.- Specified by:
- getBackgroundin interface- AccessibleComponent
- Returns:
- the background color, if supported, of the object;
     otherwise, null
- See Also:
 
- 
setBackgroundSets the background color of this object. (For transparency, seeisOpaque.)- Specified by:
- setBackgroundin interface- AccessibleComponent
- Parameters:
- c- the new- Colorfor the background
- See Also:
 
- 
getForegroundGets the foreground color of this object.- Specified by:
- getForegroundin interface- AccessibleComponent
- Returns:
- the foreground color, if supported, of the object;
     otherwise, null
- See Also:
 
- 
setForegroundSets the foreground color of this object.- Specified by:
- setForegroundin interface- AccessibleComponent
- Parameters:
- c- the new- Colorfor the foreground
- See Also:
 
- 
getCursorGets theCursorof this object.- Specified by:
- getCursorin interface- AccessibleComponent
- Returns:
- the Cursor, if supported, of the object; otherwise,null
- See Also:
 
- 
setCursorSets theCursorof this object.The method may have no visual effect if the Java platform implementation and/or the native system do not support changing the mouse cursor shape. - Specified by:
- setCursorin interface- AccessibleComponent
- Parameters:
- cursor- the new- Cursorfor the object
- See Also:
 
- 
getFontGets theFontof this object.- Specified by:
- getFontin interface- AccessibleComponent
- Returns:
- the Font,if supported, for the object; otherwise,null
- See Also:
 
- 
setFontSets theFontof this object.- Specified by:
- setFontin interface- AccessibleComponent
- Parameters:
- f- the new- Fontfor the object
- See Also:
 
- 
getFontMetricsGets theFontMetricsof this object.- Specified by:
- getFontMetricsin interface- AccessibleComponent
- Parameters:
- f- the- Font
- Returns:
- the FontMetrics, if supported, the object;
              otherwise, null
- See Also:
 
- 
isEnabledpublic boolean isEnabled()Determines if the object is enabled.- Specified by:
- isEnabledin interface- AccessibleComponent
- Returns:
- true if object is enabled; otherwise, false
- See Also:
 
- 
setEnabledpublic void setEnabled(boolean b) Sets the enabled state of the object.- Specified by:
- setEnabledin interface- AccessibleComponent
- Parameters:
- b- if true, enables this object; otherwise, disables it
- See Also:
 
- 
isVisiblepublic boolean isVisible()Determines if the object is visible. Note: this means that the object intends to be visible; however, it may not in fact be showing on the screen because one of the objects that this object is contained by is not visible. To determine if an object is showing on the screen, useisShowing.- Specified by:
- isVisiblein interface- AccessibleComponent
- Returns:
- true if object is visible; otherwise, false
- See Also:
 
- 
setVisiblepublic void setVisible(boolean b) Sets the visible state of the object.- Specified by:
- setVisiblein interface- AccessibleComponent
- Parameters:
- b- if true, shows this object; otherwise, hides it
- See Also:
 
- 
isShowingpublic boolean isShowing()Determines if the object is showing. This is determined by checking the visibility of the object and ancestors of the object. Note: this will return true even if the object is obscured by another (for example, it happens to be underneath a menu that was pulled down).- Specified by:
- isShowingin interface- AccessibleComponent
- Returns:
- true if object is showing; otherwise, false
 
- 
containsChecks whether the specified point is within this object's bounds, where the point's x and y coordinates are defined to be relative to the coordinate system of the object.- Specified by:
- containsin interface- AccessibleComponent
- Parameters:
- p- the- Pointrelative to the coordinate system of the object
- Returns:
- true if object contains Point; otherwise false
- See Also:
 
- 
getLocationOnScreenReturns the location of the object on the screen.- Specified by:
- getLocationOnScreenin interface- AccessibleComponent
- Returns:
- location of object on screen -- can be nullif this object is not on the screen
- See Also:
 
- 
getLocationGets the location of the object relative to the parent in the form of a point specifying the object's top-left corner in the screen's coordinate space.- Specified by:
- getLocationin interface- AccessibleComponent
- Returns:
- an instance of Pointrepresenting the top-left corner of the object's bounds in the coordinate space of the screen;nullif this object or its parent are not on the screen
- See Also:
 
- 
setLocationSets the location of the object relative to the parent.- Specified by:
- setLocationin interface- AccessibleComponent
- Parameters:
- p- the new position for the top-left corner
- See Also:
 
- 
getBoundsGets the bounds of this object in the form of aRectangleobject. The bounds specify this object's width, height, and location relative to its parent.- Specified by:
- getBoundsin interface- AccessibleComponent
- Returns:
- a rectangle indicating this component's bounds;
     nullif this object is not on the screen
- See Also:
 
- 
setBoundsSets the bounds of this object in the form of aRectangleobject. The bounds specify this object's width, height, and location relative to its parent.- Specified by:
- setBoundsin interface- AccessibleComponent
- Parameters:
- r- a rectangle indicating this component's bounds
- See Also:
 
- 
getSizeReturns the size of this object in the form of aDimensionobject. The height field of theDimensionobject contains this object's height, and the width field of theDimensionobject contains this object's width.- Specified by:
- getSizein interface- AccessibleComponent
- Returns:
- a Dimensionobject that indicates the size of this component;nullif this object is not on the screen
- See Also:
 
- 
setSizeResizes this object.- Specified by:
- setSizein interface- AccessibleComponent
- Parameters:
- d- the- Dimensionspecifying the new size of the object
- See Also:
 
- 
getAccessibleAtReturns theAccessiblechild, if one exists, contained at the local coordinatePoint. If there is noAccessiblechild,nullis returned.- Specified by:
- getAccessibleAtin interface- AccessibleComponent
- Parameters:
- p- the point defining the top-left corner of the- Accessible, given in the coordinate space of the object's parent
- Returns:
- the Accessible, if it exists, at the specified location; elsenull
 
- 
isFocusTraversablepublic boolean isFocusTraversable()Returns whether this object can accept focus or not.- Specified by:
- isFocusTraversablein interface- AccessibleComponent
- Returns:
- true if object can accept focus; otherwise false
- See Also:
 
- 
requestFocuspublic void requestFocus()Requests focus for this object.- Specified by:
- requestFocusin interface- AccessibleComponent
- See Also:
 
- 
addFocusListenerAdds the specified focus listener to receive focus events from this component.- Specified by:
- addFocusListenerin interface- AccessibleComponent
- Parameters:
- l- the focus listener
- See Also:
 
- 
removeFocusListenerRemoves the specified focus listener so it no longer receives focus events from this component.- Specified by:
- removeFocusListenerin interface- AccessibleComponent
- Parameters:
- l- the focus listener
- See Also:
 
- 
getAccessibleSelectionCountpublic int getAccessibleSelectionCount()Returns the number ofAccessiblechildren currently selected. If no children are selected, the return value will be 0.- Specified by:
- getAccessibleSelectionCountin interface- AccessibleSelection
- Returns:
- the number of items currently selected
 
- 
getAccessibleSelectionReturns anAccessiblerepresenting the specified selected child in the object. If there isn't a selection, or there are fewer children selected than the integer passed in, the return value will benull.Note that the index represents the i-th selected child, which is different from the i-th child. - Specified by:
- getAccessibleSelectionin interface- AccessibleSelection
- Parameters:
- i- the zero-based index of selected children
- Returns:
- the i-th selected child
- See Also:
 
- 
isAccessibleChildSelectedpublic boolean isAccessibleChildSelected(int i) Determines if the current child of this object is selected.- Specified by:
- isAccessibleChildSelectedin interface- AccessibleSelection
- Parameters:
- i- the zero-based index of the child in this- Accessibleobject
- Returns:
- true if the current child of this object is selected; else false
- See Also:
 
- 
addAccessibleSelectionpublic void addAccessibleSelection(int i) Adds the specifiedAccessiblechild of the object to the object's selection. If the object supports multiple selections, the specified child is added to any existing selection, otherwise it replaces any existing selection in the object. If the specified child is already selected, this method has no effect.- Specified by:
- addAccessibleSelectionin interface- AccessibleSelection
- Parameters:
- i- the zero-based index of the child
- See Also:
 
- 
removeAccessibleSelectionpublic void removeAccessibleSelection(int i) Removes the specified child of the object from the object's selection. If the specified item isn't currently selected, this method has no effect.- Specified by:
- removeAccessibleSelectionin interface- AccessibleSelection
- Parameters:
- i- the zero-based index of the child
- See Also:
 
- 
clearAccessibleSelectionpublic void clearAccessibleSelection()Clears the selection in the object, so that no children in the object are selected.- Specified by:
- clearAccessibleSelectionin interface- AccessibleSelection
 
- 
selectAllAccessibleSelectionpublic void selectAllAccessibleSelection()Causes every child of the object to be selected if the object supports multiple selections.- Specified by:
- selectAllAccessibleSelectionin interface- AccessibleSelection
 
 
-