MenuComponent.AccessibleAWTMenuComponent (Java 2 Platform SE 5.0) (original) (raw)

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.

See Also:

Serialized Form

MenuComponent.AccessibleAWTMenuComponent

protected MenuComponent.AccessibleAWTMenuComponent()

Although the class is abstract, this should be called by all sub-classes.

getAccessibleSelection

public AccessibleSelection getAccessibleSelection()

Gets the AccessibleSelection associated with this object which allows its Accessible children to be selected.

Overrides:

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

Returns:

AccessibleSelection if supported by object; else return null

See Also:

AccessibleSelection

getAccessibleName

public String getAccessibleName()

Gets the accessible name of this object. This should almost never return java.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:

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

Returns:

the localized name of the object -- can be null if this object does not have a name

See Also:

AccessibleContext.setAccessibleName(java.lang.String)

getAccessibleDescription

public String getAccessibleDescription()

Gets 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:

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

Returns:

the localized description of the object -- can benull if this object does not have a description

See Also:

AccessibleContext.setAccessibleDescription(java.lang.String)

getAccessibleRole

public AccessibleRole getAccessibleRole()

Gets the role of this object.

Specified by:

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

Returns:

an instance of AccessibleRole describing the role of the object

See Also:

AccessibleRole

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()

Gets the state of this object.

Specified by:

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

Returns:

an instance of AccessibleStateSet containing the current state set of the object

See Also:

AccessibleState

getAccessibleParent

public Accessible getAccessibleParent()

Gets the Accessible parent of this object. If the parent of this object implements Accessible, this method should simply return getParent.

Overrides:

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

Returns:

the Accessible parent of this object -- can be null if this object does not have an Accessible parent

getAccessibleIndexInParent

public int getAccessibleIndexInParent()

Gets the index of this object in its accessible parent.

Specified by:

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

Returns:

the index of this object in its parent; -1 if this object does not have an accessible parent

See Also:

getAccessibleParent()

getAccessibleChildrenCount

public int getAccessibleChildrenCount()

Returns the number of accessible children in the object. If all of the children of this object implement Accessible, then this method should return the number of children of this object.

Specified by:

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

Returns:

the number of accessible children in the object

getAccessibleChild

public Accessible getAccessibleChild(int i)

Returns the nth Accessible child of the object.

Specified by:

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

Parameters:

i - zero-based index of child

Returns:

the nth Accessible child of the object

See Also:

AccessibleContext.getAccessibleChildrenCount()

getLocale

public Locale getLocale()

Returns the locale of this object.

Specified by:

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

Returns:

the locale of this object

getAccessibleComponent

public AccessibleComponent getAccessibleComponent()

Gets the AccessibleComponent associated with this object if one exists. Otherwise return null.

Overrides:

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

Returns:

the component

See Also:

AccessibleComponent

getBackground

public Color getBackground()

Gets the background color of this object.

Specified by:

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

Returns:

the background color, if supported, of the object; otherwise, null

See Also:

AccessibleComponent.setBackground(java.awt.Color)

setBackground

public void setBackground(Color c)

Sets the background color of this object. (For transparency, see isOpaque.)

Specified by:

[setBackground](../../javax/accessibility/AccessibleComponent.html#setBackground%28java.awt.Color%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

c - the new Color for the background

See Also:

Component.isOpaque()

getForeground

public Color getForeground()

Gets the foreground color of this object.

Specified by:

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

Returns:

the foreground color, if supported, of the object; otherwise, null

See Also:

AccessibleComponent.setForeground(java.awt.Color)

setForeground

public void setForeground(Color c)

Sets the foreground color of this object.

Specified by:

[setForeground](../../javax/accessibility/AccessibleComponent.html#setForeground%28java.awt.Color%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

c - the new Color for the foreground

See Also:

AccessibleComponent.getForeground()

getCursor

public Cursor getCursor()

Gets the Cursor of this object.

Specified by:

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

Returns:

the Curso, if supported, of the object; otherwise, null

See Also:

AccessibleComponent.setCursor(java.awt.Cursor)

setCursor

public void setCursor(Cursor cursor)

Sets the Cursor of this object.

Specified by:

[setCursor](../../javax/accessibility/AccessibleComponent.html#setCursor%28java.awt.Cursor%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

cursor - the new Cursor for the object

See Also:

AccessibleComponent.getCursor()

getFont

public Font getFont()

Gets the Font of this object.

Specified by:

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

Returns:

the Font,if supported, for the object; otherwise, null

See Also:

AccessibleComponent.setFont(java.awt.Font)

setFont

public void setFont(Font f)

Sets the Font of this object.

Specified by:

[setFont](../../javax/accessibility/AccessibleComponent.html#setFont%28java.awt.Font%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

f - the new Font for the object

See Also:

AccessibleComponent.getFont()

getFontMetrics

public FontMetrics getFontMetrics(Font f)

Gets the FontMetrics of this object.

Specified by:

[getFontMetrics](../../javax/accessibility/AccessibleComponent.html#getFontMetrics%28java.awt.Font%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

f - the Font

Returns:

the FontMetrics, if supported, the object; otherwise, null

See Also:

getFont()

isEnabled

public boolean isEnabled()

Determines if the object is enabled.

Specified by:

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

Returns:

true if object is enabled; otherwise, false

See Also:

AccessibleComponent.setEnabled(boolean), AccessibleContext.getAccessibleStateSet(), AccessibleState.ENABLED, AccessibleStateSet

setEnabled

public void setEnabled(boolean b)

Sets the enabled state of the object.

Specified by:

[setEnabled](../../javax/accessibility/AccessibleComponent.html#setEnabled%28boolean%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

b - if true, enables this object; otherwise, disables it

See Also:

AccessibleComponent.isEnabled()

isVisible

public 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, use isShowing.

Specified by:

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

Returns:

true if object is visible; otherwise, false

See Also:

AccessibleComponent.setVisible(boolean), AccessibleContext.getAccessibleStateSet(), AccessibleState.VISIBLE, AccessibleStateSet

setVisible

public void setVisible(boolean b)

Sets the visible state of the object.

Specified by:

[setVisible](../../javax/accessibility/AccessibleComponent.html#setVisible%28boolean%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

b - if true, shows this object; otherwise, hides it

See Also:

AccessibleComponent.isVisible()

isShowing

public 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:

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

Returns:

true if object is showing; otherwise, false

contains

public boolean contains(Point p)

Checks 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:

[contains](../../javax/accessibility/AccessibleComponent.html#contains%28java.awt.Point%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

p - the Point relative to the coordinate system of the object

Returns:

true if object contains Point; otherwise false

See Also:

AccessibleComponent.getBounds()

getLocationOnScreen

public Point getLocationOnScreen()

Returns the location of the object on the screen.

Specified by:

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

Returns:

location of object on screen -- can be null if this object is not on the screen

See Also:

AccessibleComponent.getBounds(), AccessibleComponent.getLocation()

getLocation

public Point getLocation()

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.

Specified by:

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

Returns:

an instance of Point representing the top-left corner of the object's bounds in the coordinate space of the screen; null if this object or its parent are not on the screen

See Also:

AccessibleComponent.getBounds(), AccessibleComponent.getLocationOnScreen()

setLocation

public void setLocation(Point p)

Sets the location of the object relative to the parent.

Specified by:

[setLocation](../../javax/accessibility/AccessibleComponent.html#setLocation%28java.awt.Point%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

p - the new position for the top-left corner

See Also:

AccessibleComponent.getLocation()

getBounds

public Rectangle getBounds()

Gets the bounds of this object in the form of aRectangle object. The bounds specify this object's width, height, and location relative to its parent.

Specified by:

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

Returns:

a rectangle indicating this component's bounds;null if this object is not on the screen

See Also:

AccessibleComponent.contains(java.awt.Point)

setBounds

public void setBounds(Rectangle r)

Sets the bounds of this object in the form of aRectangle object. The bounds specify this object's width, height, and location relative to its parent.

Specified by:

[setBounds](../../javax/accessibility/AccessibleComponent.html#setBounds%28java.awt.Rectangle%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

r - a rectangle indicating this component's bounds

See Also:

AccessibleComponent.getBounds()

getSize

public Dimension getSize()

Returns the size of this object in the form of aDimension object. The height field of the Dimension object contains this object's height, and the width field of the Dimension object contains this object's width.

Specified by:

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

Returns:

a Dimension object that indicates the size of this component; null if this object is not on the screen

See Also:

AccessibleComponent.setSize(java.awt.Dimension)

setSize

public void setSize(Dimension d)

Resizes this object.

Specified by:

[setSize](../../javax/accessibility/AccessibleComponent.html#setSize%28java.awt.Dimension%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

d - - the Dimension specifying the new size of the object

See Also:

AccessibleComponent.getSize()

getAccessibleAt

public Accessible getAccessibleAt(Point p)

Returns the Accessible child, if one exists, contained at the local coordinate Point. If there is no Accessible child, null is returned.

Specified by:

[getAccessibleAt](../../javax/accessibility/AccessibleComponent.html#getAccessibleAt%28java.awt.Point%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

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; else null

isFocusTraversable

public boolean isFocusTraversable()

Returns whether this object can accept focus or not.

Specified by:

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

Returns:

true if object can accept focus; otherwise false

See Also:

AccessibleContext.getAccessibleStateSet(), AccessibleState.FOCUSABLE, AccessibleState.FOCUSED, AccessibleStateSet

requestFocus

public void requestFocus()

Requests focus for this object.

Specified by:

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

See Also:

AccessibleComponent.isFocusTraversable()

addFocusListener

public void addFocusListener(FocusListener l)

Adds the specified focus listener to receive focus events from this component.

Specified by:

[addFocusListener](../../javax/accessibility/AccessibleComponent.html#addFocusListener%28java.awt.event.FocusListener%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

l - the focus listener

See Also:

AccessibleComponent.removeFocusListener(java.awt.event.FocusListener)

removeFocusListener

public void removeFocusListener(FocusListener l)

Removes the specified focus listener so it no longer receives focus events from this component.

Specified by:

[removeFocusListener](../../javax/accessibility/AccessibleComponent.html#removeFocusListener%28java.awt.event.FocusListener%29) in interface [AccessibleComponent](../../javax/accessibility/AccessibleComponent.html "interface in javax.accessibility")

Parameters:

l - the focus listener

See Also:

AccessibleComponent.addFocusListener(java.awt.event.FocusListener)

getAccessibleSelectionCount

public int getAccessibleSelectionCount()

Returns the number of Accessible children currently selected. If no children are selected, the return value will be 0.

Specified by:

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

Returns:

the number of items currently selected

getAccessibleSelection

public Accessible getAccessibleSelection(int i)

Returns an Accessible representing 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 be null.

Note that the index represents the i-th selected child, which is different from the i-th child.

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

See Also:

getAccessibleSelectionCount()

isAccessibleChildSelected

public boolean isAccessibleChildSelected(int i)

Determines 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

See Also:

AccessibleContext.getAccessibleChild(int)

addAccessibleSelection

public void addAccessibleSelection(int i)

Adds the specified Accessible child 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:

[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 the child

See Also:

AccessibleContext.getAccessibleChild(int)

removeAccessibleSelection

public 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:

[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 the child

See Also:

AccessibleContext.getAccessibleChild(int)

clearAccessibleSelection

public void clearAccessibleSelection()

Clears the selection in the object, so that no children in the object are selected.

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()

Causes every child of the object to be selected if the object supports multiple selections.

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.

Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.