Package AccessEngine :: Package AEEvent :: Module StateChange :: Class StateChange

Class StateChange

  object --+    
           |    
Base.AEEvent --+
               |
              StateChange

Event that fires when the state of an accessible or item changes.

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, por, name, value, **kwargs)
Stores the AEPor, state name, and its new value.

source code

string

__str__(self)
Returns a human readable representation of this event including its name, its AEPor, its state name, and its new value.

source code

boolean

execute(self)
Contacts the AETierManager so it can manage the property change event.

source code

dictionary

getDataForTask(self)
Fetches data out of this StateChange for use by a AEScript.EventScript.onStateChange-Task.

source code

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

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

Instance Variables

[hide private]

string name
Name of the property that changed

string value
The new text associated with the property

Inherited from Base.AEEvent: layer, por, priority

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, por, name, value, **kwargs)
(Constructor)

source code

Stores the AEPor, state name, and its new value.

Parameters:

por (AEPor) - Point of regard to the accessible/item whose state changed
name (string) - Name of the state that changed
value (boolean) - New value of the state

Overrides: Base.AEEvent.__init__

str(self)
(Informal representation operator)

source code

Returns a human readable representation of this event including its name, its AEPor, its state name, and its new value.

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

execute(self)

source code

Contacts the AETierManager so it can manage the property change event.

Returns: boolean: Always True to indicate the event executed properly
Overrides: Base.AEEvent.execute

getDataForTask(self)

source code

Fetches data out of this StateChange for use by a AEScript.EventScript.onStateChange-Task.

Returns: dictionary

Dictionary of parameters to be passed to a AEScript.EventScript.onStateChange-Task as follows:

por: The AEPor of the accessible whose property changed
name: The text name of the property that changed
value: The new value of the state (True or False)

Overrides: Base.AEEvent.getDataForTask

Class StateChange

__init__(self, por, name, value, **kwargs) (Constructor)

__str__(self) (Informal representation operator)

execute(self)

getDataForTask(self)

init(self, por, name, value, **kwargs)
(Constructor)

str(self)
(Informal representation operator)