<html> <head> <title>Interface XAccessibleComponent</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XAccessibleComponent-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleComponent" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">accessibility</a> :: </p> </td> </tr> <tr> <td class="title">interface XAccessibleComponent</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>The <a href="XAccessibleComponent.html">XAccessibleComponent</a> interface should be supported by any class that can be rendered on the screen. </dd> <dd><p>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 <code>javax.accessibility.AccessibleComponent</code> and <code>javax.accessibility.AccessibleExtendedComponent</code>.</p> <p>Further information about the graphical appearance of an object can be expressed with the <a href="XAccessibleExtendedComponent.html">XAccessibleExtendedComponent</a> interface.</p> <p>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: <ul><li>The screen coordinate system has its origin in the upper left corner of the current screen. Used by the <method>getLocationOnScreen</method> function.</li> <li>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 <method>getLocation</method> function.</li> <li>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 <method>containsPoint</method> and <method>getAccessibleAtPoint</method> functions.</li> </ul></p> <p>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 <a href="XAccessibleAction.html">XAccessibleAction</a> interface of a component, provided that it is supported, and use the <method scope="XAccessibleAction">getAccessibleKeyBinding()</method>.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> <dt><b>See also</b></dt> <dd><a href="XAccessibleExtendedComponent.html">XAccessibleExtendedComponent</a></dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleComponent">Accessibility - XAccessibleComponent</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#containsPoint">containsPoint</a></td> <td class="imsum_right">Tests whether the specified point lies within this object's bounds. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleAtPoint">getAccessibleAtPoint</a></td> <td class="imsum_right">Returns the Accessible child that is rendered under the given point. </td> </tr> <tr> <td class="imsum_left"><a href="#getBounds">getBounds</a></td> <td class="imsum_right">Returns the bounding box of this object. </td> </tr> <tr> <td class="imsum_left"><a href="#getLocation">getLocation</a></td> <td class="imsum_right">Returns the location of the upper left corner of the object's bounding box relative to the parent.</p> </td> </tr> <tr> <td class="imsum_left"><a href="#getLocationOnScreen">getLocationOnScreen</a></td> <td class="imsum_right">Returns the location of the upper left corner of the object's bounding box in screen coordinates. </td> </tr> <tr> <td class="imsum_left"><a href="#getSize">getSize</a></td> <td class="imsum_right">Returns the size of this object's bounding box. </td> </tr> <tr> <td class="imsum_left"><a href="#grabFocus">grabFocus</a></td> <td class="imsum_right">Grabs the focus to this object. </td> </tr> <tr> <td class="imsum_left"><a href="#getForeground">getForeground</a></td> <td class="imsum_right">Returns the foreground color of this object. </td> </tr> <tr> <td class="imsum_left"><a href="#getBackground">getBackground</a></td> <td class="imsum_right">Returns the background color of this object. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="containsPoint" class="membertitle">containsPoint</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>containsPoint</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a></td> <td valign="bottom"> aPoint );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Tests whether the specified point lies within this object's bounds. </dd> <dd><p>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 <b>true</b> value.</p> </dd> <dt><b>Parameter point</b></dt> <dd>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 <method>getBounds</method>. The scale of the coordinate system is identical to that of the screen coordiante system. </dd> <dt><b>Returns</b></dt> <dd>Returns <b>true</b> if the point lies within or on the object's bounding box and <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleAtPoint" class="membertitle">getAccessibleAtPoint</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XAccessible.html">XAccessible</a></td> </tr> <tr> <td valign="top"><b>getAccessibleAtPoint</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a></td> <td valign="bottom"> aPoint );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the Accessible child that is rendered under the given point. </dd> <dd><p>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 <b>true</b> value.</p> </dd> <dt><b>Parameter aPoint</b></dt> <dd>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 <method>getBounds</method>. The scale of the coordinate system is identical to that of the screen coordiante system. </dd> <dt><b>Returns</b></dt> <dd>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. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getBounds" class="membertitle">getBounds</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Rectangle.html">Rectangle</a></td> </tr> <tr> <td valign="top"><b>getBounds</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the bounding box of this object. </dd> <dd><p>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 <method>getLocation</methodmber> and <method>getSize</method> return the same information. With method <method>getLocationOnScreen</method> you can get the bound box position in screen coordinates.</p> </dd> <dt><b>Returns</b></dt> <dd>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). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLocation" class="membertitle">getLocation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a></td> </tr> <tr> <td valign="top"><b>getLocation</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the location of the upper left corner of the object's bounding box relative to the parent.</p> </dd> <dd><p>The coordinates of the bounding box are given relative to the parent's coordinate system.</p> </dd> <dt><b>Returns</b></dt> <dd>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). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLocationOnScreen" class="membertitle">getLocationOnScreen</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Point.html">Point</a></td> </tr> <tr> <td valign="top"><b>getLocationOnScreen</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the location of the upper left corner of the object's bounding box in screen coordinates. </dd> <dd><p>This method returns the same point as does the method <method>getLocation</method>. 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.</p> </dd> <dt><b>Returns</b></dt> <dd>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). </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSize" class="membertitle">getSize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a></td> </tr> <tr> <td valign="top"><b>getSize</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the size of this object's bounding box. </dd> <dt><b>Returns</b></dt> <dd>The returned size is the size of this object or empty if it is not rendered on any screen. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="grabFocus" class="membertitle">grabFocus</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">[oneway] void</td> </tr> <tr> <td valign="top"><b>grabFocus</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Grabs the focus to this object. </dd> <dd><p>If this object can not accept the focus, i.e. <method>isFocusTraversable</method> returns <b>false</b> 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 <code>requestFocus</code> in the Java Accessibility API 1.4.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getForeground" class="membertitle">getForeground</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a></td> </tr> <tr> <td valign="top"><b>getForeground</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the foreground color of this object. </dd> <dt><b>Returns</b></dt> <dd>The returned color is the foreground color of this object or, if that is not supported, the default foreground color. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getBackground" class="membertitle">getBackground</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a></td> </tr> <tr> <td valign="top"><b>getBackground</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the background color of this object. </dd> <dt><b>Returns</b></dt> <dd>The returned color is the background color of this object or, if that is not supported, the default background color. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>