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.
javax.accessibility
interface AccessibleComponent
- All Known Subinterfaces:
- AccessibleExtendedComponent
- All Known Implementing Classes:
- Component.AccessibleAWTComponent, Box.Filler.AccessibleBoxFiller, Button.AccessibleAWTButton, Canvas.AccessibleAWTCanvas, Checkbox.AccessibleAWTCheckbox, Choice.AccessibleAWTChoice, Container.AccessibleAWTContainer, Label.AccessibleAWTLabel, List.AccessibleAWTList, List.AccessibleAWTList.AccessibleAWTListChild, Scrollbar.AccessibleAWTScrollBar, TextComponent.AccessibleAWTTextComponent, Box.AccessibleBox, CellRendererPane.AccessibleCellRendererPane, JComponent.AccessibleJComponent, Panel.AccessibleAWTPanel, ScrollPane.AccessibleAWTScrollPane, Window.AccessibleAWTWindow, TextArea.AccessibleAWTTextArea, TextField.AccessibleAWTTextField, AbstractButton.AccessibleAbstractButton, JColorChooser.AccessibleJColorChooser, JComboBox.AccessibleJComboBox, JDesktopPane.AccessibleJDesktopPane, JFileChooser.AccessibleJFileChooser, JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon.AccessibleJDesktopIcon, JLabel.AccessibleJLabel, JLayeredPane.AccessibleJLayeredPane, JList.AccessibleJList, JMenuBar.AccessibleJMenuBar, JOptionPane.AccessibleJOptionPane, JPanel.AccessibleJPanel, JPopupMenu.AccessibleJPopupMenu, JProgressBar.AccessibleJProgressBar, JRootPane.AccessibleJRootPane, JScrollBar.AccessibleJScrollBar, JScrollPane.AccessibleJScrollPane, JSeparator.AccessibleJSeparator, JSlider.AccessibleJSlider, JSpinner.AccessibleJSpinner, JSplitPane.AccessibleJSplitPane, JTabbedPane.AccessibleJTabbedPane, JTable.AccessibleJTable, JTableHeader.AccessibleJTableHeader, JTextComponent.AccessibleJTextComponent, JToolBar.AccessibleJToolBar, JToolTip.AccessibleJToolTip, JTree.AccessibleJTree, JViewport.AccessibleJViewport, Applet.AccessibleApplet, Dialog.AccessibleAWTDialog, Frame.AccessibleAWTFrame, JWindow.AccessibleJWindow, JButton.AccessibleJButton, JMenuItem.AccessibleJMenuItem, JToggleButton.AccessibleJToggleButton, JEditorPane.AccessibleJEditorPane, JTextArea.AccessibleJTextArea, JTextField.AccessibleJTextField, JApplet.AccessibleJApplet, JDialog.AccessibleJDialog, JFrame.AccessibleJFrame, JCheckBoxMenuItem.AccessibleJCheckBoxMenuItem, JMenu.AccessibleJMenu, JRadioButtonMenuItem.AccessibleJRadioButtonMenuItem, JCheckBox.AccessibleJCheckBox, JRadioButton.AccessibleJRadioButton, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport, JPasswordField.AccessibleJPasswordField, JList.AccessibleJList.AccessibleJListChild, JTable.AccessibleJTable.AccessibleJTableCell, JTableHeader.AccessibleJTableHeader.AccessibleJTableHeaderEntry, JTree.AccessibleJTree.AccessibleJTreeNode, MenuComponent.AccessibleAWTMenuComponent, MenuBar.AccessibleAWTMenuBar, MenuItem.AccessibleAWTMenuItem, CheckboxMenuItem.AccessibleAWTCheckboxMenuItem, Menu.AccessibleAWTMenu, PopupMenu.AccessibleAWTPopupMenu
public interface AccessibleComponent
The AccessibleComponent interface should be supported by any object
that is rendered on the screen. This interface provides the standard
mechanism for an assistive technology to determine and set the
graphical representation of an object. Applications can determine
if an object supports the AccessibleComponent interface by first
obtaining its AccessibleContext
and then calling the
{@link AccessibleContext#getAccessibleComponent} method.
If the return value is not null, the object supports this interface.
Method Summary |
void |
Adds the specified focus listener to receive focus events from this
component.
|
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.
|
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.
|
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 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 focus listener so it no longer receives focus
events from this component.
|
void |
Requests focus for this object.
|
void |
Sets the background color of this object.
|
void |
Sets the bounds of this object in the form of a Rectangle object.
|
void |
Sets the Cursor of this object.
|
void |
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 so that it has width and height.
|
void |
Sets the visible state of the object.
|
addFocusListener
public void addFocusListener(FocusListener l)
-
Adds the specified focus listener to receive focus events from this
component.
- Parameters:
l
- the focus listener
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.
- Parameters:
p
- The point relative to the coordinate system of this object.
- Returns:
- the Accessible, if it exists, at the specified location;
otherwise null
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 Cursor, 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
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:
- the location of the object on screen; 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
isEnabled
public boolean isEnabled()
-
Determines if the object is enabled. Objects that are enabled
will also have the AccessibleState.ENABLED state set in their
AccessibleStateSets.
- Returns:
- true if object is enabled; otherwise, false
isFocusTraversable
public boolean isFocusTraversable()
-
Returns whether this object can accept focus or not. Objects that
can accept focus will also have the AccessibleState.FOCUSABLE state
set in their AccessibleStateSets.
- 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 its ancestors.
Note: this
will return true even if the object is obscured by another (for example,
it is 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 be
showing on the screen because one of the objects that this object
is contained by is currently not visible. To determine if an object is
showing on the screen, use isShowing().
Objects that are visible will also have the
AccessibleState.VISIBLE state set in their AccessibleStateSets.
- Returns:
- true if object is visible; otherwise, false
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. If this object cannot accept focus,
nothing will happen. Otherwise, the object will attempt to take
focus.
setBackground
public void setBackground(Color c)
-
Sets the background color of this object.
- 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
- rectangle indicating this component's bounds
setCursor
public void setCursor(Cursor cursor)
-
Sets the Cursor of this object.
- 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
- the new position for the top-left corner
setSize
public void setSize(Dimension d)
-
Resizes this object so that it has width and height.
- 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:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.