Package AEEvent :: Module TableChange :: Class TableChange

Class TableChange

            object --+    
                     |    
Base.AccessEngineEvent --+
                         |
                        TableChange

Event that fires when the rows and columns in a table change.

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, is_row, added, first_child_por, last_child_por, **kwargs)
Stores the POR, information about the change, and first and last children associated with the event.

source code

string

__str__(self)
Returns a human readable representation of this event including its name, its POR, whether it concerns a row or col, whether it describes an add, remove, or move; the first affected child POR and the last affected child POR.

source code

boolean

execute(self, tier_manager, **kwargs)
Contacts the TierManager so it can manage the table change event.

source code

dictionary

getDataForTask(self)
Fetches data out of this TableChange for use by a Task.TableTask.

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
Was the row/col added (True), deleted (False), or moved (None)?

POR first_child_por
Point of regard of first added/removed/moved child

boolean is_row
Is it a row (True) or column (False) that changed?

POR last_child_por
Point of regard of last added/removed/moved 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, is_row, added, first_child_por, last_child_por, **kwargs)
(Constructor)

source code

Stores the POR, information about the change, and first and last children associated with the event.

Parameters:

por (POR) - Point of regard for the table
is_row (boolean) - Is it a row (True) or column (False) that changed?
added (boolean) - Was the row/col added (True), deleted (False), or moved (None)?
first_child_por (POR) - Point of regard of first added/removed/moved child
last_child_por (POR) - Point of regard of last added/removed/moved child

Overrides: Base.AccessEngineEvent.__init__

str(self)
(Informal representation operator)

source code

Returns a human readable representation of this event including its name, its POR, whether it concerns a row or col, whether it describes an add, remove, or move; the first affected child POR and the last affected child POR.

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 table 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 TableChange for use by a Task.TableTask.

Returns: dictionary

Dictionary of parameters to be passed to a Task.TableTask as follows:

por: The POR of the accessible whose property changed
is_row: Row (True) or column (False) changes
added: Added (True), removed (False), or moved (None)
first_child_por: The PORof first added/removed/moved child
last_child_por: The POR of last added/removed/moved child

Overrides: Base.AccessEngineEvent.getDataForTask

Class TableChange

__init__(self, por, is_row, added, first_child_por, last_child_por, **kwargs) (Constructor)

__str__(self) (Informal representation operator)

execute(self, tier_manager, **kwargs)

getDataForTask(self)

init(self, por, is_row, added, first_child_por, last_child_por, **kwargs)
(Constructor)

str(self)
(Informal representation operator)