<html> <head> <title>Interface XUIElementFactory</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="XUIElementFactory-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">ui</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 XUIElementFactory</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies a user interface element factory that can create and initialize user interface elements. </dd> <dd><p> User interface element factories must be registered at a <a href="UIElementFactoryManager.html">UIElementFactoryManager</a> service to provide access to itself. Currently the following user interface element types are defined: <ul> <li><b>menubar</b>A configurable user interface element.</li> <li><b>popupmenu</b>A configurable user interface element.</li> <li><b>toolbar</b>A configurable user interface element.</li> <li><b>statusbar</b>A configurable user interface element.</li> <li><b>floater</b>A basic user interface element.</li> </ul> </p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 2.0</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="#createUIElement">createUIElement</a></td> <td class="imsum_right">creates a new instances of a specific user interface element. </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="createUIElement" class="membertitle">createUIElement</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="XUIElement.html">XUIElement</a></td> </tr> <tr> <td valign="top"><b>createUIElement</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ResourceURL,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a> ></td> <td valign="bottom"> Args )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a new instances of a specific user interface element. </dd> <dt><b>Parameter ResourceURL</b></dt> <dd>specifies which unique user interface element should be created by the factory. A resourcce URL must meet the following syntax: "private:resource/$type/$name. It is only allowed to use ascii characters for type and name. This argument must not be empty to have a working user interface element instance.The implementation can throw an ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if it doesn't know how to create the request user interface element. </dd> <dt><b>Parameter Args</b></dt> <dd>The following arguments are supported: <ul> <li><b>Frame</b><br> specifies the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XFrame.html">XFrame</a> instance to which the user interface element belongs to. To create a configurable user interface element the frame instance must contain a visible component. Otherwise it is not possible to determine the correct user interface configuration manager. This argument is <b>mandatory</b> to have a working configurable user interface element instance. </li> <li><b>Persistent</b><br>specifies if changes to a configurable user interface element should be persistent. This is an optional argument. The default value is <b>true</b>.</li> </ul> <p> An implementation is responsible to initialize every newly created user interface element if the necessary properties are provided. Especially it must connect a configurable user interface element to the correct user interface configuration manager. Without this connection the configurable user interface element cannot retrieve its structure data and changes to the user interface element structure won't be persistent. It is up to the implementation to throw an ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> if it cannot create a user interface element with the provided arguments. </dd> <dt><b>See also</b></dt> <dd><a href="ConfigurableUIElement.html">ConfigurableUIElement</a></dd> <dt><b>See also</b></dt> <dd><a href="UIElement.html">UIElement</a><br> </p> </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>