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

Class TabSheetTabImpl

source code

object --+    
         |    
      ITab --+
             |
            TabSheetTabImpl

TabSheet's implementation of ITab - tab metadata.

Instance Methods [hide private]
 
__init__(self, caption, icon, sheet)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
getCaption(self)
Returns the tab caption.
source code
 
setCaption(self, caption)
Sets 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
 
isEnabled(self)
Returns the enabled status for the tab.
source code
 
setEnabled(self, enabled)
Sets the enabled status for the tab.
source code
 
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
 
close(self) source code
 
getDescription(self)
Gets the description for the tab.
source code
 
setDescription(self, description)
Sets the description for the tab.
source code
 
getComponentError(self)
Gets the curent error message shown for the tab.
source code
 
setComponentError(self, componentError)
Sets an error indicator to be shown in the tab.
source code
 
getComponent(self)
Get the component related to the ITab
source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, caption, icon, sheet)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

getCaption(self)

source code 

Returns the tab caption. Can never be null.

Overrides: ITab.getCaption

setCaption(self, caption)

source code 

Sets the caption for the tab.

Parameters:
  • caption - the caption to set
Overrides: ITab.setCaption
(inherited documentation)

getIcon(self)

source code 

Gets the icon for the tab.

Overrides: ITab.getIcon
(inherited documentation)

setIcon(self, icon)

source code 

Sets the icon for the tab.

Parameters:
  • icon - the icon to set
Overrides: ITab.setIcon
(inherited documentation)

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
Overrides: ITab.isEnabled
(inherited documentation)

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
Overrides: ITab.setEnabled
(inherited documentation)

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
Overrides: ITab.isVisible
(inherited documentation)

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
Overrides: ITab.setVisible
(inherited documentation)

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
Overrides: ITab.isClosable
(inherited documentation)

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.
Overrides: ITab.setClosable
(inherited documentation)

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
Overrides: ITab.getDescription
(inherited documentation)

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.
Overrides: ITab.setDescription
(inherited documentation)

getComponentError(self)

source code 

Gets the curent error message shown for the tab.

Returns:
message or null if none
Overrides: ITab.getComponentError
(inherited documentation)

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
Overrides: ITab.setComponentError
(inherited documentation)

getComponent(self)

source code 

Get the component related to the ITab

Overrides: ITab.getComponent
(inherited documentation)