Package AccessEngine :: Package AEWalkers :: Module AccessibleWalker :: Class AccessibleWalker

Class AccessibleWalker

   object --+    
            |    
Base.AEWalker --+
                |
               AccessibleWalker

Walks the accessible hierarchy exactly as it is presented. The walk order is an in-order traversal of the subtree of the accessible hierarchy rooted at a top-level window accessible. The subtree is assumed to have no loops, though logic could be added to detect them.

Instance Methods

[hide private]

2-tuple of AEPor, callable

_getFirstChild(self, por)
Gets the first child of the current accessible in the given AEPor.

source code

2-tuple of AEPor, callable

_getNextPeer(self, por)
Gets the next peer of the current accessible in the given AEPor.

source code

2-tuple of AEPor, callable

_getParentNextPeer(self, por)
Gets the parent accessible of the current accessible in the given AEPor.

source code

2-tuple of AEPor, callable

_getPrevPeer(self, por)
Gets the previous peer of the current accessible in the given AEPor.

source code

2-tuple of AEPor, callable

_getLastChild(self, por)
Gets the last child of the accessible in the given AEPor.

source code

2-tuple of AEPor, callable

_getParent(self, por)
Gets the parent accessible of the one in the given AEPor.

source code

AEPor

_getLastAcc(self, por)
Gets the last accessible of the given AEPor.

source code

AEPor or None

getNextPOR(self)
Gets the next AEPor in the walk order.

source code

AEPor or None

getPrevPOR(self)
Gets the previous AEPor in the walk order.

source code

AEPor

getParentPOR(self)
Returns: Point of regard to the parent of the current accessible or None if it does not exist

source code

AEPor

getFirstPOR(self)
Returns: Point of regard to the first accessible

source code

AEPor

getLastPOR(self)
Returns: Point of regard to the last accessible

source code

Inherited from Base.AEWalker: __init__, getCurrPOR

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

Instance Variables

[hide private]

Inherited from Base.AEWalker: por

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

_getFirstChild(self, por)

source code

Gets the first child of the current accessible in the given AEPor. Returns the child accessible if it exists. If it does not exist, returns the given AEPor and _getNextPeer as the method to call to continue the search.

Parameters:

por (AEPor) - Initial AEPor

Returns: 2-tuple of AEPor, callable

AEPor and the next method to call to continue the search, or AEPor and None to indicate the search is complete

_getNextPeer(self, por)

source code

Gets the next peer of the current accessible in the given AEPor. Returns the peer accessible if it exists, is visible, and is not trivial. If it does not exist, returns the given AEPor and _getParentNextPeer as the method to call to continue the search. If it is invisible, returns the peer AEPor and _getNextPeer as the method to call to continue the search. If it is trivial, returns the peer and _getFirstChild as the method to call to continue the search. If it is trivial, returns the child accessible and _getFirstChild as the method to call to continue the search.

Parameters:

por (AEPor) - Initial AEPor

Returns: 2-tuple of AEPor, callable

AEPor and the next method to call to continue the search, or AEPor and None to indicate the search is complete

_getParentNextPeer(self, por)

source code

Gets the parent accessible of the current accessible in the given AEPor. Returns the parent and _getNextPeer as the method to call to continue the search if the parent exists. Returns a sentinel (None, None) if there is no parent indicating the given AEPor is the root of the subtree containing the starting AEPor.

Parameters:

por (AEPor) - Initial AEPor

Returns: 2-tuple of AEPor, callable

AEPor and the next method to call to continue the search, or AEPor and None to indicate the search is complete

_getPrevPeer(self, por)

source code

Gets the previous peer of the current accessible in the given AEPor. If it does not exist, returns the given AEPor and _getParent as the method to call to continue the search. If it is not visible, returns the peer accessible and _getPrevPeer as the method to call to continue the search. Otherwise, returns the peer accessible and _getLastChild as the method to call to continue the search.

Parameters:

por (AEPor) - Initial AEPor

Returns: 2-tuple of AEPor, callable

AEPor and the next method to call to continue the search, or AEPor and None to indicate the search is complete

_getLastChild(self, por)

source code

Gets the last child of the accessible in the given AEPor. If it does not exist, checks if the given AEPor is invisible or trivial. If so, returns the given AEPor and _getPrevPeer to continue the search. If not, returns a AEPor to the last item in the given AEPor as the result.

If the last child does exist, checks if it is visible. If so, returns the child and _getLastChild to continue the search. If not, returns the child and _getPrevPeer to continue the search.

Parameters:

por (AEPor) - Initial AEPor

Returns: 2-tuple of AEPor, callable

AEPor and the next method to call to continue the search, or AEPor and None to indicate the search is complete

_getParent(self, por)

source code

Gets the parent accessible of the one in the given AEPor. Returns the last item in the parent if it exists. If it does not exist, Returns a sentinel (None, None) indicating the given AEPor is the root of the subtree containing the starting AEPor. If the parent is invisible or trivial, returns the parent and _getPrevPeer as the method to call to continue the search.

Parameters:

por (AEPor) - Initial AEPor

Returns: 2-tuple of AEPor, callable

AEPor and the next method to call to continue the search, or AEPor and None to indicate the search is complete, or None and None to indicate we're at the root

_getLastAcc(self, por)

source code

Gets the last accessible of the given AEPor. Returns the given AEPor if any errors occur.

Parameters:

por (AEPor) - Initial AEPor

Returns: AEPor

AEPor pointing to the last accessible in the given AEPor

getNextPOR(self)

source code

Gets the next AEPor in the walk order. Calls _getFirstChild, _getNextPeer, and _getParentNextPeer to attempt to get the next valid AEPor. Each method determines whether the AEPor is valid as the next AEPor, and, if not, which call to make next. Each method potentially returns a AEPor and the next method to call to continue the search for the next AEPor.

Returns: AEPor or None: Next AEPor or None if this is the last AEPor
Overrides: Base.AEWalker.getNextPOR

getPrevPOR(self)

source code

Gets the previous AEPor in the walk order. Calls _getPrevPeer, _getLastChild, and _getParent to attempt to get the previous valid AEPor. Each method determines whether the AEPor is valid as the previous AEPor, and, if not, which call to make next. Each method potentially returns a AEPor and the next method to call to continue the search for the previous AEPor.

Returns: AEPor or None: Previous AEPor or None if this is the first AEPor
Overrides: Base.AEWalker.getPrevPOR

getParentPOR(self)

source code

Returns: AEPor: Point of regard to the parent of the current accessible or None if it does not exist
Overrides: Base.AEWalker.getParentPOR

getFirstPOR(self)

source code

Returns: AEPor: Point of regard to the first accessible
Overrides: Base.AEWalker.getFirstPOR

getLastPOR(self)

source code

Returns: AEPor: Point of regard to the last accessible
Overrides: Base.AEWalker.getLastPOR