Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 2853

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XPaneFactory</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="XPaneFactory-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"><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">drawing</a> :: <a href="module-ix.html" class="namechain">framework</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 XPaneFactory</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Factory and possibly cache for creating and releasing panes.
 </dd>
<dd><p>A pane factory is registered at and used by an
 <a href="XPaneController.html">XPaneController</a> object.</p>
 <p>A factory may want to implement a cache to reuse previously released
 panes.</p>
 </dd>
<dt><b>See also</b></dt>
<dd><a href="XPaneController.html">XPaneController</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="#createPane">createPane</a></td>
<td class="imsum_right">Create a pane for the given URL. When the pane is not used anymore
 then call <a href="#releasePane()">releasePane()</a>.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#releasePane">releasePane</a></td>
<td class="imsum_right">Call this method to tell a factory that the given pane is no longer
 in use in any configuration. The factory can decide whether to
 release its reference (and thus destroy the pane) or to keep it in a
 cache in order to reuse it later.
 &nbsp;</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="createPane" class="membertitle">createPane</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="XPane.html">XPane</a></td>
</tr>
<tr>
<td valign="top"><b>createPane</b>(</td>
<td valign="top">[in] <a href="XResourceId.html">XResourceId</a></td>
<td valign="bottom">&nbsp;xPaneId );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Create a pane for the given URL. When the pane is not used anymore
 then call <a href="#releasePane()">releasePane()</a>.
 </dd>
<dt><b>Parameter xPaneId</b></dt>
<dd>The resourc URL of this id specifies the type of pane to create.
 Valid values are those for which the factory has previously been
 registered at the <a href="XPaneController.html">XPaneController</a>.
 </dd>
<dt><b>Returns</b></dt>
<dd>Returns a pane object that has been just created or was taken
 from a cache. When specified pane object can not be
 created then an empty reference is returned. A later call may
 then be successfull. This, for example, can be the case with
 SFX based side panes. They are not available right after the
 creation of a new application frame.
 </dd>
<dt><b>Throws</b></dt>
<dd>InvalidArgumentException
 when the given URL is not supported by the factory.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="releasePane" class="membertitle">releasePane</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>releasePane</b>(</td>
<td valign="top">[in] <a href="XPane.html">XPane</a></td>
<td valign="bottom">&nbsp;xPane );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Call this method to tell a factory that the given pane is no longer
 in use in any configuration. The factory can decide whether to
 release its reference (and thus destroy the pane) or to keep it in a
 cache in order to reuse it later.
 </dd>
<dt><b>Parameter xPane</b></dt>
<dd>The given pane has to be one created by the same factory.
 </dd>
<dt><b>Throws</b></dt>
<dd>InvalidArgumentException
 when the given pane was not created by the same factory.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>