:: com :: sun :: star :: frame ::
|
interface XDesktop |
|
- Description
- This is the main interface of a desktop service.
A desktop is an environment for components which can be viewed in
frames. Frames are like frames in HTML framesets. This does not imply
that a desktop can handle framesets; the frames may be top frames
only.
- See also
- Desktop
- Developers Guide
- OfficeDev - Using the Desktop
|
Methods' Summary |
terminate |
tries to terminate the desktop.
|
addTerminateListener |
registers an event listener to the desktop, which is called
when the desktop is queried to terminate, and when it really
terminates.
|
removeTerminateListener |
unregisters an event listener for termination events.
|
getComponents |
provides read access to collection of all currently loaded components
inside the frame tree
|
getCurrentComponent |
provides read access to the component inside the tree which has the UI focus
|
getCurrentFrame |
provides read access to the frame wich contains the current component
|
Methods' Details |
terminate
|
addTerminateListener
- Description
- registers an event listener to the desktop, which is called
when the desktop is queried to terminate, and when it really
terminates.
- Parameter Listener
- listener for termination events
- See also
- XDesktop::removeTerminateListener()
|
|
removeTerminateListener
- Description
- unregisters an event listener for termination events.
- Parameter Listener
- listener which wish to be deregistered
- See also
- XDesktop::addTerminateListener()
|
|
getComponents
- Description
- provides read access to collection of all currently loaded components
inside the frame tree
The component is, by definition, the model of the control which
is loaded into a frame, or if no model exists, into the control
itself.
The service Components which is available from this
method is a collection of all components of the desktop which are open
within a frame of the desktop.
- Returns
- the collection of all components
- See also
- Components
|
|
getCurrentComponent
- Description
- provides read access to the component inside the tree which has the UI focus
Normally, the component is the model part of the
active component. If no model exists it is the active controller
(view) itself.
- Returns
- the component within the desktop environment which has the UI focus.
- See also
- XDesktop::getCurrentFrame()
|
|
getCurrentFrame
- Description
- provides read access to the frame wich contains the current component
- Returns
- the frame of the component which has the
UI focus within this desktop enviroment
- See also
- XDesktop::getCurrentComponent()
|
|
Top of Page
Copyright © 2013, 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.