Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: accessibility ::
interface XAccessibleComponent
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XAccessibleComponent
Description The XAccessibleComponent interface should be supported by any class that can be rendered on the screen. This interface provides the standard mechanism for an assistive technology to retrieve information concerning the graphical representation of an object. This interface combines methods from the Java interfaces`javax.accessibility.AccessibleComponent` and`javax.accessibility.AccessibleExtendedComponent` . Further information about the graphical appearance of an object can be expressed with the XAccessibleExtendedComponent interface. Coordinates used by the functions of this interface are specified in different coordinate systems. Their scale is the same and is equal to that of the screen coordiante system. In other words all coordinates are measured in pixel. They differ in their respective origin: The screen coordinate system has its origin in the upper left corner of the current screen. Used by the getLocationOnScreen function. The origin of the parent coordinate system is the upper left corner of the parent's bounding box. With no parent the screen coordinate system is used instead. Used by the getLocation function. The object coordinate system is relative to the upper left corner of an object's bounding box. It is relative to itself so to speak. Used by the containsPoint and getAccessibleAtPoint functions. Key bindings which are associated with an accessible component can be retrieved at the component's action. The reason for this is that key bindings are associated with actions and directly with a component. This distinction becomes important when there are more than one action. To get access to the key bindings you have to get the XAccessibleAction interface of a component, provided that it is supported, and use the getAccessibleKeyBinding() . See also XAccessibleExtendedComponent Since version OpenOffice.org 1.1.1 Developers Guide 17.7.1 Accessibility - Using the Accessibility API - A Simple Screen Reader - Putting the Accessibility Interfaces to Work - XAccessibleComponent

Methods' Summary
containsPoint | Tests whether the specified point lies within this object's bounds.
getAccessibleAtPoint | Returns the Accessible child that is rendered under the given point.
getBounds | Returns the bounding box of this object.
getLocation | Returns the location of the upper left corner of the object's bounding box relative to the parent.
getLocationOnScreen | Returns the location of the upper left corner of the object's bounding box in screen coordinates.
getSize | Returns the size of this object's bounding box.
grabFocus | Grabs the focus to this object.
getForeground | Returns the foreground color of this object.
getBackground | Returns the background color of this object.

Methods' Details
containsPoint
boolean containsPoint( | [in] ::com::sun::star::awt::Point | aPoint );
Description Tests whether the specified point lies within this object's bounds. The test point's coordinates are defined relative to the coordinate system of the object. That means that when the object is an opaque rectangle then both the points (0,0) and (with-1,height-1) would yield a true value. Parameter point Coordinates of the point to test. The origin of the coordinate system is the upper left corner of the object's bounding box as returned by the getBounds . The scale of the coordinate system is identical to that of the screen coordiante system. Returns Returns true if the point lies within or on the object's bounding box and false otherwise.
getAccessibleAtPoint
XAccessible getAccessibleAtPoint( | [in] ::com::sun::star::awt::Point | aPoint );
Description Returns the Accessible child that is rendered under the given point. The test point's coordinates are defined relative to the coordinate system of the object. That means that when the object is an opaque rectangle then both the points (0,0) and (with-1,height-1) would yield a true value. Parameter aPoint Coordinates of the test point for which to find the Accessible child. The origin of the coordinate system is the upper left corner of the object's bounding box as returned by the getBounds . The scale of the coordinate system is identical to that of the screen coordiante system. Returns If there is one child which is rendered so that its bounding box contains the test point then a reference to that object is returned. If there is more than one child which satisfies that condition then a reference to that one is returned that is painted on top of the others. If no there is no child which is rendered at the test point an empty reference is returned.
getBounds
::com::sun::star::awt::Rectangle getBounds(); |  |
Description Returns the bounding box of this object. The returned bounding box has the form of a rectangle. Its coordinates are relative to the object's parent coordinate system. Note that the two methods getLocation and getSize return the same information. With method getLocationOnScreen you can get the bound box position in screen coordinates. Returns The coordinates of the returned rectangle are relative to this object's parent or relative to the screen on which this object is rendered if it has no parent. If the object is not on any screen the returnred rectangle is empty and located at position (0,0).
getLocation
::com::sun::star::awt::Point getLocation(); |  |
Description Returns the location of the upper left corner of the object's bounding box relative to the parent. The coordinates of the bounding box are given relative to the parent's coordinate system. Returns The coordinates of the returned position are relative to this object's parent or relative to the screen on which this object is rendered if it has no parent. If the object is not on any screen the returnred position is (0,0).
getLocationOnScreen
::com::sun::star::awt::Point getLocationOnScreen(); |  |
Description Returns the location of the upper left corner of the object's bounding box in screen coordinates. This method returns the same point as does the method getLocation . The difference is that the coordinates are absolute screen coordinates of the screen to which the object is rendered instead of being relative to the object's parent. Returns The coordinates of the returned position are relative to the screen on which this object is rendered. If the object is not on any screen the returnred position is (0,0).
getSize
::com::sun::star::awt::Size getSize(); |  |
Description Returns the size of this object's bounding box. Returns The returned size is the size of this object or empty if it is not rendered on any screen.
grabFocus
[oneway] void grabFocus(); |  |
Description Grabs the focus to this object. If this object can not accept the focus, i.e. isFocusTraversable returns false for this object then nothing happens. Otherwise the object will attempt to take the focus. Nothing happens if that fails, otherwise the object has the focus. This method is called`requestFocus` in the Java Accessibility API 1.4.
getForeground
::com::sun::star::util::color getForeground(); |  |
Description Returns the foreground color of this object. Returns The returned color is the foreground color of this object or, if that is not supported, the default foreground color.
getBackground
::com::sun::star::util::color getBackground(); |  |
Description Returns the background color of this object. Returns The returned color is the background color of this object or, if that is not supported, the default background color.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.