<html> <head> <title>Interface XSimpleTabController</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="XSimpleTabController-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">awt</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 XSimpleTabController</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies the basic operations for a tab controller, but does not require XControl as type of tabs. </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="#insertTab">insertTab</a></td> <td class="imsum_right">create a new tab and return an unique ID, which can be used further to adress this tab by using other methods of this interface. </td> </tr> <tr> <td class="imsum_left"><a href="#removeTab">removeTab</a></td> <td class="imsum_right">remove a tab with the given ID. </td> </tr> <tr> <td class="imsum_left"><a href="#setTabProps">setTabProps</a></td> <td class="imsum_right">change some properties of the specified tab. @descr Such properties can be: </td> </tr> <tr> <td class="imsum_left"><a href="#getTabProps">getTabProps</a></td> <td class="imsum_right">retrieve the set of properties for the specified tab. </td> </tr> <tr> <td class="imsum_left"><a href="#activateTab">activateTab</a></td> <td class="imsum_right">activate the specified tab. @descr The new tab will be activated and all listener will get an event describing this. Of course there will be an event too, which notify's listener about the deactivation of the last active tab. </td> </tr> <tr> <td class="imsum_left"><a href="#getActiveTabID">getActiveTabID</a></td> <td class="imsum_right">return the unique ID of the current active tab. @eturn [long] the ID of the active tab. </td> </tr> <tr> <td class="imsum_left"><a href="#addTabListener">addTabListener</a></td> <td class="imsum_right">register listener for inserting/removing tab's and changing her properties. </td> </tr> <tr> <td class="imsum_left"><a href="#removeTabListener">removeTabListener</a></td> <td class="imsum_right">deregister listener for inserting/removing tab's and changing her properties. </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="insertTab" class="membertitle">insertTab</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">long</td> </tr> <tr> <td valign="top"><b>insertTab</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>create a new tab and return an unique ID, which can be used further to adress this tab by using other methods of this interface. </dd> <dt><b>Returns</b></dt> <dd>[long an unique ID for this new tab. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeTab" class="membertitle">removeTab</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>removeTab</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> ID )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>remove a tab with the given ID. </dd> <dt><b>Parameter ID</b></dt> <dd>the ID of the tab, which should be removed. @throw [IndexOutOfBoundsException] if the specified ID isnt used inside this tab controller. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setTabProps" class="membertitle">setTabProps</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>setTabProps</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> ID,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/NamedValue.html">NamedValue</a> ></td> <td valign="bottom"> Properties )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>change some properties of the specified tab. @descr Such properties can be: </dd> <dd><table> <tr> <td><b>Property</b></td> <td><b>Type</b></td> <td><b>Description</b></td> </tr> <tr> <td>Title</td> <td>string</td> <td>the title of the tab, which is shown at the UI.</td> </tr> <tr> <td>Position</td> <td>int</td> <td>describe the order of this tab in relation to all other tabs inside this control.</td> </tr> </table> @attention Not all properties must be supported by all implementations of this interface. Of course some important ones should be handled by every implementation ... as e.g. "Title". </dd> <dt><b>Parameter ID</b></dt> <dd>the ID of the tab, which should be changed. @throw [IndexOutOfBoundsException] if the specified ID isnt used inside this tab controller. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTabProps" class="membertitle">getTabProps</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">sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/NamedValue.html">NamedValue</a> ></td> </tr> <tr> <td valign="top"><b>getTabProps</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> ID )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieve the set of properties for the specified tab. </dd> <dt><b>Parameter ID</b></dt> <dd>the ID of the tab. @throw [IndexOutOfBoundsException] if the specified ID isnt used inside this tab controller. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="activateTab" class="membertitle">activateTab</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>activateTab</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> ID )</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/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>activate the specified tab. @descr The new tab will be activated and all listener will get an event describing this. Of course there will be an event too, which notify's listener about the deactivation of the last active tab. </dd> <dt><b>Parameter ID</b></dt> <dd>the ID of the new active tab. @throw [IndexOutOfBoundsException] if the specified ID isnt used inside this tab controller. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getActiveTabID" class="membertitle">getActiveTabID</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">long</td> </tr> <tr> <td valign="top"><b>getActiveTabID</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>return the unique ID of the current active tab. @eturn [long] the ID of the active tab. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addTabListener" class="membertitle">addTabListener</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>addTabListener</b>(</td> <td valign="top">[in] <a href="XTabListener.html">XTabListener</a></td> <td valign="bottom"> Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>register listener for inserting/removing tab's and changing her properties. </dd> <dt><b>Parameter Listener</b></dt> <dd>the listener for registration. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeTabListener" class="membertitle">removeTabListener</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>removeTabListener</b>(</td> <td valign="top">[in] <a href="XTabListener.html">XTabListener</a></td> <td valign="bottom"> Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>deregister listener for inserting/removing tab's and changing her properties. </dd> <dt><b>Parameter Listener</b></dt> <dd>the listener for deregistration. </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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
1271
