Package AccessEngine :: Package AEEvent :: Module ChildrenChange :: Class ChildrenChange

Class ChildrenChange

  object --+    
           |    
Base.AEEvent --+
               |
              ChildrenChange

Event that fires on children 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, added, child_por, **kwargs)
Stores the AEPor, event name, first and last children (if any) associated with the event.

source code

string

__str__(self)
Returns a human readable representation of this event including its name, its AEPor, its event name, and its associated values.

source code

boolean

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

source code

dictionary

getDataForTask(self)
Fetches data out of this AEEvent.ChildrenChange for use by a AEScript.EventScript.onChildrenChange.

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]

boolean added
True when a child is added, False when removed

AEPor child_por
The AEPor of added/removed child

AEPor por
Point of regard associated with this event

Inherited from Base.AEEvent: layer, priority

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, por, added, child_por, **kwargs)
(Constructor)

source code

Stores the AEPor, event name, first and last children (if any) associated with the event.

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 event name, and its associated values.

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

execute(self)

source code

Contacts the AETierManager so it can manage the children 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 AEEvent.ChildrenChange for use by a AEScript.EventScript.onChildrenChange.

Returns: dictionary

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

por: The AEPor of the accessible parent
added: True when a child is added, False when removed
child_por: The AEPor of added/removed child

Overrides: Base.AEEvent.getDataForTask

Class ChildrenChange

__init__(self, por, added, child_por, **kwargs) (Constructor)

__str__(self) (Informal representation operator)

execute(self)

getDataForTask(self)

init(self, por, added, child_por, **kwargs)
(Constructor)

str(self)
(Informal representation operator)