Trees       Indices       Help   
Package Adapters :: Package ATSPI :: Module TreeAdapter :: Class TreeNavAdapter
[hide private]
[frames] | no frames]

Class TreeNavAdapter

source code

??-202 --+
         |
        TreeNavAdapter

Overrides DefaultNavAdapter to provide navigation over tree cells as items. Expects the subject to be a POR.

Adapts subject accessibles that provide the pyLinAcc.Interfaces.ITable interface and have ROLE_TREE_TABLE.

Instance Methods [hide private]
2-tuple of integer
_getVisibleItemExtents(self, only_visible)
Gets the item offsets of the first and last items in a tree of cells.		 source code
POR
getNextItem(self, only_visible=True)
Gets the next item relative to the one indicated by the POR providing this interface.		 source code
POR
getPrevItem(self, only_visible=True)
Gets the previous item relative to the one indicated by the POR providing this interface.		 source code
POR
getLastItem(self, only_visible=True)
Gets the last item relative to the one indicated by the POR providing this interface.		 source code
POR
getFirstItem(self, only_visible=True)
Gets the first item relative to the one indicated by the POR providing this interface.		 source code
 
getFirstAccChild(self)
Always raises LookupError.		 source code
 
getLastAccChild(self)
Always raises LookupError.		 source code
 
getChildAcc(self, index)
Always raises LookupError.		 source code
Static Methods [hide private]
boolean
when(subject)
Tests if the given subject can be adapted by this class.		 source code
Class Variables [hide private]
  provides = [IAccessibleNav, IItemNav]
Method Details [hide private]

when(subject)
Static Method

source code 

Tests if the given subject can be adapted by this class.

Parameters:
  • subject (POR) - POR containing an accessible to test
Returns: boolean
True when the subject meets the condition named in the docstring for this class, False otherwise

_getVisibleItemExtents(self, only_visible)

source code 

Gets the item offsets of the first and last items in a tree of cells.

Parameters:
  • only_visible - Only consider the first and last cells visible in the tree (True) or the absolute first and last cells (False)?
Returns: 2-tuple of integer
First and last item offsets
Decorators:
  • @pyLinAcc.errorToLookupError
Raises:
  • LookupError - When the first or last item or parent accessible is not available

getNextItem(self, only_visible=True)

source code 

Gets the next item relative to the one indicated by the POR providing this interface.

Parameters:
  • only_visible (boolean) - True when Item in the returned POR must be visible
Returns: POR
Point of regard to the next item in the same accessible
Decorators:
  • @pyLinAcc.errorToLookupError
Raises:
  • IndexError - When there is no next item
  • LookupError - When lookup for the next item fails even though it may exist

getPrevItem(self, only_visible=True)

source code 

Gets the previous item relative to the one indicated by the POR providing this interface.

Parameters:
  • only_visible (boolean) - True when Item in the returned POR must be visible
Returns: POR
Point of regard to the previous item in the same accessible
Decorators:
  • @pyLinAcc.errorToLookupError
Raises:
  • IndexError - When there is no previous item
  • LookupError - When lookup for the previous item fails even though it may exist

getLastItem(self, only_visible=True)

source code 

Gets the last item relative to the one indicated by the POR providing this interface.

Parameters:
  • only_visible (boolean) - True when Item in the returned POR must be visible
Returns: POR
Point of regard to the last item in the same accessible
Decorators:
  • @pyLinAcc.errorToLookupError
Raises:
  • LookupError - When lookup for the last item fails even though it may exist

getFirstItem(self, only_visible=True)

source code 

Gets the first item relative to the one indicated by the POR providing this interface.

Parameters:
  • only_visible (boolean) - True when Item in the returned POR must be visible
Returns: POR
Point of regard to the last item in the same accessible
Decorators:
  • @pyLinAcc.errorToLookupError
Raises:
  • LookupError - When lookup for the last item fails even though it may exist

getFirstAccChild(self)

source code 

Always raises LookupError. Tables have items but no children.

Decorators:
  • @pyLinAcc.errorToLookupError
Raises:
  • LookupError - Always

getLastAccChild(self)

source code 

Always raises LookupError. Tables have items but no children.

Decorators:
  • @pyLinAcc.errorToLookupError
Raises:
  • LookupError - Always

getChildAcc(self, index)

source code 

Always raises LookupError. Tables have items but no children.

Decorators:
  • @pyLinAcc.errorToLookupError
Raises:
  • LookupError - Always

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