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

Class FocusChange

source code

            object --+    
                     |    
Base.AccessEngineEvent --+
                         |
                        FocusChange

Event that fires when the focused accessible 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, gained, **kwargs)
Stores the POR for the focused object and the type of focus event.		 source code
string
__str__(self)
Returns a human readable representation of this event including its name, its POR, and its type.		 source code
POR
getFocusPOR(self)
Returns the POR for this focus event.		 source code
dictionary
getDataForTask(self)
Fetches data out of this FocusChange for use by a Task.FocusTask.		 source code
boolean
execute(self, tier_manager, view_manager, **kwargs)
Contacts the TierManager so it can manage the focus change event.		 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 gained
Type of focus change: True if gained, False if lost

Inherited from Base.AccessEngineEvent: focused, por, priority

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, por, gained, **kwargs)
(Constructor)

source code 

Stores the POR for the focused object and the type of focus event.

Parameters:
  • por (POR) - Point-of-regard from the accessible that just got focus
  • gained (boolean) - Was focused gained or lost?
Overrides: Base.AccessEngineEvent.__init__

__str__(self)
(Informal representation operator)

source code 

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

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

getFocusPOR(self)

source code 

Returns the POR for this focus event. Used by Tier to maintain a focus POR.

Returns: POR
Point-of-regard for this focus event

getDataForTask(self)

source code 

Fetches data out of this FocusChange for use by a Task.FocusTask.

Returns: dictionary
Dictionary of parameters to be passed to a Task.FocusTask as follows:
  • por: The POR of the accessible in which the focus change occured
  • type: Whether focus was gained (True) or lost (False)
Overrides: Base.AccessEngineEvent.getDataForTask

execute(self, tier_manager, view_manager, **kwargs)

source code 

Contacts the TierManager so it can manage the focus 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
True if there is an active view, False if not to delay execution of this event until there is
Overrides: Base.AccessEngineEvent.execute

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