org.dlese.dpc.schemedit.vocab.layout

Class LayoutNode

java.lang.Object

org.dlese.dpc.schemedit.vocab.layout.LayoutNode

public class LayoutNode
extends java.lang.Object

A node in a VocabLayout tree as defined by a vocabLayout (historically called "groups") file.

Author:

Jonathan Ostwald

Field Summary

Fields

Modifier and Type	Field and Description
org.dom4j.Element	element NOT YET DOCUMENTED

Constructor Summary

Constructors

Constructor and Description
LayoutNode(org.dom4j.Element element, VocabLayout vocabLayout) Constructor for the LayoutNode object
LayoutNode(org.dom4j.Element element, VocabLayout vocabLayout, LayoutNode parent) Constructor for the LayoutNode object containing the parent node.

Method Summary

Modifier and Type	Method and Description
boolean	getCollapsible() Gets the collapsible attribute of the LayoutNode object
java.lang.String	getDefinition() Gets the definition attribute value of the LayoutNode object
int	getGroupLevel() Gets the groupLevel attribute of the LayoutNode object, which specifies the depth of this LayoutNode within the VocabLayout tree.
boolean	getHasSubList() Gets the hasSubList attribute of the LayoutNode object
boolean	getIsLastInSubList() Returns true if this LayoutNode is the last in its list.
java.lang.String	getLabel() Returns the text attribute value if present, and the "name" attribute valueotherwise.
java.lang.String	getName() Returns the vocab attribute value.
boolean	getNoDisplay() Gets the noDisplay attribute of the LayoutNode object, suppresses display of this LayoutNode.
int	getNumColumns() Gets the number of columns required to render the sublist of which this LayoutNode is a member.
LayoutNode	getParent() Gets the parent (LayoutNode) of the LayoutNode object
java.util.List	getSubList() Gets the subList attribute of the LayoutNode object
java.lang.String	getType() Gets the type attribute of the LayoutNode object
boolean	getWrap() Gets the wrap attribute of the LayoutNode object, used to create a new column in the display.
boolean	hasSubList() Does this LayoutNode have children
void	report() NOT YET DOCUMENTED
java.lang.String	spacer(int num) NOT YET DOCUMENTED

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

element

public org.dom4j.Element element

NOT YET DOCUMENTED

Constructor Detail

LayoutNode

public LayoutNode(org.dom4j.Element element,
                  VocabLayout vocabLayout)

Constructor for the LayoutNode object

Parameters:

element - element defining this LayoutNode in the vocabLayout file

vocabLayout - the vocabLayout instance of which this node is a member

LayoutNode

public LayoutNode(org.dom4j.Element element,
                  VocabLayout vocabLayout,
                  LayoutNode parent)

Constructor for the LayoutNode object containing the parent node.

Parameters:

element - element defining this LayoutNode in the vocabLayout file

vocabLayout - the vocabLayout instance of which this node is a member

parent - the parent LayoutNode instance

Method Detail

getParent

public LayoutNode getParent()

Gets the parent (LayoutNode) of the LayoutNode object

Returns:

The parent value

getName

public java.lang.String getName()

Returns the vocab attribute value.

Returns:

The name value

getLabel

public java.lang.String getLabel()

Returns the text attribute value if present, and the "name" attribute valueotherwise.

Returns:

The label value

getDefinition

public java.lang.String getDefinition()

Gets the definition attribute value of the LayoutNode object

Returns:

The definition value

getWrap

public boolean getWrap()

Gets the wrap attribute of the LayoutNode object, used to create a new column in the display.

Returns:

The wrap value

getNoDisplay

public boolean getNoDisplay()

Gets the noDisplay attribute of the LayoutNode object, suppresses display of this LayoutNode.

Returns:

The noDisplay value

getType

public java.lang.String getType()

Gets the type attribute of the LayoutNode object

Returns:

The type value

getCollapsible

public boolean getCollapsible()

Gets the collapsible attribute of the LayoutNode object

Returns:

The collapsible value

getSubList

public java.util.List getSubList()

Gets the subList attribute of the LayoutNode object

Returns:

The subList value

hasSubList

public boolean hasSubList()

Does this LayoutNode have children

Returns:

true if this node has children

getHasSubList

public boolean getHasSubList()

Gets the hasSubList attribute of the LayoutNode object

Returns:

The hasSubList value

getIsLastInSubList

public boolean getIsLastInSubList()

Returns true if this LayoutNode is the last in its list.

Returns:

The isLastInSubList value

getNumColumns

public int getNumColumns()

Gets the number of columns required to render the sublist of which this LayoutNode is a member.

Returns:

The numColumns value

getGroupLevel

public int getGroupLevel()

Gets the groupLevel attribute of the LayoutNode object, which specifies the depth of this LayoutNode within the VocabLayout tree.

Returns:

The groupLevel value

spacer

public java.lang.String spacer(int num)

NOT YET DOCUMENTED

Parameters:

num - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

report

public void report()

NOT YET DOCUMENTED