<html> <head> <title>Interface XDockableWindowListener</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="XDockableWindowListener-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 XDockableWindowListener</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XDockableWindowListener</strong> ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XEventListener.html">XEventListener</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XEventListener.html">XEventListener</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>base interface for all event listeners interfaces. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>makes it possible to receive docking events. </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="#startDocking">startDocking</a></td> <td class="imsum_right">is invoked when the docking procedure starts. </td> </tr> <tr> <td class="imsum_left"><a href="#docking">docking</a></td> <td class="imsum_right">is invoked during the docking procedure when the window has been moved. on return the DockingData must contain either the old tracking rectangle or a changed rectangle if required, additionally it must indicate if the window should be docked or floating Note: the tracking rectangle indicates to the user where the window would be placed if he releases the mouse. </td> </tr> <tr> <td class="imsum_left"><a href="#endDocking">endDocking</a></td> <td class="imsum_right">is invoked when the docking procedure ends. aWindowRect contains the new position and size of the window </td> </tr> <tr> <td class="imsum_left"><a href="#prepareToggleFloatingMode">prepareToggleFloatingMode</a></td> <td class="imsum_right">is invoked when the floating mode is about to be changed between floating and docked or vice versa if returned FALSE the floating mode will not be changed </td> </tr> <tr> <td class="imsum_left"><a href="#toggleFloatingMode">toggleFloatingMode</a></td> <td class="imsum_right">is invoked when the floating mode is changed between floating and docked or vice versa </td> </tr> <tr> <td class="imsum_left"><a href="#closed">closed</a></td> <td class="imsum_right">is invoked when the window was actively closed </td> </tr> <tr> <td class="imsum_left"><a href="#endPopupMode">endPopupMode</a></td> <td class="imsum_right">is invoked when the window currently is in popupmode and wants to be undocked or closed </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="startDocking" class="membertitle">startDocking</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>startDocking</b>(</td> <td valign="top">[in] <a href="DockingEvent.html">DockingEvent</a></td> <td valign="bottom"> e );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is invoked when the docking procedure starts. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="docking" class="membertitle">docking</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"><a href="DockingData.html">DockingData</a></td> </tr> <tr> <td valign="top"><b>docking</b>(</td> <td valign="top">[in] <a href="DockingEvent.html">DockingEvent</a></td> <td valign="bottom"> e );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is invoked during the docking procedure when the window has been moved. on return the DockingData must contain either the old tracking rectangle or a changed rectangle if required, additionally it must indicate if the window should be docked or floating Note: the tracking rectangle indicates to the user where the window would be placed if he releases the mouse. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endDocking" class="membertitle">endDocking</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>endDocking</b>(</td> <td valign="top">[in] <a href="EndDockingEvent.html">EndDockingEvent</a></td> <td valign="bottom"> e );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is invoked when the docking procedure ends. aWindowRect contains the new position and size of the window </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="prepareToggleFloatingMode" class="membertitle">prepareToggleFloatingMode</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>prepareToggleFloatingMode</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/EventObject.html">EventObject</a></td> <td valign="bottom"> e );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is invoked when the floating mode is about to be changed between floating and docked or vice versa if returned FALSE the floating mode will not be changed </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="toggleFloatingMode" class="membertitle">toggleFloatingMode</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>toggleFloatingMode</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/EventObject.html">EventObject</a></td> <td valign="bottom"> e );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is invoked when the floating mode is changed between floating and docked or vice versa </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="closed" class="membertitle">closed</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>closed</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/EventObject.html">EventObject</a></td> <td valign="bottom"> e );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is invoked when the window was actively closed </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endPopupMode" class="membertitle">endPopupMode</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>endPopupMode</b>(</td> <td valign="top">[in] <a href="EndPopupModeEvent.html">EndPopupModeEvent</a></td> <td valign="bottom"> e );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is invoked when the window currently is in popupmode and wants to be undocked or closed </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>