Package muntjac :: Package ui :: Module tab_sheet :: Class ITab
[hide private]
[frames] | no frames]

Class ITab

source code

object --+
         |
        ITab
Known Subclasses:

ITab meta-data for a component in a TabSheet.

The meta-data includes the tab caption, icon, visibility and enabledness, closability, description (tooltip) and an optional component error shown in the tab.

Tabs are identified by the component contained on them in most cases, and the meta-data can be obtained with TabSheet.getTab.

Instance Methods [hide private]
 
isVisible(self)
Returns the visible status for the tab.
source code
 
setVisible(self, visible)
Sets the visible status for the tab.
source code
 
isClosable(self)
Returns the closability status for the tab.
source code
 
setClosable(self, closable)
Sets the closability status for the tab.
source code
 
isEnabled(self)
Returns the enabled status for the tab.
source code
 
setEnabled(self, enabled)
Sets the enabled status for the tab.
source code
 
setCaption(self, caption)
Sets the caption for the tab.
source code
 
getCaption(self)
Gets the caption for the tab.
source code
 
getIcon(self)
Gets the icon for the tab.
source code
 
setIcon(self, icon)
Sets the icon for the tab.
source code
 
getDescription(self)
Gets the description for the tab.
source code
 
setDescription(self, description)
Sets the description for the tab.
source code
 
setComponentError(self, componentError)
Sets an error indicator to be shown in the tab.
source code
 
getComponentError(self)
Gets the curent error message shown for the tab.
source code
 
getComponent(self)
Get the component related to the ITab
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

isVisible(self)

source code 

Returns the visible status for the tab. An invisible tab is not shown in the tab bar and cannot be selected.

Returns:
true for visible, false for hidden

setVisible(self, visible)

source code 

Sets the visible status for the tab. An invisible tab is not shown in the tab bar and cannot be selected, selection is changed automatically when there is an attempt to select an invisible tab.

Parameters:
  • visible - true for visible, false for hidden

isClosable(self)

source code 

Returns the closability status for the tab.

Returns:
true if the tab is allowed to be closed by the end user, false for not allowing closing

setClosable(self, closable)

source code 

Sets the closability status for the tab. A closable tab can be closed by the user through the user interface. This also controls if a close button is shown to the user or not.

Note! Currently only supported by TabSheet, not Accordion.

Parameters:
  • closable - true if the end user is allowed to close the tab, false for not allowing to close. Should default to false.

isEnabled(self)

source code 

Returns the enabled status for the tab. A disabled tab is shown as such in the tab bar and cannot be selected.

Returns:
true for enabled, false for disabled

setEnabled(self, enabled)

source code 

Sets the enabled status for the tab. A disabled tab is shown as such in the tab bar and cannot be selected.

Parameters:
  • enabled - true for enabled, false for disabled

setCaption(self, caption)

source code 

Sets the caption for the tab.

Parameters:
  • caption - the caption to set

setIcon(self, icon)

source code 

Sets the icon for the tab.

Parameters:
  • icon - the icon to set

getDescription(self)

source code 

Gets the description for the tab. The description can be used to briefly describe the state of the tab to the user, and is typically shown as a tooltip when hovering over the tab.

Returns:
the description for the tab

setDescription(self, description)

source code 

Sets the description for the tab. The description can be used to briefly describe the state of the tab to the user, and is typically shown as a tooltip when hovering over the tab.

Parameters:
  • description - the new description string for the tab.

setComponentError(self, componentError)

source code 

Sets an error indicator to be shown in the tab. This can be used e.g. to communicate to the user that there is a problem in the contents of the tab.

Parameters:
  • componentError - error message or null for none

See Also: AbstractComponent.setComponentError

getComponentError(self)

source code 

Gets the curent error message shown for the tab.

Returns:
message or null if none

See Also: AbstractComponent.setComponentError