|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.dv.sbu.filehandler.ftl.dataprovider.DataProviderImpl
de.dv.sbu.filehandler.ftl.dataprovider.navigation.Navigation
public class Navigation
This data-provider realizes a simple navigation tree structure from a list of root nodes spanning a forest.
This root node usually is a technical dummy and will be ignored when the tree structure is used for outputting.
During outputting you may call the following methods:
getRootNodes()
, getActiveNode()
, href()
andhref(NavigationNode)
.
Field Summary |
---|
Fields inherited from class de.dv.sbu.filehandler.ftl.dataprovider.DataProviderImpl |
---|
builderConfiguration, sourceFileInformation |
Constructor Summary | |
---|---|
Navigation()
|
Method Summary | |
---|---|
NavigationNode |
findNode(java.lang.String target)
Scans the registered nodes for a match with the given target. |
NavigationNode |
getActiveNode()
Returns the active node corresponding to the current file information. |
java.util.List<NavigationNode> |
getRootNodes()
Returns the list of root nodes spanning the navigation tree forest. |
java.lang.String |
href()
Builds a HREF text for the current node respecting the current file information. |
java.lang.String |
href(NavigationNode node)
Builds a HREF text for the given node respecting the current file information. |
void |
init(BuilderConfiguration builderConfiguration)
Initializes the data provider. |
void |
init(SourceFileInformation fileInfo)
Updates the inner state depending on the given file information - if necessary. |
NavigationIterator |
nodeIterator()
Builds an hierarchical node iterator. |
NavigationIterator |
nodeIterator(NavigationNode node)
Builds an hierarchical node iterator for the given node. |
void |
setRootNodes(java.util.List<NavigationNode> rootNodes)
Sets the root nodes. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Navigation()
Method Detail |
---|
public java.util.List<NavigationNode> getRootNodes()
public void setRootNodes(java.util.List<NavigationNode> rootNodes) throws java.lang.NullPointerException
null
values.
rootNodes
- The root nodes to set.
java.lang.NullPointerException
- The argument is null
.public void init(BuilderConfiguration builderConfiguration)
init
in interface IDataProvider
init
in class DataProviderImpl
builderConfiguration
- The builder configuration to use.DataProviderImpl.init(de.dv.sbu.builder.BuilderConfiguration)
public void init(SourceFileInformation fileInfo)
init
in interface IDataProvider
init
in class DataProviderImpl
fileInfo
- The current source file information.IDataProvider.init(de.dv.sbu.SourceFileInformation)
public java.lang.String href(NavigationNode node)
node
- The node to build a HREF for.
public java.lang.String href()
public NavigationIterator nodeIterator()
public NavigationIterator nodeIterator(NavigationNode node)
node
- The node to start from.
public NavigationNode findNode(java.lang.String target)
target
- The target to look for.
null
if not found.public NavigationNode getActiveNode()
null
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |