Home | Trees | Indices | Help |
|
---|
|
object --+ | util.IEventListener --+ | terminal.paintable.IPaintable --+ | object --+ | | | terminal.variable_owner.IVariableOwner --+ | object --+ | | | terminal.sizeable.ISizeable --+ | component.IComponent --+ | object --+ | | | event.method_event_source.IMethodEventSource --+ | abstract_component.AbstractComponent --+ | object --+ | | | util.IEventListener --+ | | | terminal.paintable.IPaintable --+ | | | object --+ | | | | | terminal.variable_owner.IVariableOwner --+ | | | object --+ | | | | | terminal.sizeable.ISizeable --+ | | | component.IComponent --+ | | | component_container.IComponentContainer --+ | abstract_component_container.AbstractComponentContainer --+ | TabSheet
TabSheet component.
Tabs are typically identified by the component contained on the tab
(see ComponentContainer
), and tab metadata
(including caption, icon, visibility, enabledness, closability etc.) is
kept in separate {@link ITab} instances.
Tabs added with addComponent get the caption and the icon of the component at the time when the component is created, and these are not automatically updated after tab creation.
A tab sheet can have multiple tab selection listeners and one tab close handler (ICloseHandler), which by default removes the tab from the TabSheet.
The TabSheet can be styled with the .v-tabsheet,
.v-tabsheet-tabs and .v-tabsheet-content styles. Themes may also have
pre-defined variations of the tab sheet presentation, such as Reindeer.TABSHEET_BORDERLESS
, Runo.TABSHEET_SMALL
and several other styles in Reindeer.
The current implementation does not load the tabs to the UI before the first time they are shown, but this may change in future releases.
Version: 1.1.2
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from Inherited from Inherited from |
|
|||
CLIENT_WIDGET = None hash(x) |
|||
Inherited from Inherited from |
|
|||
_closeHandler Handler to be called when a tab is closed. |
|||
_components List of component tabs (tab contents). |
|||
_keyMapper Mapper between server-side component instances (tab contents) and |
|||
_paintedTabs Tabs that have been shown to the user (have been painted as |
|||
_selected Selected tab content component. |
|||
_tabs Map containing information related to the tabs (caption, icon etc). |
|||
_tabsHidden When true, the tab selection area is not displayed to the user. |
|||
Inherited from |
|
|||
Inherited from |
|
Constructs a new Tabsheet. Tabsheet is immediate by default, and the default close handler removes the tab being closed.
|
|
Adds a new tab into TabSheet. IComponent caption and icon are copied to the tab metadata at creation time.
See Also: addTab |
Adds a tab selection listener
|
Adds a new tab into TabSheet. The first tab added to a tab sheet is automatically selected and a tab selection event is fired. If the component is already present in the tab sheet, changes its caption and icon and returns the corresponding (old) tab, preserving other tab metadata.
|
Are the tab selection parts ("tabs") hidden.
|
Called when one or more variables handled by the implementing class are changed.
|
Gets the number of contained components (tabs). Consistent with the iterator returned by getComponentIterator.
|
Gets the component container iterator for going through all the components (tab contents).
|
Gets the selected tab content component.
|
Returns the ITab (metadata) for a component. The ITab object can be used for setting caption,icon, etc for the tab.
|
Gets tab caption. The tab is identified by the tab content component.
Deprecated: Use getTab and ITab.getCaption instead. |
Gets the icon for a tab. The tab is identified by the tab content component.
Deprecated: Use getTab and ITab.getIcon instead. |
Gets the position of the tab
|
Hides or shows the tab selection parts ("tabs").
|
Moves all components from another container to this container. The components are removed from the other container. If the source container is a TabSheet, component captions and icons are copied from it.
|
Paints the content of this component.
|
|
Removes a component and its corresponding tab. If the tab was selected, the first eligible (visible and enabled) remaining tab is selected.
|
Removes a tab selection listener
|
Removes a ITab and the component associated with it, as previously added with addTab, or addComponent. If the tab was selected, the first eligible (visible and enabled) remaining tab is selected.
|
Replaces a component (tab content) with another. This can be used to change tab contents or to rearrange tabs. The tab position and some metadata are preserved when moving components within the same TabSheet. If the oldComponent is not present in the tab sheet, the new one is added at the end. If the oldComponent is already in the tab sheet but the newComponent isn't, the old tab is replaced with a new one, and the caption and icon of the old one are copied to the new tab. If both old and new components are present, their positions are swapped.
|
Provide a custom ICloseHandler for this TabSheet if you wish to perform some additional tasks when a user clicks on a tabs close button, e.g. show a confirmation dialogue before removing the tab. To remove the tab, if you provide your own close handler, you must call removeComponent yourself. The default ICloseHandler for TabSheet will only remove the tab. |
Sets the selected tab. The tab is identified by the tab content component. |
Sets tab caption. The tab is identified by the tab content component.
Deprecated: Use getTab and ITab.setCaption instead. |
Sets icon for the given component. The tab is identified by the tab content component.
Deprecated: Use getTab and ITab.setIcon instead. |
Sets the position of the tab.
|
Checks if the current selection is valid, and updates the selection if the previously selected component is not visible and enabled. The first visible and enabled tab is selected if the current selection is empty or invalid. This method does not fire tab change events, but the caller should do so if appropriate.
|
|
_componentsList of component tabs (tab contents). In addition to being on this |
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Sat Aug 31 14:06:40 2013 | http://epydoc.sourceforge.net |