<html> <head> <title>Interface XDockableWindow</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="XDockableWindow-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">unpublished </td> <td width="50%" class="title">interface XDockableWindow</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>specifies the docking interface for a window component. </dd> <dd><p>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. </p> </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="#addDockableWindowListener">addDockableWindowListener</a></td> <td class="imsum_right">adds a docking listener to the object. only a single listener may be registered at any time. </td> </tr> <tr> <td class="imsum_left"><a href="#removeDockableWindowListener">removeDockableWindowListener</a></td> <td class="imsum_right">removes the specified docking listener from the object. </td> </tr> <tr> <td class="imsum_left"><a href="#enableDocking">enableDocking</a></td> <td class="imsum_right">enable or disable docking, docking is disabled by default </td> </tr> <tr> <td class="imsum_left"><a href="#isFloating">isFloating</a></td> <td class="imsum_right">queries the current window state </td> </tr> <tr> <td class="imsum_left"><a href="#setFloatingMode">setFloatingMode</a></td> <td class="imsum_right">toggle between floating and docked state </td> </tr> <tr> <td class="imsum_left"><a href="#lock">lock</a></td> <td class="imsum_right">prevents the window from being undocked this has no effect if the window is floating </td> </tr> <tr> <td class="imsum_left"><a href="#unlock">unlock</a></td> <td class="imsum_right">enables undocking this has no effect if the window is floating </td> </tr> <tr> <td class="imsum_left"><a href="#isLocked">isLocked</a></td> <td class="imsum_right">queries the current locking state </td> </tr> <tr> <td class="imsum_left"><a href="#startPopupMode">startPopupMode</a></td> <td class="imsum_right">shows the window in a menu like style, i.e. without decoration a special indicator will allow for tearing off the window see <a href="XDockableWindowListener.html">XDockableWindowListener</a> for the corresponding events </td> </tr> <tr> <td class="imsum_left"><a href="#isInPopupMode">isInPopupMode</a></td> <td class="imsum_right">queries the current pop-up mode </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="addDockableWindowListener" class="membertitle">addDockableWindowListener</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">void</td> </tr> <tr> <td valign="top"><b>addDockableWindowListener</b>(</td> <td valign="top">[in] <a href="XDockableWindowListener.html">XDockableWindowListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds a docking listener to the object. only a single listener may be registered at any time. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeDockableWindowListener" class="membertitle">removeDockableWindowListener</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">void</td> </tr> <tr> <td valign="top"><b>removeDockableWindowListener</b>(</td> <td valign="top">[in] <a href="XDockableWindowListener.html">XDockableWindowListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes the specified docking listener from the object. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="enableDocking" class="membertitle">enableDocking</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">void</td> </tr> <tr> <td valign="top"><b>enableDocking</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bEnable );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>enable or disable docking, docking is disabled by default </dd> <dt><b>Parameter bEnable</b></dt> <dd><b>true</b> specifies that docking is enabled <b>false</b> specifies that docking is disabled and no <a href="XDockableWindowListener.html">XDockableWindowListener</a> will be called </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isFloating" class="membertitle">isFloating</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">boolean</td> </tr> <tr> <td valign="top"><b>isFloating</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>queries the current window state </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the window is floating <b>false</b> if the window is docked </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setFloatingMode" class="membertitle">setFloatingMode</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">void</td> </tr> <tr> <td valign="top"><b>setFloatingMode</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bFloating );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>toggle between floating and docked state </dd> <dt><b>Parameter bFloating</b></dt> <dd>specifies the new floating mode: <b>true</b> means floating, <b>false</b> means docked </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="lock" class="membertitle">lock</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">void</td> </tr> <tr> <td valign="top"><b>lock</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>prevents the window from being undocked this has no effect if the window is floating </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="unlock" class="membertitle">unlock</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">void</td> </tr> <tr> <td valign="top"><b>unlock</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>enables undocking this has no effect if the window is floating </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isLocked" class="membertitle">isLocked</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">boolean</td> </tr> <tr> <td valign="top"><b>isLocked</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>queries the current locking state </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the window is locked <b>false</b> if the window is not locked </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="startPopupMode" class="membertitle">startPopupMode</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">void</td> </tr> <tr> <td valign="top"><b>startPopupMode</b>(</td> <td valign="top">[in] <a href="Rectangle.html">Rectangle</a></td> <td valign="bottom"> WindowRect );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>shows the window in a menu like style, i.e. without decoration a special indicator will allow for tearing off the window see <a href="XDockableWindowListener.html">XDockableWindowListener</a> for the corresponding events </dd> <dt><b>Parameter WindowRect</b></dt> <dd>specifies the position and size of the pop-up window in frame coordinates </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isInPopupMode" class="membertitle">isInPopupMode</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">boolean</td> </tr> <tr> <td valign="top"><b>isInPopupMode</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>queries the current pop-up mode </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the window is in pop-up mode <b>false</b> if the window is not in pop-up mode </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "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 <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
