Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: 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 popup mode  
Methods' Details
addDockableWindowListener
void
addDockableWindowListener( [in] XDockableWindowListener  xListener );
Description
adds a docking listener to the object. only a single listener may be registered at any time.
removeDockableWindowListener
void
removeDockableWindowListener( [in] XDockableWindowListener  xListener );
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
boolean
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
void
lock();
Description
prevents the window from being undocked this has no effect if the window is floating
unlock
void
unlock();
Description
enables undocking this has no effect if the window is floating
isLocked
boolean
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 popup window in frame coordinates
isInPopupMode
boolean
isInPopupMode();
Description
queries the current popup mode
Returns
true if the window is in popup mode false if the window is not in popup mode
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.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.