Trees       Indices       Help   
SUE - Revision 232
Package AccessEngine :: Package AEEvent :: Module TableChange :: Class TableChange
[hide private]
[frames] | no frames]

Class TableChange

source code

  object --+    
           |    
Base.AEEvent --+
               |
              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 AEPor, 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 AEPor, whether it concerns a row or col, whether it describes an add, remove, or move; the first affected child AEPor and the last affected child AEPor.		 source code
boolean
execute(self)
Contacts the AETierManager so it can manage the table change event.		 source code
dictionary
getDataForTask(self)
Fetches data out of this TableChange for use by a AEScript.EventScript.onTableChange-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]
boolean added
Was the row/col added (True), deleted (False), or moved (None)?
AEPor 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?
AEPor last_child_por
Point of regard of last added/removed/moved 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, is_row, added, first_child_por, last_child_por, **kwargs)
(Constructor)

source code 
Stores the AEPor, information about the change, and first and last children associated with the event.
Parameters:
  • por (AEPor) - 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 (AEPor) - Point of regard of first added/removed/moved child
  • last_child_por (AEPor) - Point of regard of last added/removed/moved child
Overrides: Base.AEEvent.__init__

__str__(self)
(Informal representation operator)

source code 
Returns a human readable representation of this event including its name, its AEPor, whether it concerns a row or col, whether it describes an add, remove, or move; the first affected child AEPor and the last affected child AEPor.
Returns: string
Information about this event
Overrides: Base.AEEvent.__str__

execute(self)

source code 
Contacts the AETierManager so it can manage the table 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 TableChange for use by a AEScript.EventScript.onTableChange-Task.
Returns: dictionary
Dictionary of parameters to be passed to a AEScript.EventScript.onTableChange-Task as follows:
  • por: The AEPor 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 AEPor of first added/removed/moved child
  • last_child_por: The AEPor of last added/removed/moved child
Overrides: Base.AEEvent.getDataForTask

   Trees       Indices       Help   
SUE - Revision 232
Generated by Epydoc 3.0beta1 on Mon Jun 30 13:05:55 2008 http://epydoc.sourceforge.net