<html> <head> <title>Interface XTableUIProvider</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="XTableUIProvider-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">sdb</a> :: <a href="module-ix.html" class="namechain">application</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 XTableUIProvider</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is used by the database application to obtain non-default user interface information and/or components for database tables. </dd> <dt><b/></dt> <dd/><dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../module-ix.html">sdb</a>::<a href="../Connection.html">Connection</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="#getTableIcon">getTableIcon</a></td> <td class="imsum_right">provides the icon which should be used to represent the table in the database application window. </td> </tr> <tr> <td class="imsum_left"><a href="#getTableEditor">getTableEditor</a></td> <td class="imsum_right">returns a component which can be used to edit the definition of an existing table. </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="getTableIcon" class="membertitle">getTableIcon</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="../../graphic/module-ix.html">graphic</a>::<a href="../../graphic/XGraphic.html">XGraphic</a></td> </tr> <tr> <td valign="top"><b>getTableIcon</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> TableName,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> ColorMode );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides the icon which should be used to represent the table in the database application window. </dd> <dd><p>The icon will usually be requested once per table, and cached. It might be requested again if the application settings change, for instance, if another desktop theme has been activated.</p> </dd> <dt><b>Parameter TableName</b></dt> <dd>denotes the fully qualified name of the database table. </dd> <dt><b>Parameter ColorMode</b></dt> <dd>denotes the color mode of the graphic to retrieve, being one of the ::com::sun::star::<a href="../../graphic/module-ix.html">graphic</a>::<a href="../../graphic/GraphicColorMode.html">GraphicColorMode</a> constants. </dd> <dt><b>Returns</b></dt> <dd>the icon which should be used to represent the table in the database application window, or <b>NULL</b> if the default icon should be used. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTableEditor" class="membertitle">getTableEditor</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="../../uno/module-ix.html">uno</a>::<a href="../../uno/XInterface.html">XInterface</a></td> </tr> <tr> <td valign="top"><b>getTableEditor</b>(</td> <td valign="top">[in] <a href="XDatabaseDocumentUI.html">XDatabaseDocumentUI</a></td> <td valign="bottom"> DocumentUI,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> TableName )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a component which can be used to edit the definition of an existing table. </dd> <dt><b>Parameter DocumentUI</b></dt> <dd>provides access to the UI in which the database document is currently displayed.<br/> In particular, this paramter provides access to the application's main window, which is needed in case the table editor should be a dialog. </dd> <dt><b>Parameter TableName</b></dt> <dd>denotes the fully qualified name of an existing table. </dd> <dt><b>Returns</b></dt> <dd>a component which can be used to edit the definition of an existing table, or <b>NULL</b> if the default component should be used.<br/> Two component types are supported so far <ul><li>modal dialogs<br/> If the returned component supports the ::com::sun::star::ui::<a href="../../ui/dialogs/module-ix.html">dialogs</a>::<a href="../../ui/dialogs/XExecutableDialog.html">XExecutableDialog</a> interface, the dialog will be executed modally.</li> <li>modeless frames<br/> If the returned component supports the ::com::sun::star::<a href="../../frame/module-ix.html">frame</a>::<a href="../../frame/XController.html">XController</a> interface, it is assumed that it represents a controller, loaded into a new frame, which is a modeless and, in its lifetime, depends on the application main window.</li> </ul> If the returned component does not support any of the above-mentioned interfaces, it's discarded. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if the given <arg>TableName</arg> does not denote an existing table </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::WrappedTargetException if an error occures while creating the table editor component. </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>