Class: GuideNavigationContext

GuideNavigationContext


new GuideNavigationContext()

Every Panel in Adaptive Form has a navigation context. The context keeps track of the current active item inside the Panel. An item is made active via the call to GuideBridge#setFocus API or clicking on the tabs (provided through wizard layout or tabbed layout) of a Panel.

This class provides APIs to get access to the current active Item, its siblings, first and last item of a Panel. The navigation context keeps the order of its children as per the Hierarchy of the form. The APIs provided by the context uses this order to return the element. Hidden elements are ignored in this order as if they do not exist

Since:
  • 6.0

Members


<readonly> firstItem :GuideNode

The child of the panel that is currently active.

When GuideBridge#setFocus is called or a tab (present in wizard or tabbed layout) is clicked then the element that is set to focus, then the field and all its parent upto the root panel are made active.

The Parent Panel of each active Element (except the root panel) stores its active child in this property.

Type:
Since:
  • 6.0

<readonly> prevItem :GuideNode

The previous sibling of the current active item in the hierarchical order

Type:
Since:
  • 6.0
See:
  • currentItem

<readonly> nextItem :GuideNode

The next sibling of the current active item in the hierarchical order

Type:
Since:
  • 6.0
See:
  • currentItem

<readonly> firstItem :GuideNode

The first child of the Panel as per the hierarchical order of its children.

Type:
Since:
  • 6.0

<readonly> lastItem :GuideNode

The last child of the Panel as per the hierarchical order of its children.

Type:
Since:
  • 6.0

<readonly> hasNextItem :boolean

whether the panel has next Item or not.

Type:
  • boolean
Since:
  • 6.0
See:

<readonly> hasPrevItem :boolean

whether the panel has previous Item or not.

Type:
  • boolean
Since:
  • 6.0
See:

<readonly> isFirstItem :boolean

whether the current active item is the first item or not

Type:
  • boolean
Since:
  • 6.0
See:

<readonly> isFirstItem :boolean

whether the current active item is the last item or not

Type:
  • boolean
Since:
  • 6.0
See:

<readonly> hasPrevNavigablePanel :boolean

whether the panel has previous deep navigable panel or not.

Type:
  • boolean
Since:
  • 6.3
See:

<readonly> hasNextNavigablePanel :boolean

whether the panel has next deep navigable panel or not.

Type:
  • boolean
Since:
  • 6.3
See:

<readonly> prevNavigablePanel :GuideNode

The previous deep navigable panel of the current active item. Please refer GuideBridge#setFocus for more info on the deep behavior.

Type:
Since:
  • 6.3
See:
  • currentItem

<readonly> nextNavigablePanel :GuideNode

The next deep navigable panel of the current active item. Please refer GuideBridge#setFocus for more info on the deep behavior.

Type:
Since:
  • 6.3
See:
  • currentItem