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
- 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
- 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
- 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
- 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
- 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
- Description
- return the unique ID of the current active tab.
@eturn [long]
the ID of the active tab.
|
|
addTabListener
- Description
- register listener for inserting/removing tab's and changing her properties.
- Parameter Listener
- the listener for registration.
|
|
removeTabListener
- Description
- deregister listener for inserting/removing tab's and changing her properties.
- Parameter Listener
- the listener for deregistration.
|
|
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.