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

Class ChildrenChange

source code

            object --+    
                     |    
Base.AccessEngineEvent --+
                         |
                        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 POR, 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 POR, its event name, and its associated values.		 source code
boolean
execute(self, tier_manager, **kwargs)
Contacts the TierManager so it can manage the children change event.		 source code
dictionary
getDataForTask(self)
Fetches data out of this AEEvent.ChildrenChange for use by a Task.ChildrenTask.		 source code

Inherited from Base.AccessEngineEvent: 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
POR child_por
The POR of added/removed child
POR por
Point of regard associated with this event

Inherited from Base.AccessEngineEvent: focused, priority

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

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

source code 

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

Overrides: Base.AccessEngineEvent.__init__

__str__(self)
(Informal representation operator)

source code 

Returns a human readable representation of this event including its name, its POR, its event name, and its associated values.

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

execute(self, tier_manager, **kwargs)

source code 

Contacts the TierManager so it can manage the children change event.

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

getDataForTask(self)

source code 

Fetches data out of this AEEvent.ChildrenChange for use by a Task.ChildrenTask.

Returns: dictionary
Dictionary of parameters to be passed to a Task.ChildrenTask as follows:
  • por: The POR of the accessible parent
  • added: True when a child is added, False when removed
  • child_por: The POR of added/removed child
Overrides: Base.AccessEngineEvent.getDataForTask

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