Module FirefoxScript :: Class FirefoxScript

Class FirefoxScript

                                  object --+            
                                           |            
AccessEngine.AEUserInterface.AEUserInterface --+        
                                               |        
                  AccessEngine.AEScript.AEScript --+    
                                                   |    
                   AccessEngine.AEScript.EventScript --+
                                                       |
                                                      FirefoxScript

Defines hotkeys to improve document browsing and chrome access for the Firefox web browser.

Flowcharts: Review task chaining: keyboard event -> BoundReview(All Review) -> HandleAutofocus -> ConvReviewReg. Convenience review chaining: keyboard event -> ConvReview -> BoundReview(All Review) -> HandleAutofocus -> ConvReviewReg. Review skip: ShouldSkip -> FFShouldSkip. Read role: ReadReviewRole(ReadNewRole)

Nested Classes

[hide private]

AEState class

STATE
Class to instantiate and use to store state information across all instances of this AEScript.

Instance Methods

[hide private]

init(self)
Does nothing.

source code

string

getName(self)
Returns: Human readable name of this object.

source code

string

getDescription(self)
Returns: Description of this component.

source code

Inherited from AccessEngine.AEScript.EventScript: chainNewEventTaskAround, executeAroundTask, onCaretChange, onCaretDeleted, onCaretInserted, onCaretMoved, onChildAdded, onChildRemoved, onChildrenChange, onChooserChange, onChooserEnd, onChooserSignal, onChooserStart, onFocusChange, onFocusGained, onFocusLost, onMouseChange, onMouseMoved, onMousePressed, onMouseReleased, onPropertyChange, onScreenChange, onScreenReflowed, onScreenRefreshed, onScreenResized, onSelectorActive, onSelectorAdded, onSelectorChange, onSelectorRemoved, onSelectorText, onStateChange, onTableChange, onTableColumnDeleted, onTableColumnInserted, onTableColumnReordered, onTableRowDeleted, onTableRowInserted, onTableRowReordered, onViewChange, onViewFirstGained, onViewGained, onViewLost, onViewStartup, registerEventTask, unregisterEventTask, updateAroundTask, updateOnCaretChange, updateOnChildrenChange, updateOnFocusChange, updateOnMouseChange, updateOnPropertyChange, updateOnScreenChange, updateOnSelectorChange, updateOnStateChange, updateOnTableChange, updateOnViewChange

Inherited from AccessEngine.AEScript.EventScript (private): _doReplacedTask

Inherited from AccessEngine.AEScript.AEScript: __init__, bindToEvent, chainTask, close, doCyclicInputTask, doTask, getAETier, getAnchorScriptClassName, getAnchorTaskId, getChainSegment, getChooserTask, getCommandTask, getEventTasks, getIdealOutput, getLastKey, getOutputDevices, getPointerPOR, getRegisteredTask, getScriptSetting, getScriptSettingVal, getState, getTaskKeys, getTempData, getVirtualPOR, mergeChain, postClose, preInit, registerChooserTask, registerCommand, registerCyclicInputTask, registerCyclicInputTasks, registerModifiers, registerTask, registerTimerTask, setIdealOutput, setPointerPOR, setScriptSettingVal, setTempData, setVirtualPOR, unbindFromEvent, unchainTask, unregisterChooserTask, unregisterCommand, unregisterCyclicInputTask, unregisterModifiers, unregisterTask, unregisterTaskFromCyclicInputTask, unregisterTimerTask

Inherited from AccessEngine.AEScript.AEScript (private): _changeDefaultOutput

Inherited from AccessEngine.AEUserInterface.AEUserInterface: getClassName, getPath

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

Class Variables

[hide private]

CONTAINERS_BY_ROLE = 'image', 'form', 'list', 'calendar', 'men...

TRIVIAL_WIDGETS = 'push button', '', 'document frame', 'check ...

tuple SKIPPED_ITEMS = ()
Additional items to be skipped when reviewing.

tuple SKIPPED_ROLES = ()
Additional roles to be skipped when reviewing.

dictionary WIDGET_ROLES
A dictionary where the keys are roles which will prevent the convenience review keys from being registered.

AEPor last_focus_por

Instance Variables

[hide private]

AEPor cached_pointer
AEPor saved during caret event.

boolean convkey_reg
Are convenience review keys registered?

integer currentmode
The current navigation mode.

dictionary doc_pors
Dictionary containing saved pors.

AEPor lastdocinfocus
AEPor saved during restoration routine to help differentiate tab browsing from Tab/Tab-Shift events.

lastporinfocus
AEPor saved during restoration routine to help differentiate tab browsing from Tab/Tab-Shift events.

boolean nav_element_reg
Are element navigation keys registered?

boolean viewlost
Flag that indicates a view lost event has just occurred.

Inherited from AccessEngine.AEScript.AEScript: after_chains, around_chains, around_tasks, before_chains, chooser_tasks, command_descriptions, commands, cyclic_input_tasks, def_out, event_tasks, out_caps, registered_modifiers, registered_tasks, state, tier

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self)

source code

Does nothing. Reserved for subclasses to initialize themselves.

Overrides: AccessEngine.AEScript.AEScript.init: (inherited documentation)

getName(self)

source code

Returns: string: Human readable name of this object. Defaults to its class name.
Overrides: AccessEngine.AEUserInterface.AEUserInterface.getName: (inherited documentation)

getDescription(self)

source code

Returns: string: Description of this component. Defaults to the first paragraph (all lines up to the first blank line) in its class docstring.
Overrides: AccessEngine.AEUserInterface.AEUserInterface.getDescription: (inherited documentation)

Class Variable Details

[hide private]

CONTAINERS_BY_ROLE

Value:

'image', 'form', 'list', 'calendar', 'menu', 'menu bar', 'page tab', '
tool bar', 'application', 'tree', 'tree table', 'entry'

TRIVIAL_WIDGETS

Value:

'push button', '', 'document frame', 'check box', 'image'

WIDGET_ROLES

A dictionary where the keys are roles which will prevent the convenience review keys from being registered. When a value is not None, it is a state that must be contained in this accessible's state set before convenience review keys are registered.

Type:: dictionary

Instance Variable Details

[hide private]

cached_pointer

AEPor saved during caret event. Used to restore POR during certain restoration scenerios involving chrome.

Type:: AEPor

doc_pors

Dictionary containing saved pors. Key is doc frame of web page to be restored.

Type:: dictionary

viewlost

Flag that indicates a view lost event has just occurred. Used during the saved AEPor restoration routine.

Type:: boolean