|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.dv.sbu.filehandler.ftl.dataprovider.navigation.NavigationNode
public class NavigationNode
A node within one navigation tree defined in a Navigation
.
Constructor Summary | |
---|---|
NavigationNode()
|
Method Summary | |
---|---|
java.lang.String |
getActivePattern()
A JAVA regular expression pattern. |
int |
getChildIndex()
Returns the child index related to its parent (or the just the index in case of a root node). |
java.util.List<NavigationNode> |
getChildren()
Returns the list of navigation tree children. |
int |
getDepth()
Returns the depth of this node. |
java.lang.String |
getName()
Returns the node name. |
NavigationNode |
getNextNode()
Returns the next node when viewed as sequence. |
java.util.Map<java.lang.String,java.lang.String> |
getParameters()
Returns the specified parameters. |
NavigationNode |
getParent()
Returns the parent node. |
NavigationNode |
getPreviousNode()
Returns the previous node when viewed as sequence. |
java.lang.String |
getTarget()
The node's target. |
boolean |
isActive()
Calculated for each handled file. |
boolean |
isParentOfActive()
Calculated for each handled file. |
java.util.List<NavigationNode> |
reverseTreePath()
Returns the reverse tree path from this node (exclusive) to the tree root node (inclusive). |
void |
setActive(boolean active)
Sets the active flag. |
void |
setActivePattern(java.lang.String activePattern)
A JAVA regular expression pattern. |
void |
setChildIndex(int childIndex)
Sets the The child index related to its parent (or the just the index in case of a root node). |
void |
setChildren(java.util.List<NavigationNode> children)
Sets the child roots. |
void |
setDepth(int depth)
Sets the depth of this node. |
void |
setName(java.lang.String name)
Sets the node's name. |
void |
setNextNode(NavigationNode nextNode)
Sets the next node. |
void |
setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
Sets the parameters. |
void |
setParent(NavigationNode parent)
Sets the node's parent. |
void |
setParentOfActive(boolean parentOfActive)
Sets the parent-of-active flag. |
void |
setPreviousNode(NavigationNode previousNode)
Sets the previous node. |
void |
setTarget(java.lang.String target)
Sets the node's target |
java.lang.String |
toString()
|
java.util.List<NavigationNode> |
treePath()
Returns the tree path from the tree root node (inclusive) to this node (exclusive). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public NavigationNode()
Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String name) throws java.lang.NullPointerException
name
- The name to set. Expected to be unique.
java.lang.NullPointerException
- The given argument is null
.public java.lang.String getTarget()
public void setTarget(java.lang.String target) throws java.lang.NullPointerException
target
-
java.lang.NullPointerException
public java.util.Map<java.lang.String,java.lang.String> getParameters()
public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters) throws java.lang.NullPointerException
parameters
- The parameters to set.
java.lang.NullPointerException
- The given argument is null
.public boolean isActive()
true
if the currently handled file's path
matches the node's path
.
If they differ the value will be false
.
true
if the current node is linked to the current source file. Otherwise false.
public void setActive(boolean active)
active
- The state to set.public boolean isParentOfActive()
true
,
this will return true
. Otherwise false
.
public void setParentOfActive(boolean parentOfActive)
parentOfActive
- public NavigationNode getParent()
null
if this is a root node.
public void setParent(NavigationNode parent)
parent
- The node to set as parent.public java.util.List<NavigationNode> getChildren()
public void setChildren(java.util.List<NavigationNode> children) throws java.lang.NullPointerException
children
- The child nodes to set.
java.lang.NullPointerException
- The set is null
or contains null
elements.public NavigationNode getPreviousNode()
null
for the first one.
public void setPreviousNode(NavigationNode previousNode)
previousNode
- The node to set.public NavigationNode getNextNode()
null
if this is the last one.
public void setNextNode(NavigationNode nextNode)
nextNode
- The node to set.public int getChildIndex()
public void setChildIndex(int childIndex)
childIndex
- The child index to set.public int getDepth()
0
.
public void setDepth(int depth)
0
.
depth
- Sets the depth of this node.public java.lang.String getActivePattern()
null
(not set).
public void setActivePattern(java.lang.String activePattern)
null
(not set).
activePattern
- The pattern to set or null
to remove.Pattern
public java.util.List<NavigationNode> reverseTreePath()
public java.util.List<NavigationNode> treePath()
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |