Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: awt ::

interface XSimpleTabController
Description
specifies the basic operations for a tab controller, but does not require XControl as type of tabs.

Methods' Summary
insertTab 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.  
removeTab remove a tab with the given ID.  
setTabProps change some properties of the specified tab. @descr Such properties can be:  
getTabProps retrieve the set of properties for the specified tab.  
activateTab 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.  
getActiveTabID return the unique ID of the current active tab. @eturn [long] the ID of the active tab.  
addTabListener register listener for inserting/removing tab's and changing her properties.  
removeTabListener deregister listener for inserting/removing tab's and changing her properties.  
Methods' Details
insertTab
long
insertTab();

Description
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.
Returns
[long an unique ID for this new tab.
removeTab
void
removeTab( [in] long  ID )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
remove a tab with the given ID.
Parameter ID
the ID of the tab, which should be removed.
Throws
::com::sun::star::lang::IndexOutOfBoundsException if the specified ID isnt used inside this tab controller.
setTabProps
void
setTabProps( [in] long  ID,
[in] sequence< ::com::sun::star::beans::NamedValue >  Properties )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
change some properties of the specified tab. @descr Such properties can be:
Property Type Description
Title string the title of the tab, which is shown at the UI.
Position int describe the order of this tab in relation to all other tabs inside this control.
@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".
Parameter ID
the ID of the tab, which should be changed.
Throws
::com::sun::star::lang::IndexOutOfBoundsException if the specified ID isnt used inside this tab controller.
getTabProps
sequence< ::com::sun::star::beans::NamedValue >
getTabProps( [in] long  ID )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
retrieve the set of properties for the specified tab.
Parameter ID
the ID of the tab.
Throws
::com::sun::star::lang::IndexOutOfBoundsException if the specified ID isnt used inside this tab controller.
activateTab
void
activateTab( [in] long  ID )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
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.
Parameter ID
the ID of the new active tab.
Throws
::com::sun::star::lang::IndexOutOfBoundsException if the specified ID isnt used inside this tab controller.
getActiveTabID
long
getActiveTabID();

Description
return the unique ID of the current active tab. @eturn [long] the ID of the active tab.
addTabListener
void
addTabListener( [in] XTabListener  Listener );

Description
register listener for inserting/removing tab's and changing her properties.
Parameter Listener
the listener for registration.
removeTabListener
void
removeTabListener( [in] XTabListener  Listener );

Description
deregister listener for inserting/removing tab's and changing her properties.
Parameter Listener
the listener for deregistration.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.