Package AccessEngine :: Package AEEvent :: Module ChooserChange :: Class ChooserChange

Class ChooserChange

  object --+    
           |    
Base.AEEvent --+
               |
              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)
Contacts the AETierManager 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 AEScript.EventScript.onChooserChange.

source code

Inherited from Base.AEEvent: 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 AETier 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.AEEvent: layer, 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 AETier 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.AEEvent.__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.AEEvent.__str__

execute(self)

source code

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

Returns: boolean: True to indicate the event executed properly
Overrides: Base.AEEvent.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.AEEvent.getAppID

getDataForTask(self)

source code

Fetches data out of this ChooserChange for use by a AEScript.EventScript.onChooserChange.

Returns: dictionary

Dictionary of parameters to be passed to a AEScript.EventScript.onChooserChange as follows:

chooser: The chooser that fired the event
kind: The kind of event
any addition data in the kwargs instance variable

Overrides: Base.AEEvent.getDataForTask

Class ChooserChange

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

__str__(self) (Informal representation operator)

execute(self)

getTaskKey(self)

getAppID(self)

getDataForTask(self)

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

str(self)
(Informal representation operator)