Package muntjac :: Package event :: Module action :: Class Action
[hide private]
[frames] | no frames]

Class Action

source code

object --+
         |
        Action
Known Subclasses:

Implements the action framework. This class contains subinterfaces for action handling and listing, and for action handler registrations and unregistration.


Authors:
Vaadin Ltd., Richard Lincoln

Version: 1.1.2

Instance Methods [hide private]
 
__init__(self, caption, icon=None)
Constructs a new action with the given caption string and icon.
source code
 
__eq__(self, other) source code
 
getCaption(self)
Returns the action's caption.
source code
 
getIcon(self)
Returns the action's icon.
source code
 
setCaption(self, caption)
Sets the caption.
source code
 
setIcon(self, icon)
Sets the icon.
source code

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

Instance Variables [hide private]
  _caption
Action title.
  _icon
Action icon.
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, caption, icon=None)
(Constructor)

source code 

Constructs a new action with the given caption string and icon.

Parameters:
  • caption - the caption for the new action.
  • icon - the icon for the new action.
Overrides: object.__init__

getCaption(self)

source code 

Returns the action's caption.

Returns:
the action's caption as a string.

getIcon(self)

source code 

Returns the action's icon.

Returns:
the action's Icon.

setCaption(self, caption)

source code 

Sets the caption.

Parameters:
  • caption - the caption to set.

setIcon(self, icon)

source code 

Sets the icon.

Parameters:
  • icon - the icon to set.