Module AEInterfaces :: Class IItemNav

Class IItemNav

        object --+    
                 |    
AccAdapt.Interface --+
                     |
                    IItemNav

Provides methods for navigating items within accessible objects. The definition of an item is left up to the object implementing this interface.

Instance Methods

[hide private]

POR

getNextItem(only_visible=True)
Gets the next Item relative to the one indicated by the POR providing this interface.

source code

POR

getPrevItem(only_visible=True)
Gets the previous Item relative to the one indicated by the POR providing this interface.

source code

POR

getFirstItem(only_visible=True)
Gets the first Item relative to the one indicated by the POR providing this interface.

source code

POR

getLastItem(only_visible=True)
Gets the last Item relative to the one indicated by the POR providing this interface.

source code

POR

getAccAsItem(por)
Gets a POR to the child as an item of the subject rather than as a child of the subject.

source code

Inherited from AccAdapt.Interface: __new__

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

getNextItem(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 visible item in the same accessible

Raises:

IndexError - When there is no next visible item
LookupError - When lookup for the next item fails even though it may exist

getPrevItem(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 visible item in the same accessible

Raises:

IndexError - When there is no previous visible item
LookupError - When lookup for the previous item fails even though it may exist

getFirstItem(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 first visible item in the same accessible

Raises:

IndexError - When there is no last visible item
LookupError - When lookup for the last item fails even though it may exist

getLastItem(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 visible item in the same accessible

Raises:

LookupError - When lookup for the last item fails because it does not exist

getAccAsItem(por)

source code

Gets a POR to the child as an item of the subject rather than as a child of the subject.

Parameters:

por (POR) - Point of regard to a child of the subject

Returns: POR

Point of regard to an item of the subject

Raises:

LookupError - When lookup for the offset fails