Methods' Summary |
getTopWindowCount |
This function returns the number of currently existing top-level
windows.
|
getTopWindow |
Return a reference to the specified top-level window. Note that the
number of top-level windows may change between a call to
getTopWindowCount() and successive calls to this
function.
|
getActiveTopWindow |
Return the currently active top-level window, i.e. which has
currently the input focus.
|
addTopWindowListener |
Add a new listener that is called for events that involve XTopWindows. 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.
|
removeTopWindowListener |
Remove the specified listener from the list of listeners.
|
addKeyHandler |
Add a new listener that is called on KeyEvents. Every listener is
given the opportunity to consume the event, i.e. prevent the not yet
called listeners from being called.
|
removeKeyHandler |
Remove the specified listener from the list of listeners.
|
addFocusListener |
Add a new listener that is called on FocusEvents. Use this focus
broadcaster to keep track of the object that currently has the input
focus.
|
removeFocusListener |
Remove the specified listener from the list of listeners.
|
fireFocusGained |
Broadcasts the a focusGained on all registered focus listeners
|
fireFocusLost |
Broadcasts the a focusGained on all registered focus listeners
|
Methods' Details |
getTopWindowCount
long |
getTopWindowCount(); |
- Description
- This function returns the number of currently existing top-level
windows.
- Returns
- Returns the number of top-level windows. This includes all
top-level windows, regardless of whether they are iconized,
visible, or active.
|
|
getTopWindow
- Description
- Return a reference to the specified top-level window. Note that the
number of top-level windows may change between a call to
getTopWindowCount() and successive calls to this
function.
- Parameter nIndex
- The index should be in the intervall from 0 up to but not
including the number of top-level windows as returned by
getTopWindowCount().
- Returns
- The returned value is a valid reference to a top-level window.
- Throws
- IndexOutOfBoundsException
when the specified index is outside the valid range.
|
|
getActiveTopWindow
- Description
- Return the currently active top-level window, i.e. which has
currently the input focus.
- Returns
- The returned reference may be empty when no top-level window is
active.
|
|
addTopWindowListener
- Description
- Add a new listener that is called for events that involve XTopWindows. 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.
- Parameter xListener
- 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.)
|
|
removeTopWindowListener
- Description
- Remove the specified listener from the list of listeners.
- Parameter xListener
- 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.
|
|
addKeyHandler
[oneway] void |
addKeyHandler( |
[in] XKeyHandler |
xHandler ); |
- Description
- Add a new listener that is called on KeyEvents. Every listener is
given the opportunity to consume the event, i.e. prevent the not yet
called listeners from being called.
- Parameter xHandler
- 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.)
|
|
removeKeyHandler
[oneway] void |
removeKeyHandler( |
[in] XKeyHandler |
xHandler ); |
- Description
- Remove the specified listener from the list of listeners.
- Parameter xHandler
- 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.
|
|
addFocusListener
- Description
- Add a new listener that is called on FocusEvents. Use this focus
broadcaster to keep track of the object that currently has the input
focus.
- Parameter xListener
- 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.)
|
|
removeFocusListener
- Description
- Remove the specified listener from the list of listeners.
- Parameter xListener
- 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.
|
|
fireFocusGained
[oneway] void |
fireFocusGained( |
[in] ::com::sun::star::uno::XInterface |
source ); |
- Description
- Broadcasts the a focusGained on all registered focus listeners
- Parameter source
- The object that has gained the input focus. It should implement
::com::sun::star::accessibility::XAccessible.
|
|
fireFocusLost
[oneway] void |
fireFocusLost( |
[in] ::com::sun::star::uno::XInterface |
source ); |
- Description
- Broadcasts the a focusGained on all registered focus listeners
- Parameter source
- The object that has lost the input focus. It should implement
::com::sun::star::accessibility::XAccessible.
|
|
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.