<html> <head> <title>Interface XFrame</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="XFrame-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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">frame</a> :: </p> </td> </tr> <tr> <td class="title">interface XFrame</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XFrame</strong> ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</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/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>allows to exclicitly free resources and break cyclic references. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>a frame object can be considered to be an "anchor" object where a component can be attached to. </dd> <dd><p> A frame can be (it's not a must!) a part of a frame tree. If not this frame willn't be accessible by using the api. This mode make sense for previews. The root node of the tree can be a <a href="Desktop.html">Desktop</a> implementation. </p> </dd> <dt><b>See also</b></dt> <dd><a href="Desktop.html">Desktop</a></dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Creating_Frames_Manually#Frame_Creation">OfficeDev - Creating Frames Manually - Frame Creation</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Frames#Linking_Components_and_Windows">OfficeDev - Frames - Linking Components and Windows</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Component/Frames#Frame_Setup">OfficeDev - Component - Frames - XFrame - Frame Setup</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Component/Getting_Frames%2C_Controllers_and_Models_from_Each_Other">OfficeDev - Component - Getting Frames, Controllers and Models from Each Other</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Frame-Controller-Model_Paradigm_in_OpenOffice.org">OfficeDev - Frame-Controller-Model Paradigm in OpenOffice.org</a></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="#initialize">initialize</a></td> <td class="imsum_right">is called to initialize the frame within a window - the container window. </td> </tr> <tr> <td class="imsum_left"><a href="#getContainerWindow">getContainerWindow</a></td> <td class="imsum_right">provides access to the container window of the frame. </td> </tr> <tr> <td class="imsum_left"><a href="#setCreator">setCreator</a></td> <td class="imsum_right">sets the frame container that created this frame. </td> </tr> <tr> <td class="imsum_left"><a href="#getCreator">getCreator</a></td> <td class="imsum_right">provides access to the creator (parent) of this frame </td> </tr> <tr> <td class="imsum_left"><a href="#getName">getName</a></td> <td class="imsum_right">access to the name property of this frame </td> </tr> <tr> <td class="imsum_left"><a href="#setName">setName</a></td> <td class="imsum_right">sets the name of the frame. </td> </tr> <tr> <td class="imsum_left"><a href="#findFrame">findFrame</a></td> <td class="imsum_right">searches for a frame with the specified name. </td> </tr> <tr> <td class="imsum_left"><a href="#isTop">isTop</a></td> <td class="imsum_right">determines if the frame is a top frame. </td> </tr> <tr> <td class="imsum_left"><a href="#activate">activate</a></td> <td class="imsum_right">activates this frame and thus the component within. </td> </tr> <tr> <td class="imsum_left"><a href="#deactivate">deactivate</a></td> <td class="imsum_right">is called by the creator frame when another sub-frame gets activated. </td> </tr> <tr> <td class="imsum_left"><a href="#isActive">isActive</a></td> <td class="imsum_right">determines if the frame is active. </td> </tr> <tr> <td class="imsum_left"><a href="#setComponent">setComponent</a></td> <td class="imsum_right">sets a new component into the frame or release an existing one from a frame. </td> </tr> <tr> <td class="imsum_left"><a href="#getComponentWindow">getComponentWindow</a></td> <td class="imsum_right">provides access to the component window </td> </tr> <tr> <td class="imsum_left"><a href="#getController">getController</a></td> <td class="imsum_right">provides access to the controller </td> </tr> <tr> <td class="imsum_left"><a href="#contextChanged">contextChanged</a></td> <td class="imsum_right">notifies the frame that the context of the controller within this frame changed (i.e. the selection). </td> </tr> <tr> <td class="imsum_left"><a href="#addFrameActionListener">addFrameActionListener</a></td> <td class="imsum_right">registers an event listener, which will be called when certain things happen to the components within this frame or within sub-frames of this frame. </td> </tr> <tr> <td class="imsum_left"><a href="#removeFrameActionListener">removeFrameActionListener</a></td> <td class="imsum_right">unregisters an event listener </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="initialize" class="membertitle">initialize</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>initialize</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xWindow );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is called to initialize the frame within a window - the container window. </dd> <dd><p> This window will be used as parent for the component window and to support some UI relevant features of the frame service. Note: Re-parenting mustn't supported by a real frame implementation! It's designed for initializing - not for setting. </p> <p>This frame will take over ownership of the window refered from <var>xWindow</var>. Thus, the previous owner is not allowed to dispose this window anymore. </p> </dd> <dt><b>Parameter xWindow</b></dt> <dd>the new container window </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#getContainerWindow">getContainerWindow()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getContainerWindow" class="membertitle">getContainerWindow</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">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> </tr> <tr> <td valign="top"><b>getContainerWindow</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides access to the container window of the frame. </dd> <dd><p> Normally this is used as the parent window of the component window. </p> </dd> <dt><b>Returns</b></dt> <dd>the container window of this frame </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#initialize">initialize()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setCreator" class="membertitle">setCreator</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">[oneway] void</td> </tr> <tr> <td valign="top"><b>setCreator</b>(</td> <td valign="top">[in] <a href="XFramesSupplier.html">XFramesSupplier</a></td> <td valign="bottom"> Creator );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the frame container that created this frame. </dd> <dd><p> Only the creator is allowed to call this method. But creator doesn't mean the implementation which creates this instance ... it means the parent frame of the frame hierarchy. Because; normaly a frame should be created by using the api and is neccessary for searches inside the tree (e.g. <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#findFrame">findFrame()</a>) </p> </dd> <dt><b>Parameter Creator</b></dt> <dd>the creator (parent) of this frame </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#getCreator">getCreator()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCreator" class="membertitle">getCreator</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="XFramesSupplier.html">XFramesSupplier</a></td> </tr> <tr> <td valign="top"><b>getCreator</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides access to the creator (parent) of this frame </dd> <dt><b>Returns</b></dt> <dd>the frame container that created and contains this frame. </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#setCreator">setCreator()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getName" class="membertitle">getName</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">string</td> </tr> <tr> <td valign="top"><b>getName</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>access to the name property of this frame </dd> <dt><b>Returns</b></dt> <dd>the programmatic name of this frame. </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#setName">setName()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setName" class="membertitle">setName</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">[oneway] void</td> </tr> <tr> <td valign="top"><b>setName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the name of the frame. </dd> <dd><p> Normally the name of the frame is set initially (e.g. by the creator). The name of a frame will be used for identifying it if a frame search was started. These searches can be forced by: <ul> <li><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#findFrame">findFrame()</a> <li><a href="XDispatchProvider.html">XDispatchProvider</a>::<a href="XDispatchProvider.html#queryDispatch">queryDispatch()</a> <li><a href="XComponentLoader.html">XComponentLoader</a>::<a href="XComponentLoader.html#loadComponentFromURL">loadComponentFromURL()</a> </ul> Note: Special targets like "_blank", "_self" etc. are not allowed. That's why frame names shouldn't start with a sign "_". </p> </dd> <dt><b>Parameter aName</b></dt> <dd>the new programmatic name of this frame </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#findFrame">findFrame()</a>, <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#getName">getName()</a>, <a href="XDispatchProvider.html">XDispatchProvider</a>, <a href="XComponentLoader.html">XComponentLoader</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="findFrame" class="membertitle">findFrame</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="XFrame.html">XFrame</a></td> </tr> <tr> <td valign="top"><b>findFrame</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aTargetFrameName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nSearchFlags );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>searches for a frame with the specified name. </dd> <dd><p> Frames may contain other frames (e.g., a frameset) and may be contained in other frames. This hierarchy is searched with this method. First some special names are taken into account, i.e. "", "_self", "_top", "_blank" etc. <var>SearchFlags</var> is ignored when comparing these names with <var>TargetFrameName</var>; further steps are controlled by <var>SearchFlags</var>. If allowed, the name of the frame itself is compared with the desired one, and then ( again if allowed ) the method is called for all children of the frame. Finally may be called for the siblings and then for parent frame (if allowed). </p> <p> List of special target names: <table border=1> <tr><td>""/"_self"</td><td>address the starting frame itself</td></tr> <tr><td>"_parent"</td><td>address the direct parent frame only</td></tr> <tr><td>"_top"</td><td>address the top frame of this subtree of the frametree</td></tr> <tr><td>"_blank"</td><td>creates a new top frame</td></tr> </table> </p> <p> If no frame with the given name is found, a new top frame is created; if this is allowed by a special flag <b>FrameSearchFlag::CREATE</b>. The new frame also gets the desired name. </p> </dd> <dt><b>Parameter aTargetFrameName</b></dt> <dd>identify <ul><li>(a) a special target ("_blank","_self" ...) or</li> <li>(b) any well known frame</li><ul> to search it inside the current hierarchy </dd> <dt><b>Parameter nSearchFlags</b></dt> <dd>optional parameter to regulate search if no special target was used for <var>TargetFrameName</var> </dd> <dt><b>See also</b></dt> <dd><a href="FrameSearchFlag.html">FrameSearchFlag</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isTop" class="membertitle">isTop</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>isTop</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines if the frame is a top frame. </dd> <dd><p> In general a top frame is the frame which is a direct child of a task frame or which does not have a parent. Possible frame searches must stop the search at such a frame unless the flag <b>FrameSearchFlag::TASKS</b> is set. </p> </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if frame supports top frame specification <br> <b>false</b> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="activate" class="membertitle">activate</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">[oneway] void</td> </tr> <tr> <td valign="top"><b>activate</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>activates this frame and thus the component within. </dd> <dd><p> At first the frame sets itself as the active frame of its creator by calling <a href="XFramesSupplier.html">XFramesSupplier</a>::<a href="XFramesSupplier.html#setActiveFrame">setActiveFrame()</a>, then it broadcasts an <a href="FrameActionEvent.html">FrameActionEvent</a> with <b>FrameAction::FRAME_ACTIVATED</b>. The component within this frame may listen to this event to grab the focus on activation; for simple components this can be done by the <a href="FrameLoader.html">FrameLoader</a>. </p> <p> Finally, most frames may grab the focus to one of its windows or forward the activation to a sub-frame. </p> </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#deactivate">deactivate()</a>, <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#isActive">isActive()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="deactivate" class="membertitle">deactivate</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">[oneway] void</td> </tr> <tr> <td valign="top"><b>deactivate</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>is called by the creator frame when another sub-frame gets activated. </dd> <dd><p> At first the frame deactivates its active sub-frame, if any. Then broadcasts a <a href="FrameActionEvent.html">FrameActionEvent</a> with <b>FrameAction::FRAME_DEACTIVATING</b>. </p> </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#activate">activate()</a>, <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#isActive">isActive()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isActive" class="membertitle">isActive</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>isActive</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines if the frame is active. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> for active or UI active frames <br> <b>false</b> otherwise </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#activate">activate()</a>, <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#deactivate">deactivate()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setComponent" class="membertitle">setComponent</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>setComponent</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> <td valign="bottom"> xComponentWindow,</td> </tr> <tr> <td/><td valign="top">[in] <a href="XController.html">XController</a></td> <td valign="bottom"> xController );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a new component into the frame or release an existing one from a frame. </dd> <dt><b>Parameter xComponentWindow</b></dt> <dd>the window of the new component or <b>NULL</b> for release <p> A valid component window should be a child of the frame container window. </p> </dd> <dt><b>Parameter xController</b></dt> <dd>the controller of the new component or <b>NULL</b> for release <p> Simple components may implement a ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a> only. In this case no controller must be given here. </p> </dd> <dt><b>Returns</b></dt> <dd><b>true</b>if setting of new component or release of an existing one was successfully <br> <b>false</b> otherwise (especialy, if an existing controller disagree within his <a href="XController.html">XController</a>::<a href="XController.html#suspend">suspend()</a> call) </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#getComponentWindow">getComponentWindow()</a>, <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#getContainerWindow">getContainerWindow()</a>, <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#getController">getController()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getComponentWindow" class="membertitle">getComponentWindow</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">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/XWindow.html">XWindow</a></td> </tr> <tr> <td valign="top"><b>getComponentWindow</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides access to the component window </dd> <dd><p> Note: Don't dispose this window - the frame is the owner of it. </p> </dd> <dt><b>Returns</b></dt> <dd>the current visible component in this frame <br> or <b>NULL</b> if no one currently exist </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#setComponent">setComponent()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getController" class="membertitle">getController</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="XController.html">XController</a></td> </tr> <tr> <td valign="top"><b>getController</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides access to the controller </dd> <dd><p> Note: Don't dispose it - the frame is the owner of it. Use <a href="XController.html">XController</a>::<a href="XController.html#getFrame">getFrame()</a> to dispose the frame after you the controller agreed with a <a href="XController.html">XController</a>::<a href="XController.html#suspend">suspend()</a> call. </p> </dd> <dt><b>Returns</b></dt> <dd>the current controller within this frame <br> or <b>NULL</b> if no one currently exist </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#setComponent">setComponent()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="contextChanged" class="membertitle">contextChanged</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>contextChanged</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>notifies the frame that the context of the controller within this frame changed (i.e. the selection). </dd> <dd><p> According to a call to this interface, the frame calls <method>XFrameEventListener::frameAction</method> with <b>FrameAction::CONTEXT_CHANGED</b> to all listeners which are registered using <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#addFrameActionListener">addFrameActionListener</a>. For external controllers this event can be used to requery dispatches. </dd> <dt><b>See also</b></dt> <dd>XFrameEventListener, <a href="FrameAction.html">FrameAction</a>, <a href="XFrame.html">XFrame</a>::<a href="XFrame.html#addFrameActionListener">addFrameActionListener()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addFrameActionListener" class="membertitle">addFrameActionListener</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">[oneway] void</td> </tr> <tr> <td valign="top"><b>addFrameActionListener</b>(</td> <td valign="top">[in] <a href="XFrameActionListener.html">XFrameActionListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>registers an event listener, which will be called when certain things happen to the components within this frame or within sub-frames of this frame. </dd> <dd><p> E.g., it is possible to determine instantiation/destruction and activation/deactivation of components. </p> </dd> <dt><b>Parameter xListener</b></dt> <dd>specifies the listener which will be informed </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#removeFrameActionListener">removeFrameActionListener()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeFrameActionListener" class="membertitle">removeFrameActionListener</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">[oneway] void</td> </tr> <tr> <td valign="top"><b>removeFrameActionListener</b>(</td> <td valign="top">[in] <a href="XFrameActionListener.html">XFrameActionListener</a></td> <td valign="bottom"> xListener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>unregisters an event listener </dd> <dt><b>Parameter xListener</b></dt> <dd>specifies the listener which willn't be informed any longer </dd> <dt><b>See also</b></dt> <dd><a href="XFrame.html">XFrame</a>::<a href="XFrame.html#addFrameActionListener">addFrameActionListener()</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>