<html> <head> <title>Interface XExtendedToolkit</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="XExtendedToolkit-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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">awt</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">deprecated </td> <td width="50%" class="title">interface XExtendedToolkit</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Deprecation Info</b></dt> <dd>This interface was only implemented in an intermediate developer release anyway. </dd> <dt><b>Description</b></dt> <dd>The <a href="XExtendedToolkit.html">XExtendedToolkit</a> is an extension of the <a href="XToolkit.html">XToolkit</a> interface. It basically provides access to three event broadcasters which are used for instance in the context of accessibility. It is, however, not restricted to accessibility. </dd> <dd><p>The first event broadcaster lets you keep track of the open top-level windows (frames). To get the set of currently open top-level window use the <a href="XExtendedToolkit.html#getTopWindowCount">getTopWindowCount</a> and <a href="XExtendedToolkit.html#getTopWindow">getTopWindow</a> methods.</p> <p>The second event broadcaster informs its listeners of key events. Its listeners can, unlike with most other broadcasters/listeners, consume events, so that other listeners will not be called for consumed events.</p> <p>The last event broadcaster sends events on focus changes of all elements that can have the input focus.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</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="#getTopWindowCount">getTopWindowCount</a></td> <td class="imsum_right">This function returns the number of currently existing top-level windows. </td> </tr> <tr> <td class="imsum_left"><a href="#getTopWindow">getTopWindow</a></td> <td class="imsum_right">Return a reference to the specified top-level window. Note that the number of top-level windows may change between a call to <a href="#getTopWindowCount()">getTopWindowCount()</a> and successive calls to this function. </td> </tr> <tr> <td class="imsum_left"><a href="#getActiveTopWindow">getActiveTopWindow</a></td> <td class="imsum_right">Return the currently active top-level window, i.e. which has currently the input focus. </td> </tr> <tr> <td class="imsum_left"><a href="#addTopWindowListener">addTopWindowListener</a></td> <td class="imsum_right">Add a new listener that is called for events that involve <a href="XTopWindow.html">XTopWindow</a>s. After having obtained the current list of exisiting top-level windows you can keep this list up-to-date by listening to opened or closed top-level windows. Wait for activations or deactivations of top-level windows to keep track of the currently active frame. </td> </tr> <tr> <td class="imsum_left"><a href="#removeTopWindowListener">removeTopWindowListener</a></td> <td class="imsum_right">Remove the specified listener from the list of listeners. </td> </tr> <tr> <td class="imsum_left"><a href="#addKeyHandler">addKeyHandler</a></td> <td class="imsum_right">Add a new listener that is called on <a href="KeyEvent.html">KeyEvent</a>s. Every listener is given the opportunity to consume the event, i.e. prevent the not yet called listeners from being called. </td> </tr> <tr> <td class="imsum_left"><a href="#removeKeyHandler">removeKeyHandler</a></td> <td class="imsum_right">Remove the specified listener from the list of listeners. </td> </tr> <tr> <td class="imsum_left"><a href="#addFocusListener">addFocusListener</a></td> <td class="imsum_right">Add a new listener that is called on <a href="FocusEvent.html">FocusEvent</a>s. Use this focus broadcaster to keep track of the object that currently has the input focus. </td> </tr> <tr> <td class="imsum_left"><a href="#removeFocusListener">removeFocusListener</a></td> <td class="imsum_right">Remove the specified listener from the list of listeners. </td> </tr> <tr> <td class="imsum_left"><a href="#fireFocusGained">fireFocusGained</a></td> <td class="imsum_right">Broadcasts the a focusGained on all registered focus listeners </td> </tr> <tr> <td class="imsum_left"><a href="#fireFocusLost">fireFocusLost</a></td> <td class="imsum_right">Broadcasts the a focusGained on all registered focus listeners </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="getTopWindowCount" class="membertitle">getTopWindowCount</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">long</td> </tr> <tr> <td valign="top"><b>getTopWindowCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>This function returns the number of currently existing top-level windows. </dd> <dt><b>Returns</b></dt> <dd>Returns the number of top-level windows. This includes all top-level windows, regardless of whether they are iconized, visible, or active. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTopWindow" class="membertitle">getTopWindow</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="XTopWindow.html">XTopWindow</a></td> </tr> <tr> <td valign="top"><b>getTopWindow</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return a reference to the specified top-level window. Note that the number of top-level windows may change between a call to <a href="#getTopWindowCount()">getTopWindowCount()</a> and successive calls to this function. </dd> <dt><b>Parameter nIndex</b></dt> <dd>The index should be in the intervall from 0 up to but not including the number of top-level windows as returned by <a href="#getTopWindowCount()">getTopWindowCount()</a>. </dd> <dt><b>Returns</b></dt> <dd>The returned value is a valid reference to a top-level window. </dd> <dt><b>Throws</b></dt> <dd>IndexOutOfBoundsException when the specified index is outside the valid range. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getActiveTopWindow" class="membertitle">getActiveTopWindow</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="XTopWindow.html">XTopWindow</a></td> </tr> <tr> <td valign="top"><b>getActiveTopWindow</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Return the currently active top-level window, i.e. which has currently the input focus. </dd> <dt><b>Returns</b></dt> <dd>The returned reference may be empty when no top-level window is active. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addTopWindowListener" class="membertitle">addTopWindowListener</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>addTopWindowListener</b>(</td> <td valign="top">[in] <a href="XTopWindowListener.html">XTopWindowListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Add a new listener that is called for events that involve <a href="XTopWindow.html">XTopWindow</a>s. After having obtained the current list of exisiting top-level windows you can keep this list up-to-date by listening to opened or closed top-level windows. Wait for activations or deactivations of top-level windows to keep track of the currently active frame. </dd> <dt><b>Parameter xListener</b></dt> <dd>If this is a valid reference it is inserted into the list of listeners. It is the task of the caller to not register the same listener twice (otherwise that listener will be called twice.) </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeTopWindowListener" class="membertitle">removeTopWindowListener</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>removeTopWindowListener</b>(</td> <td valign="top">[in] <a href="XTopWindowListener.html">XTopWindowListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Remove the specified listener from the list of listeners. </dd> <dt><b>Parameter xListener</b></dt> <dd>If the reference is empty then nothing will be changed. If the listener has been registered twice (or more) then all refrences will be removed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addKeyHandler" class="membertitle">addKeyHandler</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>addKeyHandler</b>(</td> <td valign="top">[in] <a href="XKeyHandler.html">XKeyHandler</a></td> <td valign="bottom"> xHandler );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Add a new listener that is called on <a href="KeyEvent.html">KeyEvent</a>s. Every listener is given the opportunity to consume the event, i.e. prevent the not yet called listeners from being called. </dd> <dt><b>Parameter xHandler</b></dt> <dd>If this is a valid reference it is inserted into the list of handlers. It is the task of the caller to not register the same handler twice (otherwise that listener will be called twice.) </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeKeyHandler" class="membertitle">removeKeyHandler</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>removeKeyHandler</b>(</td> <td valign="top">[in] <a href="XKeyHandler.html">XKeyHandler</a></td> <td valign="bottom"> xHandler );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Remove the specified listener from the list of listeners. </dd> <dt><b>Parameter xHandler</b></dt> <dd>If the reference is empty then nothing will be changed. If the handler has been registered twice (or more) then all refrences will be removed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addFocusListener" class="membertitle">addFocusListener</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>addFocusListener</b>(</td> <td valign="top">[in] <a href="XFocusListener.html">XFocusListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Add a new listener that is called on <a href="FocusEvent.html">FocusEvent</a>s. Use this focus broadcaster to keep track of the object that currently has the input focus. </dd> <dt><b>Parameter xListener</b></dt> <dd>If this is a valid reference it is inserted into the list of listeners. It is the task of the caller to not register the same listener twice (otherwise that listener will be called twice.) </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeFocusListener" class="membertitle">removeFocusListener</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>removeFocusListener</b>(</td> <td valign="top">[in] <a href="XFocusListener.html">XFocusListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Remove the specified listener from the list of listeners. </dd> <dt><b>Parameter xListener</b></dt> <dd>If the reference is empty then nothing will be changed. If the listener has been registered twice (or more) then all refrences will be removed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="fireFocusGained" class="membertitle">fireFocusGained</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>fireFocusGained</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> source );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Broadcasts the a focusGained on all registered focus listeners </dd> <dt><b>Parameter source</b></dt> <dd>The object that has gained the input focus. It should implement ::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessible.html">XAccessible</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="fireFocusLost" class="membertitle">fireFocusLost</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>fireFocusLost</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/XInterface.html">XInterface</a></td> <td valign="bottom"> source );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Broadcasts the a focusGained on all registered focus listeners </dd> <dt><b>Parameter source</b></dt> <dd>The object that has lost the input focus. It should implement ::com::sun::star::<a href="../accessibility/module-ix.html">accessibility</a>::<a href="../accessibility/XAccessible.html">XAccessible</a>. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
1096
