- All Known Subinterfaces:
AccessibleExtendedComponent
- All Known Implementing Classes:
AbstractButton.AccessibleAbstractButton,Applet.AccessibleApplet,Box.AccessibleBox,Box.Filler.AccessibleBoxFiller,Button.AccessibleAWTButton,Canvas.AccessibleAWTCanvas,CellRendererPane.AccessibleCellRendererPane,Checkbox.AccessibleAWTCheckbox,CheckboxMenuItem.AccessibleAWTCheckboxMenuItem,Choice.AccessibleAWTChoice,Component.AccessibleAWTComponent,Container.AccessibleAWTContainer,Dialog.AccessibleAWTDialog,Frame.AccessibleAWTFrame,JApplet.AccessibleJApplet,JButton.AccessibleJButton,JCheckBox.AccessibleJCheckBox,JCheckBoxMenuItem.AccessibleJCheckBoxMenuItem,JColorChooser.AccessibleJColorChooser,JComboBox.AccessibleJComboBox,JComponent.AccessibleJComponent,JDesktopPane.AccessibleJDesktopPane,JDialog.AccessibleJDialog,JEditorPane.AccessibleJEditorPane,JEditorPane.AccessibleJEditorPaneHTML,JEditorPane.JEditorPaneAccessibleHypertextSupport,JFileChooser.AccessibleJFileChooser,JFrame.AccessibleJFrame,JInternalFrame.AccessibleJInternalFrame,JInternalFrame.JDesktopIcon.AccessibleJDesktopIcon,JLabel.AccessibleJLabel,JLayeredPane.AccessibleJLayeredPane,JList.AccessibleJList,JList.AccessibleJList.AccessibleJListChild,JMenu.AccessibleJMenu,JMenuBar.AccessibleJMenuBar,JMenuItem.AccessibleJMenuItem,JOptionPane.AccessibleJOptionPane,JPanel.AccessibleJPanel,JPasswordField.AccessibleJPasswordField,JPopupMenu.AccessibleJPopupMenu,JProgressBar.AccessibleJProgressBar,JRadioButton.AccessibleJRadioButton,JRadioButtonMenuItem.AccessibleJRadioButtonMenuItem,JRootPane.AccessibleJRootPane,JScrollBar.AccessibleJScrollBar,JScrollPane.AccessibleJScrollPane,JSeparator.AccessibleJSeparator,JSlider.AccessibleJSlider,JSpinner.AccessibleJSpinner,JSplitPane.AccessibleJSplitPane,JTabbedPane.AccessibleJTabbedPane,JTable.AccessibleJTable,JTable.AccessibleJTable.AccessibleJTableCell,JTableHeader.AccessibleJTableHeader,JTableHeader.AccessibleJTableHeader.AccessibleJTableHeaderEntry,JTextArea.AccessibleJTextArea,JTextComponent.AccessibleJTextComponent,JTextField.AccessibleJTextField,JToggleButton.AccessibleJToggleButton,JToolBar.AccessibleJToolBar,JToolTip.AccessibleJToolTip,JTree.AccessibleJTree,JTree.AccessibleJTree.AccessibleJTreeNode,JViewport.AccessibleJViewport,JWindow.AccessibleJWindow,Label.AccessibleAWTLabel,List.AccessibleAWTList,List.AccessibleAWTList.AccessibleAWTListChild,Menu.AccessibleAWTMenu,MenuBar.AccessibleAWTMenuBar,MenuComponent.AccessibleAWTMenuComponent,MenuItem.AccessibleAWTMenuItem,Panel.AccessibleAWTPanel,PopupMenu.AccessibleAWTPopupMenu,Scrollbar.AccessibleAWTScrollBar,ScrollPane.AccessibleAWTScrollPane,TextArea.AccessibleAWTTextArea,TextComponent.AccessibleAWTTextComponent,TextField.AccessibleAWTTextField,Translator,Window.AccessibleAWTWindow
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
AccessibleContext.getAccessibleComponent() method. If the return value
is not null, the object supports this interface.-
Method Summary
Modifier and TypeMethodDescriptionvoidAdds the specified focus listener to receive focus events from this component.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.Gets the background color of this object.Gets the bounds of this object in the form of aRectangleobject.Gets the cursor of this object.getFont()Gets the font of this object.Gets theFontMetricsof this object.Gets the foreground color 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.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.voidRemoves the specified focus listener so it no longer receives focus events from this component.voidRequests focus for this object.voidSets the background color of this object.voidSets the bounds of this object in the form of aRectangleobject.voidSets the cursor of this object.voidsetEnabled(boolean b) Sets the enabled state of the object.voidSets the font of 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 so that it has width and height.voidsetVisible(boolean b) Sets the visible state of the object.
-
Method Details
-
getBackground
Color getBackground()Gets the background color of this object.- Returns:
- the background color, if supported, of the object; otherwise,
null - See Also:
-
setBackground
Sets the background color of this object.- Parameters:
c- the new color for the background- See Also:
-
getForeground
Color getForeground()Gets the foreground color of this object.- Returns:
- the foreground color, if supported, of the object; otherwise,
null - See Also:
-
setForeground
Sets the foreground color of this object.- Parameters:
c- the new color for the foreground- See Also:
-
getCursor
Cursor getCursor()Gets the cursor of this object.- Returns:
- the cursor, if supported, of the object; otherwise,
null - See Also:
-
setCursor
Sets the cursor of this object.- Parameters:
cursor- the new cursor for the object- See Also:
-
getFont
Font getFont()Gets the font of this object.- Returns:
- the font, if supported, for the object; otherwise,
null - See Also:
-
setFont
Sets the font of this object.- Parameters:
f- the new font for the object- See Also:
-
getFontMetrics
Gets theFontMetricsof this object.- Parameters:
f- the font for which font metrics is to be obtained- Returns:
- the
FontMetrics, if supported, the object; otherwise,null - See Also:
-
isEnabled
boolean isEnabled()Determines if the object is enabled. Objects that are enabled will also have theAccessibleState.ENABLEDstate set in theirAccessibleStateSets.- Returns:
trueif object is enabled; otherwise,false- See Also:
-
setEnabled
void setEnabled(boolean b) Sets the enabled state of the object.- Parameters:
b- iftrue, enables this object; otherwise, disables it- See Also:
-
isVisible
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, useisShowing()Objects that are visible will also have the
AccessibleState.VISIBLEstate set in theirAccessibleStateSets.- Returns:
trueif object is visible; otherwise,false- See Also:
-
setVisible
void setVisible(boolean b) Sets the visible state of the object.- Parameters:
b- iftrue, shows this object; otherwise, hides it- See Also:
-
isShowing
boolean isShowing()Determines if the object is showing. This is determined by checking the visibility of the object and its ancestors. Note: this will returntrueeven if the object is obscured by another (for example, it is underneath a menu that was pulled down).- Returns:
trueif object is showing; otherwise,false
-
contains
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:
trueif object contains point; otherwisefalse- See Also:
-
getLocationOnScreen
Point getLocationOnScreen()Returns the location of the object on the screen.- Returns:
- the location of the object on screen;
nullif this object is not on the screen - See Also:
-
getLocation
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
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:
-
setLocation
Sets the location of the object relative to the parent.- Parameters:
p- the new position for the top-left corner- See Also:
-
getBounds
Rectangle getBounds()Gets the bounds of this object in the form of aRectangleobject. The bounds specify this object's width, height, and location relative to its parent.- Returns:
- A rectangle indicating this component's bounds;
nullif this object is not on the screen. - See Also:
-
setBounds
Sets the bounds of this object in the form of aRectangleobject. The bounds specify this object's width, height, and location relative to its parent.- Parameters:
r- rectangle indicating this component's bounds- See Also:
-
getSize
Dimension getSize()Returns the size of this object in the form of aDimensionobject. Theheightfield of theDimensionobject contains this object's height, and thewidthfield of theDimensionobject contains this object's width.- Returns:
- A
Dimensionobject that indicates the size of this component;nullif this object is not on the screen - See Also:
-
setSize
Resizes this object so that it has width and height.- Parameters:
d- The dimension specifying the new size of the object- See Also:
-
getAccessibleAt
Returns theAccessiblechild, if one exists, contained at the local coordinatePoint.- Parameters:
p- The point relative to the coordinate system of this object- Returns:
- the
Accessible, if it exists, at the specified location; otherwisenull
-
isFocusTraversable
boolean isFocusTraversable()Returns whether this object can accept focus or not. Objects that can accept focus will also have theAccessibleState.FOCUSABLEstate set in theirAccessibleStateSets.- Returns:
trueif object can accept focus; otherwisefalse- See Also:
-
requestFocus
void requestFocus()Requests focus for this object. If this object cannot accept focus, nothing will happen. Otherwise, the object will attempt to take focus.- See Also:
-
addFocusListener
Adds the specified focus listener to receive focus events from this component.- Parameters:
l- the focus listener- See Also:
-
removeFocusListener
Removes the specified focus listener so it no longer receives focus events from this component.- Parameters:
l- the focus listener- See Also:
-