com.ibm.portal.state.accessors.navigationshift
Interface NavigationShiftAccessor

All Superinterfaces:

Accessor, Disposable, Identifiable

All Known Subinterfaces:

NavigationShiftAccessorController

public interface NavigationShiftAccessor
extends Accessor, Identifiable

Read-only interface to navigation shift information. Refers to the state of a navigation component which is rendered as a tabbed pane where not all panes can be displayed at the same time.

Since:

5.1

Method Summary

int	getLength() Returns the maximum number of tabs which can be displayed in the navigation pane at the same time.
int	getStartIndex() Returns the index of the first navigation tab being visible.

Methods inherited from interface com.ibm.portal.Disposable

dispose

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Method Detail

getStartIndex

int getStartIndex()

Returns the index of the first navigation tab being visible. Returns -1 if there is no navigation shift information available in the state holder this accessor operates on.

Returns:

The index of the first visible navigation tab. Method may return -1 to indicate that no navigation shift information can be found.

getLength

int getLength()

Returns the maximum number of tabs which can be displayed in the navigation pane at the same time. Returns -1 if no navigation shift information can be found in the state holder this accessor operates on.

Returns:

The number of navigation tabs which may be displayed. Method may return -1 to indicate that no navigation shift information can be found.