NavigationStateModel
The NavigationState model represents a navigation path respecting parameters.
extends: NavigationTreeNodeModel
implements: hash
bundle: online channel standard (oc)
since 4.2.0
The NavigationState model represents a navigation path respecting parameters.
The NavigationState model represents a navigation path, taking into account path parameters. The model may also include a navigation group-ID - if the group-ID is passed to accesible models and functions where possible.
Defined hash keys
activeChild ↦ NavigationStateModel
since 4.2.0
If this state is not a true subset of the current Navigation State undefined will be returned.
Otherwise the sub-state of the current navigation state, which corresponds to this instance extended by the next navigation node, will be returned.
children ↦ sequence<NavigationStateModel>
since 4.2.0
The use of this key is dehorted. Please use '→collection' version.
Returns a list of elements of the type NavigationState which includes all inferior navigation nodes and their possible parameter values. If a group ID is set, only inferior nodes with this set will be returned; these are arranged according to the group order.
childrenIterator ↦ collection<NavigationStateModel>
since 4.7.17
Returns a collection of NavigationState which includes all inferior navigation nodes and their possible parameter values. If a group ID is set, only inferior nodes with this set will be returned; these are arranged according to the group order.
isActive ↦ Boolean
since 4.2.0
Returns true if and only if the current navigation state is a sub-state of the current page requests navigation state.
isNavigated ↦ Boolean
since 4.2.0
Returns true if and only if the current navigation state is the same as the current page requests navigation state.
navigated ↦ NavigationStateModel
since 4.2.0
Returns the state of the current page request.
node ↦ NavigationTreeNodeModel
since 4.2.0
Returns the fundamental navigation node.
parameters ↦ collection<PathParameterModel>
since 4.2.0
Returns a collection of the parameters encoded in the URL path.
parameters.<String:key> ↦ PathParameterModel
since 4.2.0
Returns the parameter encoded in the URL path with the qualification 'key'. If this does not exist, undefined will be returned.
parent ↦ NavigationStateModel
since 4.2.0
Returns the navigation state which corresponds with the current navigation state, excluding the current navigation node.
root ↦ sequence<NavigationStateModel>
since 4.2.0
Returns sequence-model of root states of the navigation tree.
snippetUrl ↦ StateUrlModel
since 4.8.0
Returns a model for an URL which encodes the current navigation state as a SnippetUrl, this call can only be done inside a <@cs.snippet> directive.
url ↦ StateUrlModel
since 4.2.0
Returns a model for an URL which encodes the current navigation state.
Delegates other keys to: NavigationTreeNodeModel
Methods
activeNode(NavigationTreeNodeModel:target) ↦ NavigationStateModel
since 4.10.0
Returns a method-model to derive a state with the node 'target' activated.
children(String:group) ↦ sequence<NavigationStateModel>
since 4.2.0
The use of this is dehorted. Please use '→collection' version.
Returns a list of NavigationStates which includes all inferior navigation nodes and their possible parameter values, if their group ID corresponds with the parameter group. They are ordered as stipulated by the group rules.
childrenIterator(String:group) ↦ collection<NavigationStateModel>
since 4.7.17
Returns a collection of NavigationStates which includes all inferior navigation nodes and their possible parameter values, if their group ID corresponds with the parameter group. They are ordered as stipulated by the group rules.
parameter(String:name, TemplateModel:value) ↦ NavigationStateModel
since 4.3.0
Returns a NavigationState derived from the NavigationState is was obtained from but with parameter 'name' set to 'value'.
root(String:group) ↦ sequence<NavigationStateModel>
since 4.2.0
Returns a list of root states of of the navigation tree, which belong to the navigation group 'group'.