org.outerj.daisy.navigation
Class NavigationParams
java.lang.Object
org.outerj.daisy.navigation.NavigationParams
public class NavigationParams
- extends java.lang.Object
Constructor Summary |
NavigationParams(org.outerj.daisy.repository.VariantKey navigationDoc,
NavigationVersionMode versionMode,
java.lang.String activePath,
boolean contextualized)
|
NavigationParams(org.outerj.daisy.repository.VariantKey navigationDoc,
java.lang.String activePath,
boolean contextualized)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
NavigationParams
public NavigationParams(org.outerj.daisy.repository.VariantKey navigationDoc,
NavigationVersionMode versionMode,
java.lang.String activePath,
boolean contextualized)
- Parameters:
navigationDoc
- key of the repository document containing the navigation descriptionversionMode
- indicates whether the live or last versions of documents should be used
(applies to both the navigation tree documents themselves, as to the document
nodes and query results).activePath
- a path in the form "<id>/<id>/<id>" leading to the active
node. This attribute is optional and can be null. This can be used to make
sure the expected (i.e. clicked) node is marked as selected when the activeDocument
occurs at more then one location in the tree, or to highlight a non-document node.
The implementation must be able to handle the case where the activePath does not exist,
in which case the activeDocument parameter will be used to highlight the first occurence
of that document in the tree (if activeDocument != -1).contextualized
- indicates whether to produce a limited navigation tree only showing
the nodes leading to the activePath, or a full navigation tree
including all nodes
NavigationParams
public NavigationParams(org.outerj.daisy.repository.VariantKey navigationDoc,
java.lang.String activePath,
boolean contextualized)
getNavigationDoc
public org.outerj.daisy.repository.VariantKey getNavigationDoc()
getVersionMode
public NavigationVersionMode getVersionMode()
getActivePath
public java.lang.String getActivePath()
getContextualized
public boolean getContextualized()
Copyright © -2012 . All Rights Reserved.