This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.awt
class MenuComponent.AccessibleAWTMenuComponent

java.lang.Object extended by javax.accessibility.AccessibleContext extended by 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.


Field Summary
 
Fields inherited from class javax.accessibility.AccessibleContext
accessibleDescription, accessibleName, accessibleParent, 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
 
Constructor Summary
protected

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

          Adds the specified Accessible child of the object to the object's selection.
 void

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

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

          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.
 Accessible

          Returns the Accessible child, if one exists, contained at the local coordinate Point.
 Accessible

          Returns the nth Accessible child of the object.
 int

          Returns the number of accessible children in the object.
 AccessibleComponent

          Gets the AccessibleComponent associated with this object if one exists.
 String

          Gets the accessible description of this object.
 int

          Gets the index of this object in its accessible parent.
 String

          Gets the accessible name of this object.
 Accessible

          Gets the Accessible parent of this object.
 AccessibleRole

          Gets the role of this object.
 AccessibleSelection

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

          Returns an Accessible representing the specified selected child in the object.
 int

          Returns the number of Accessible children currently selected.
 AccessibleStateSet

          Gets the state of this object.
 Color

          Gets the background color of this object.
 Rectangle

          Gets the bounds of this object in the form of a Rectangle object.
 Cursor

          Gets the Cursor of this object.
 Font

          Gets the Font of this object.
 FontMetrics

          Gets the FontMetrics of this object.
 Color

          Gets the foreground color of this object.
 Locale

          Returns the locale of this object.
 Point

          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.
 Point

          Returns the location of the object on the screen.
 Dimension

          Returns the size of this object in the form of a Dimension object.
 boolean

          Determines if the current child of this object is selected.
 boolean

          Determines if the object is enabled.
 boolean

          Returns whether this object can accept focus or not.
 boolean

          Determines if the object is showing.
 boolean

          Determines if the object is visible.
 void

          Removes the specified child of the object from the object's selection.
 void

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

          Requests focus for this object.
 void

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

          Sets the background color of this object.
 void

          Sets the bounds of this object in the form of a Rectangle object.
 void
setCursor(Cursor cursor)

          Sets the Cursor of this object.
 void
setEnabled(boolean b)

          Sets the enabled state of the object.
 void

          Sets the Font of this object.
 void

          Sets the foreground color of this object.
 void

          Sets the location of the object relative to the parent.
 void

          Resizes this object.
 void
setVisible(boolean b)

          Sets the visible state of the object.
 
Methods inherited from class javax.accessibility.AccessibleContext
addPropertyChangeListener, firePropertyChange, getAccessibleAction, getAccessibleChild, getAccessibleChildrenCount, getAccessibleComponent, getAccessibleDescription, getAccessibleEditableText, getAccessibleIcon, getAccessibleIndexInParent, getAccessibleName, getAccessibleParent, getAccessibleRelationSet, getAccessibleRole, getAccessibleSelection, getAccessibleStateSet, getAccessibleTable, getAccessibleText, getAccessibleValue, getLocale, removePropertyChangeListener, setAccessibleDescription, setAccessibleName, setAccessibleParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MenuComponent.AccessibleAWTMenuComponent

protected MenuComponent.AccessibleAWTMenuComponent()
Although the class is abstract, this should be called by all sub-classes.

Method Detail

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.

Parameters:
i - the zero-based index of the child

addFocusListener

public void addFocusListener(FocusListener l)
Adds the specified focus listener to receive focus events from this component.

Parameters:
l - the focus listener

clearAccessibleSelection

public void clearAccessibleSelection()
Clears the selection in the object, so that no children in the object are selected.


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.

Parameters:
p - the Point relative to the coordinate system of the object
Returns:
true if object contains Point; otherwise false

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.

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

getAccessibleChild

public Accessible getAccessibleChild(int i)
Returns the nth Accessible child of the object.

Overrides:
getAccessibleChild in class AccessibleContext
Parameters:
i - zero-based index of child
Returns:
the nth Accessible child of the object

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.

Overrides:
getAccessibleChildrenCount in class AccessibleContext
Returns:
the number of accessible children in the object

getAccessibleComponent

public AccessibleComponent getAccessibleComponent()
Gets the AccessibleComponent associated with this object if one exists. Otherwise return null.

Overrides:
getAccessibleComponent in class AccessibleContext
Returns:
the component

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 in class AccessibleContext
Returns:
the localized description of the object -- can be null if this object does not have a description

getAccessibleIndexInParent

public int getAccessibleIndexInParent()
Gets the index of this object in its accessible parent.

Overrides:
getAccessibleIndexInParent in class AccessibleContext
Returns:
the index of this object in its parent; -1 if this object does not have an accessible parent

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 in class AccessibleContext
Returns:
the localized name of the object -- can be null if this object does not have a name

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 in class AccessibleContext
Returns:
the Accessible parent of this object -- can be null if this object does not have an Accessible parent

getAccessibleRole

public AccessibleRole getAccessibleRole()
Gets the role of this object.

Overrides:
getAccessibleRole in class AccessibleContext
Returns:
an instance of AccessibleRole describing the role of the object

getAccessibleSelection

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

Overrides:
getAccessibleSelection in class AccessibleContext
Returns:
AccessibleSelection if supported by object; else return null

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.

Parameters:
i - the zero-based index of selected children
Returns:
the i-th selected child

getAccessibleSelectionCount

public int getAccessibleSelectionCount()
Returns the number of Accessible children currently selected. If no children are selected, the return value will be 0.

Returns:
the number of items currently selected

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()
Gets the state of this object.

Overrides:
getAccessibleStateSet in class AccessibleContext
Returns:
an instance of AccessibleStateSet containing the current state set of the object

getBackground

public Color getBackground()
Gets the background color of this object.

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

getBounds

public Rectangle getBounds()
Gets the bounds of this object in the form of a Rectangle object. The bounds specify this object's width, height, and location relative to its parent.

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

getCursor

public Cursor getCursor()
Gets the Cursor of this object.

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

getFont

public Font getFont()
Gets the Font of this object.

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

getFontMetrics

public FontMetrics getFontMetrics(Font f)
Gets the FontMetrics of this object.

Parameters:
f - the Font
Returns:
the FontMetrics, if supported, the object; otherwise, null

getForeground

public Color getForeground()
Gets the foreground color of this object.

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

getLocale

public Locale getLocale()
Returns the locale of this object.

Overrides:
getLocale in class AccessibleContext
Returns:
the locale of this object

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.

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

getLocationOnScreen

public Point getLocationOnScreen()
Returns the location of the object on the screen.

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

getSize

public Dimension getSize()
Returns the size of this object in the form of a Dimension 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.

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

isAccessibleChildSelected

public boolean isAccessibleChildSelected(int i)
Determines if the current child of this object is selected.

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

isEnabled

public boolean isEnabled()
Determines if the object is enabled.

Returns:
true if object is enabled; otherwise, false

isFocusTraversable

public boolean isFocusTraversable()
Returns whether this object can accept focus or not.

Returns:
true if object can accept focus; otherwise false

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

Returns:
true if object is showing; otherwise, false

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.

Returns:
true if object is visible; otherwise, false

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.

Parameters:
i - the zero-based index of the child

removeFocusListener

public void removeFocusListener(FocusListener l)
Removes the specified focus listener so it no longer receives focus events from this component.

Parameters:
l - the focus listener

requestFocus

public void requestFocus()
Requests focus for this object.


selectAllAccessibleSelection

public void selectAllAccessibleSelection()
Causes every child of the object to be selected if the object supports multiple selections.


setBackground

public void setBackground(Color c)
Sets the background color of this object. (For transparency, see isOpaque.)

Parameters:
c - the new Color for the background

setBounds

public void setBounds(Rectangle r)
Sets the bounds of this object in the form of a Rectangle object. The bounds specify this object's width, height, and location relative to its parent.

Parameters:
r - a rectangle indicating this component's bounds

setCursor

public void setCursor(Cursor cursor)
Sets the Cursor of 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.

Parameters:
cursor - the new Cursor for the object

setEnabled

public void setEnabled(boolean b)
Sets the enabled state of the object.

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

setFont

public void setFont(Font f)
Sets the Font of this object.

Parameters:
f - the new Font for the object

setForeground

public void setForeground(Color c)
Sets the foreground color of this object.

Parameters:
c - the new Color for the foreground

setLocation

public void setLocation(Point p)
Sets the location of the object relative to the parent.

Parameters:
p

setSize

public void setSize(Dimension d)
Resizes this object.

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

setVisible

public void setVisible(boolean b)
Sets the visible state of the object.

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


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.