:: com :: sun :: star :: awt ::
|
unpublished |
interface XDockableWindow |
|
|
|
- Usage Restrictions
- not published
- Description
- specifies the docking interface for a window component.
A window can either be docked where it resides as a child window in
an application frame window or it can be floating where it will
reside in its own decorated top level window.
|
Methods' Summary |
addDockableWindowListener |
adds a docking listener to the object.
only a single listener may be registered at any time.
|
removeDockableWindowListener |
removes the specified docking listener from the object.
|
enableDocking |
enable or disable docking, docking is disabled by default
|
isFloating |
queries the current window state
|
setFloatingMode |
toggle between floating and docked state
|
lock |
prevents the window from being undocked
this has no effect if the window is floating
|
unlock |
enables undocking
this has no effect if the window is floating
|
isLocked |
queries the current locking state
|
startPopupMode |
shows the window in a menu like style, i.e. without decoration
a special indicator will allow for tearing off the window
see XDockableWindowListener for
the corresponding events
|
isInPopupMode |
queries the current pop-up mode
|
Methods' Details |
addDockableWindowListener
- Description
- adds a docking listener to the object.
only a single listener may be registered at any time.
|
|
removeDockableWindowListener
- Description
- removes the specified docking listener from the object.
|
|
enableDocking
void |
enableDocking( |
[in] boolean |
bEnable ); |
- Description
- enable or disable docking, docking is disabled by default
- Parameter bEnable
- true specifies that docking is enabled
false specifies that docking is disabled and no
XDockableWindowListener will be called
|
|
isFloating
- Description
- queries the current window state
- Returns
- true if the window is floating
false if the window is docked
|
|
setFloatingMode
void |
setFloatingMode( |
[in] boolean |
bFloating ); |
- Description
- toggle between floating and docked state
- Parameter bFloating
- specifies the new floating mode:
true means floating, false means docked
|
|
lock
- Description
- prevents the window from being undocked
this has no effect if the window is floating
|
|
unlock
- Description
- enables undocking
this has no effect if the window is floating
|
|
isLocked
- Description
- queries the current locking state
- Returns
- true if the window is locked
false if the window is not locked
|
|
startPopupMode
void |
startPopupMode( |
[in] Rectangle |
WindowRect ); |
- Description
- shows the window in a menu like style, i.e. without decoration
a special indicator will allow for tearing off the window
see XDockableWindowListener for
the corresponding events
- Parameter WindowRect
- specifies the position and size of the pop-up window in frame coordinates
|
|
isInPopupMode
- Description
- queries the current pop-up mode
- Returns
- true if the window is in pop-up mode
false if the window is not in pop-up mode
|
|
Top of Page
Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.
Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.