Sophie

Sophie

distrib > Mandriva > 2009.0 > i586 > by-pkgid > 561b71d6bc68fd08a952745d06b60112 > files > 2866

openoffice.org-devel-doc-3.1.1-0.4mdvmes5.1.i586.rpm

<html>
<head>
<title>Interface XResourceFactory</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="XResourceFactory-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">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 XResourceFactory</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 resources.
 </dd>
<dd><p>A resource factory is created and used by the
 <a href="XConfigurationController.html">XConfigurationController</a> object.</p>
 <p>A factory may want to implement a cache to reuse previously released
 resources.</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="#createResource">createResource</a></td>
<td class="imsum_right">Create a resource for the given <a href="XResourceId.html">XResourceId</a> object.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#releaseResource">releaseResource</a></td>
<td class="imsum_right">Call this method to tell a factory that the given resource is no
 longer in use. The factory can decide whether to destroy the
 resource 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="createResource" class="membertitle">createResource</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="XResource.html">XResource</a></td>
</tr>
<tr>
<td valign="top"><b>createResource</b>(</td>
<td valign="top">[in] <a href="XResourceId.html">XResourceId</a></td>
<td valign="bottom">&nbsp;xResourceId );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Create a resource for the given <a href="XResourceId.html">XResourceId</a> object.
 </dd>
<dt><b>Parameter xResourceId</b></dt>
<dd>The resourc URL of this id specifies the type of resource to
 create. The anchor can be used to obtain the associated object
 from the configuration controller. For example, when a view is
 created, then the new object can be initialized with the pane
 that is its anchor.
 <p>Valid values are those for which the factory has previously been
 registered at the <a href="XConfigurationController.html">XConfigurationController</a></p>.
 </dd>
<dt><b>Returns</b></dt>
<dd>Returns a resource object that has been just created or was
 taken from a cache. When the requested resource can not be
 created then an empty reference is returned. A later call may
 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="releaseResource" class="membertitle">releaseResource</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>releaseResource</b>(</td>
<td valign="top">[in] <a href="XResource.html">XResource</a></td>
<td valign="bottom">&nbsp;xResource );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Call this method to tell a factory that the given resource is no
 longer in use. The factory can decide whether to destroy the
 resource or to keep it in a cache in order to reuse it later.
 </dd>
<dt><b>Parameter xResource</b></dt>
<dd>The given resource 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; 2010 Sun Microsystems, Inc.</p>

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

</html>