Trees       Indices       Help   
Package AEEvent :: Module ChooserChange :: Class ChooserChange
[hide private]
[frames] | no frames]

Class ChooserChange

source code

            object --+    
                     |    
Base.AccessEngineEvent --+
                         |
                        ChooserChange

Event that fires when a AEChooser indicates important input from a user.

This class registers its name and whether it should be monitored by default in an AEMonitor using the Base.registerEventType function when this module is first imported. The AEMonitor can use this information to build its menus.

Instance Methods [hide private]
 
__init__(self, aid, chooser, kind, **kwargs)
Stores important references.		 source code
string
__str__(self)
Returns a human readable representation of this event including its name, action, and chooser.		 source code
boolean
execute(self, tier_manager, **kwargs)
Contacts the TierManager and asks it to manage this chooser event.		 source code
integer
getTaskKey(self)
Gets the AEChooser ID that triggered this event.		 source code
opaque object
getAppID(self)
Returns: Unique application ID identifying the top most container for the source of this event (i.e.		 source code
dictionary
getDataForTask(self)
Fetches data out of this ChooserChange for use by a Task.ChooserTask.		 source code

Inherited from Base.AccessEngineEvent: getLayer, getPOR, getPriority, getTimestamp, setLayer, setPriority

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__

Instance Variables [hide private]
opaque aid
Unique identifier for the application Tier with which the AEChooser that fired this event is associated
AEChooser chooser
AEChooser that fired this event
integer kind
Kind of event, one of OK, CANCEL, or APPLY from AEChooser
dictionary kwargs
Aribitrary data to be passed to the handler of this event

Inherited from Base.AccessEngineEvent: focused, por, priority

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, aid, chooser, kind, **kwargs)
(Constructor)

source code 

Stores important references.

Parameters:
  • aid (opaque) - Unique identifier for the application Tier with which the AEChooser that fired this event is associated
  • chooser (AEChooser) - AEChooser that fired this event
  • kind (integer) - Kind of event, one of OK, CANCEL, or APPLY from AEChooser
Overrides: Base.AccessEngineEvent.__init__

__str__(self)
(Informal representation operator)

source code 

Returns a human readable representation of this event including its name, action, and chooser.

Returns: string
Information about this event
Overrides: Base.AccessEngineEvent.__str__

execute(self, tier_manager, **kwargs)

source code 

Contacts the TierManager and asks it to manage this chooser event.

Parameters:
  • tier_manager (TierManager) - TierManager that will handle the event
  • kwargs (dictionary) - Packed references to other managers not of interest here
Returns: boolean
True to indicate the event executed properly
Overrides: Base.AccessEngineEvent.execute

getTaskKey(self)

source code 

Gets the AEChooser ID that triggered this event. This information is used to locate the Task that should handle this event.

Returns: integer
ID of the chooser that fired the event

getAppID(self)

source code 
Returns: opaque object
Unique application ID identifying the top most container for the source of this event (i.e. the application)
Overrides: Base.AccessEngineEvent.getAppID

getDataForTask(self)

source code 

Fetches data out of this ChooserChange for use by a Task.ChooserTask.

Returns: dictionary
Dictionary of parameters to be passed to a Task.ChooserTask as follows:
  • chooser: The chooser that fired the event
  • kind: The kind of event
  • any addition data in the kwargs instance variable
Overrides: Base.AccessEngineEvent.getDataForTask

   Trees       Indices       Help   
Generated by Epydoc 3.0beta1 on Mon Jun 4 15:33:16 2007 http://epydoc.sourceforge.net