Task :: TableTask :: TableTask :: Class TableTask

Class TableTask

          object --+                    
                   |                    
Tools.Base.TaskTools --+                
                       |                
     Tools.Output.Output --+            
                           |            
          object --+       |            
                   |       |            
Tools.Base.TaskTools --+   |            
                       |   |            
       Tools.Input.Input --+            
                           |            
          object --+       |            
                   |       |            
Tools.Base.TaskTools --+   |            
                       |   |            
         Tools.View.View --+            
                           |            
          object --+       |            
                   |       |            
Tools.Base.TaskTools --+   |            
                       |   |            
       Tools.Utils.Utils --+            
                           |            
          object --+       |            
                   |       |            
Tools.Base.TaskTools --+   |            
                       |   |            
     Tools.System.System --+            
                           |            
                   Tools.All --+        
                               |        
                  object --+   |        
                           |   |        
               UIElement.UIE --+        
                               |        
                       Base.Task --+    
                                   |    
                 EventTask.EventTask --+
                                       |
                                      TableTask

Executed when a table change occurs (insert/delete/reorder of a row/column).

This class registers its name and whether it should be monitored by default in an AEMonitor using the Base.registerTaskType function when this module is first imported. The AEMonitor can use this information to build its menus.

Instance Methods

[hide private]

class

getEventType(self)
Returns: Type of AEEvent this Task wants to handle

source code

update(self, por, is_row, added, first_child_por, last_child_por, layer, **kwargs)
Updates this Task in response to a consumed table change event.

source code

boolean

execute(self, por, is_row, added, first_child_por, last_child_por, layer, **kwargs)
Executes this Task in response to a hierarchy change event.

source code

executeTableRowInserted(self, por, first_child_por, last_child_por, layer, **kwargs)
Executes this Task in response to a row-inserted table change event.

source code

executeTableRowDeleted(self, por, first_child_por, last_child_por, layer, **kwargs)
Executes this Task in response to a row-deleted table change event.

source code

executeTableRowReordered(self, por, layer, **kwargs)
Executes this Task in response to a row-reordered table change event.

source code

executeTableColumnInserted(self, por, first_child_por, last_child_por, layer, **kwargs)
Executes this Task in response to a column-inserted table change event.

source code

executeTableColumnDeleted(self, por, first_child_por, last_child_por, layer, **kwargs)
Executes this Task in response to a column-deleted table change event.

source code

executeTableColumnReordered(self, por, layer, **kwargs)
Executes this Task in response to a column-reordered table change event.

source code

Inherited from EventTask.EventTask: __init__, getEventLayers

Inherited from Base.Task: getIdentity, getPath, getPerk

Inherited from Tools.Output.Output: getBrlEllipsisSizes, getBrlMissingCellCount, getClosestLang, getMagROI, getOutputDevice, getPerkIdealOutput, getStyle, getStyleSetting, getStyleVal, inhibitMayStop, mayStop, play, say, sayApp, sayChar, sayColor, sayConfirm, sayCount, sayDesc, sayError, sayFont, sayHotkey, sayIndex, sayInfo, sayItem, sayLabel, sayLevel, sayName, sayRole, saySection, sayState, sayStatus, sayTextAttrs, sayValue, sayValueExtents, sayWindow, sayWord, send, setBrlCaretPosition, setBrlTruncate, setMagGoto, setPerkIdealOutput, setStyleVal, stopAll, stopNow

Inherited from Tools.Input.Input: addInputModifiers, getInputDevice, registerCommand, removeInputModifiers, unregisterCommand

Inherited from Tools.View.View: compareAncestorRoles, copyAccText, cutAccText, deleteAccText, deselectAccText, doAction, findAccByName, findAccByObjId, findAccByPredicate, findAccByRole, getAccActionDescs, getAccActionKeys, getAccActionNames, getAccAllTextAttrs, getAccAnchorCount, getAccAppLocale, getAccAtRowColumn, getAccAttrs, getAccCaret, getAccClickKey, getAccColumn, getAccColumnHeader, getAccCount, getAccDefTextAttrs, getAccDesc, getAccFloatValue, getAccFloatValueExtents, getAccFocus, getAccFromPath, getAccIndex, getAccLabel, getAccLevel, getAccName, getAccPosInSet, getAccPosition, getAccRelations, getAccRole, getAccRoleName, getAccRow, getAccRowHeader, getAccSetSize, getAccTableExtents, getAccText, getAccTextAttr, getAccTextBetween, getAccTextLength, getAccTextSelection, getAccTextSelectionCount, getAccURI, getAccVisualExtents, getAccVisualPoint, getAllSelected, getAppName, getCharText, getChildAcc, getCurrItem, getCurrRow, getCurrWord, getEndAcc, getEndOfHardLine, getFirstPeerAcc, getFirstSelected, getItemText, getLastAccUnder, getLastChar, getLastKey, getLastPeerAcc, getLastWord, getNextAcc, getNextChar, getNextItem, getNextPeerAcc, getNextRow, getNextWord, getParentAcc, getPointerPOR, getPrevAcc, getPrevChar, getPrevItem, getPrevPeerAcc, getPrevRow, getPrevWord, getRootAcc, getStartOfHardLine, getStateText, getViewRootAcc, getWindowTitle, getWordText, hasAccRole, hasAccState, hasOneAccRole, hasOneAccState, inhibitAutoPointer, insertAccText, iterAncestorAccs, iterNextAccs, iterNextItems, iterPrevAccs, iterPrevItems, leftClickPOR, mouseEventPOR, moveToEnd, moveToItemStart, moveToPOR, moveToPointer, moveToRoot, pasteAccText, selectAccText, setAccCaret, setAccDeselected, setAccFocus, setAccPOR, setAccSelected, setAccText, setAccTextAttrs, setAllDeselected, setAllSelected, setPointerPOR

Inherited from Tools.Utils.Utils: convertPOSIXToIANA, getColorString

Inherited from Tools.System.System: associateDevice, associateMonitor, associatePerk, blockNTasks, chainTask, disassociateDevice, disassociateMonitor, disassociatePerk, doTask, getAnchorPerkClassName, getAnchorTaskId, getChooserClassNames, getChooserDescriptions, getChooserMetadata, getChooserNames, getDeviceClassNames, getDeviceDescriptions, getDeviceMetadata, getDeviceNames, getDeviceState, getEventTasks, getHistory, getMonitorClassNames, getMonitorDescriptions, getMonitorMetadata, getMonitorNames, getNamedTask, getPerkByName, getPerkClassNames, getPerkDescriptions, getPerkHistory, getPerkMetadata, getPerkNames, getPerkSetting, getPerkSettingVal, getPerkState, getPerkTaskNames, getPerkVar, getProfileName, getTaskHistory, getTempVal, getTierEventTasks, getTierNamedTask, getTierTaskNames, insertPerk, loadAllMonitors, loadChooser, loadMonitor, popPerk, popThisPerk, pushPerk, refreshDevices, registerConstants, registerTask, reloadPerks, setPerkSettingVal, setPerkVar, setTempVal, unchainTask, unloadAllMonitors, unloadChooser, unloadMonitor, unregisterTask

Inherited from Tools.System.System (private): _getClassNames, _getDescriptions, _getNames, _getUIEInstances

Inherited from Tools.Base.TaskTools: close, init, postClose, postExecute, preExecute, preInit

Inherited from Tools.Base.TaskTools (private): _changeDefaultOutput

Inherited from UIElement.UIE: getClassName, getDescription, getName

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

Class Variables

[hide private]

Inherited from Tools.Output.Output: may_stop

Inherited from Tools.View.View (private): _state_descriptions

Instance Variables

[hide private]

Inherited from EventTask.EventTask: layers

Inherited from Base.Task: ident

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

getEventType(self)

source code

Returns: class: Type of AEEvent this Task wants to handle
Overrides: EventTask.EventTask.getEventType

update(self, por, is_row, added, first_child_por, last_child_por, layer, **kwargs)

source code

Updates this Task in response to a consumed table change event. Called by Tier.Tier._executeTask.

Parameters:

por (POR) - The POR for the related accessible
is_row (boolean) - True if a table row, False if a table column
added (boolean) - True when a row/column is added, False when removed, None when reordered
first_child_por (POR) - The POR of first inserted/deleted row/column
last_child_por (POR) - The POR of last inserted/deleted row/column
layer (integer) - Layer on which the event occurred

Overrides: Base.Task.update

execute(self, por, is_row, added, first_child_por, last_child_por, layer, **kwargs)

source code

Executes this Task in response to a hierarchy change event. Called by Tier.Tier._executeTask.

Parameters:

por (POR) - The POR for the related accessible
is_row (boolean) - True if a table row, False if a table column
added (boolean) - True when a row/column is added, False when removed, None when reordered
first_child_por (POR) - The POR of first inserted/deleted row/column
last_child_por (POR) - The POR of last inserted/deleted row/column
layer (integer) - Layer on which the event occurred

Returns: boolean

True to allow other Tasks to process this event

Overrides: Base.Task.execute

executeTableRowInserted(self, por, first_child_por, last_child_por, layer, **kwargs)

source code

Executes this Task in response to a row-inserted table change event. Called by execute.

Parameters:

por (POR) - The POR for the related accessible
first_child_por (POR) - The POR of first inserted row
last_child_por (POR) - The POR of last inserted row
layer (integer) - Layer on which the event occurred

executeTableRowDeleted(self, por, first_child_por, last_child_por, layer, **kwargs)

source code

Executes this Task in response to a row-deleted table change event. Called by execute.

Parameters:

por (POR) - The POR for the related accessible
first_child_por (POR) - The POR of first deleted row
last_child_por (POR) - The POR of last deleted row
layer (integer) - Layer on which the event occurred

executeTableRowReordered(self, por, layer, **kwargs)

source code

Executes this Task in response to a row-reordered table change event. Called by execute.

Parameters:

por (POR) - The POR for the related accessible
layer (integer) - Layer on which the event occurred

executeTableColumnInserted(self, por, first_child_por, last_child_por, layer, **kwargs)

source code

Executes this Task in response to a column-inserted table change event. Called by execute.

Parameters:

por (POR) - The POR for the related accessible
first_child_por (POR) - The POR of first inserted column
last_child_por (POR) - The POR of last inserted column
layer (integer) - Layer on which the event occurred

executeTableColumnDeleted(self, por, first_child_por, last_child_por, layer, **kwargs)

source code

Executes this Task in response to a column-deleted table change event. Called by execute.

Parameters:

por (POR) - The POR for the related accessible
first_child_por (POR) - The POR of first deleted column
last_child_por (POR) - The POR of last deleted column
layer (integer) - Layer on which the event occurred

executeTableColumnReordered(self, por, layer, **kwargs)

source code

Executes this Task in response to a column-reordered table change event. Called by execute.

Parameters:

por (POR) - The POR for the related accessible
layer (integer) - Layer on which the event occurred