org.apache.struts2.components
Class Tree

java.lang.Object
  org.apache.struts2.components.Component
      org.apache.struts2.components.UIBean
          org.apache.struts2.components.ClosingUIBean
              org.apache.struts2.components.Tree

public class Tree
extends ClosingUIBean

Renders a tree widget with AJAX support.

The id attribute is normally specified, such that it could be looked up using javascript if necessary.

Examples

 
 
 <-- statically -->
 <s:tree id="..." label="...">
    <s:treenode id="..." label="..." />
    <s:treenode id="..." label="...">
        <s:treenode id="..." label="..." />
        <s:treenode id="..." label="..." />
    &;lt;/s:treenode>
    <s:treenode id="..." label="..." />
 </s:tree>
 
 <-- dynamically -->
 <s:tree
                        id="..."
          rootNode="..."
          nodeIdProperty="..."
          nodeTitleProperty="..."
          childCollectionProperty="..." />
 
 
 

Field Summary

protected java.lang.String	childCollectionProperty
protected java.lang.String	nodeIdProperty
protected java.lang.String	nodeTitleProperty
protected java.lang.String	rootNodeAttr

Fields inherited from class org.apache.struts2.components.UIBean

accesskey, cssClass, cssStyle, disabled, label, labelPosition, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateSuffix, theme, title, tooltip, tooltipConfig, value

Fields inherited from class org.apache.struts2.components.Component

COMPONENT_STACK, id, parameters, stack

Constructor Summary

Tree(com.opensymphony.xwork2.util.OgnlValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Method Summary

protected void	evaluateExtraParams()
java.lang.String	getBlankIconSrc()
java.lang.String	getChildCollectionProperty()
java.lang.String	getDefaultOpenTemplate()
protected java.lang.String	getDefaultTemplate() A contract that requires each concrete UI Tag to specify which template should be used as a default.
java.lang.String	getExpandIconSrcMinus()
java.lang.String	getExpandIconSrcPlus()
java.lang.String	getGridIconSrcC()
java.lang.String	getGridIconSrcL()
java.lang.String	getGridIconSrcP()
java.lang.String	getGridIconSrcV()
java.lang.String	getGridIconSrcX()
java.lang.String	getGridIconSrcY()
java.lang.String	getIconHeight()
java.lang.String	getIconWidth()
java.lang.String	getNodeIdProperty()
java.lang.String	getNodeTitleProperty()
java.lang.String	getRootNode()
java.lang.String	getShowGrid()
java.lang.String	getShowRootGrid()
java.lang.String	getTemplateCssPath()
java.lang.String	getToggle()
java.lang.String	getToggleDuration()
java.lang.String	getTreeCollapsedTopic()
java.lang.String	getTreeExpandedTopic()
java.lang.String	getTreeSelectedTopic()
void	setBlankIconSrc(java.lang.String blankIconSrc) Blank icon image source.
void	setChildCollectionProperty(java.lang.String childCollectionProperty) The childCollectionProperty property.
void	setExpandIconSrcMinus(java.lang.String expandIconSrcMinus) Expand icon (-) image source.
void	setExpandIconSrcPlus(java.lang.String expandIconSrcPlus) Expand Icon (+) image source.
void	setGridIconSrcC(java.lang.String gridIconSrcC) Image source for under child item child icons.
void	setGridIconSrcL(java.lang.String gridIconSrcL) Image source for last child grid.
void	setGridIconSrcP(java.lang.String gridIconSrcP) Image source for under parent item child icons.
void	setGridIconSrcV(java.lang.String gridIconSrcV) Image source for vertical line.
void	setGridIconSrcX(java.lang.String gridIconSrcX) Image source for grid for sole root item.
void	setGridIconSrcY(java.lang.String gridIconSrcY) Image source for grid for last root item.
void	setIconHeight(java.lang.String iconHeight) Icon height (default 18 pixels).
void	setIconWidth(java.lang.String iconWidth) Icon width (default 19 pixels).
void	setNodeIdProperty(java.lang.String nodeIdProperty) The nodeIdProperty property.
void	setNodeTitleProperty(java.lang.String nodeTitleProperty) The nodeTitleProperty property.
void	setRootNode(java.lang.String rootNode) The rootNode property.
void	setShowGrid(java.lang.String showGrid) Show grid (default true).
void	setShowRootGrid(java.lang.String showRootGrid) The showRootGrid property (default true).
void	setTemplateCssPath(java.lang.String templateCssPath) Template css path (default {contextPath}/struts/tree.css.
void	setToggle(java.lang.String toggle) The toggle property (either 'explode' or 'fade').
void	setToggleDuration(java.lang.String toggleDuration) Toggle duration (default 150 ms)
void	setTreeCollapsedTopic(java.lang.String treeCollapsedTopic) The treeCollapsedTopic property.
void	setTreeExpandedTopic(java.lang.String treeExpandedTopic) The treeExpandedTopic property.
void	setTreeSelectedTopic(java.lang.String treeSelectedTopic) The treeSelectedTopic property.
boolean	start(java.io.Writer writer) Callback for the start tag of this component.

Methods inherited from class org.apache.struts2.components.ClosingUIBean

setOpenTemplate

Methods inherited from class org.apache.struts2.components.UIBean

addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, escape, evaluateNameValue, evaluateParams, getTemplate, getTemplateDir, getTheme, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssStyle, setDisabled, setLabel, setLabelposition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTheme, setTitle, setTooltip, setTooltipConfig, setValue

Methods inherited from class org.apache.struts2.components.Component

addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, toString, usesBody

Methods inherited from class java.lang.Object

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

Field Detail

rootNodeAttr

protected java.lang.String rootNodeAttr

childCollectionProperty

protected java.lang.String childCollectionProperty

nodeTitleProperty

protected java.lang.String nodeTitleProperty

nodeIdProperty

protected java.lang.String nodeIdProperty

Constructor Detail

Tree

public Tree(com.opensymphony.xwork2.util.OgnlValueStack stack,
            javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)

Method Detail

start

public boolean start(java.io.Writer writer)

Description copied from class: Component

Callback for the start tag of this component. Should the body be evaluated?

Overrides:

start in class ClosingUIBean

Parameters:

writer - the output writer.

Returns:

true if the body should be evaluated

evaluateExtraParams

protected void evaluateExtraParams()

Overrides:

evaluateExtraParams in class UIBean

getDefaultOpenTemplate

public java.lang.String getDefaultOpenTemplate()

Specified by:

getDefaultOpenTemplate in class ClosingUIBean

getDefaultTemplate

protected java.lang.String getDefaultTemplate()

Description copied from class: UIBean

A contract that requires each concrete UI Tag to specify which template should be used as a default. For example, the CheckboxTab might return "checkbox.vm" while the RadioTag might return "radio.vm". This value not begin with a '/' unless you intend to make the path absolute rather than relative to the current theme.

Specified by:

getDefaultTemplate in class UIBean

Returns:

The name of the template to be used as the default.

getToggle

public java.lang.String getToggle()

setToggle

public void setToggle(java.lang.String toggle)

The toggle property (either 'explode' or 'fade'). Default is 'fade'.

getTreeSelectedTopic

public java.lang.String getTreeSelectedTopic()

setTreeSelectedTopic

public void setTreeSelectedTopic(java.lang.String treeSelectedTopic)

The treeSelectedTopic property.

getTreeExpandedTopic

public java.lang.String getTreeExpandedTopic()

setTreeExpandedTopic

public void setTreeExpandedTopic(java.lang.String treeExpandedTopic)

The treeExpandedTopic property.

getTreeCollapsedTopic

public java.lang.String getTreeCollapsedTopic()

setTreeCollapsedTopic

public void setTreeCollapsedTopic(java.lang.String treeCollapsedTopic)

The treeCollapsedTopic property.

getRootNode

public java.lang.String getRootNode()

setRootNode

public void setRootNode(java.lang.String rootNode)

The rootNode property.

getChildCollectionProperty

public java.lang.String getChildCollectionProperty()

setChildCollectionProperty

public void setChildCollectionProperty(java.lang.String childCollectionProperty)

The childCollectionProperty property.

getNodeTitleProperty

public java.lang.String getNodeTitleProperty()

setNodeTitleProperty

public void setNodeTitleProperty(java.lang.String nodeTitleProperty)

The nodeTitleProperty property.

getNodeIdProperty

public java.lang.String getNodeIdProperty()

setNodeIdProperty

public void setNodeIdProperty(java.lang.String nodeIdProperty)

The nodeIdProperty property.

setShowRootGrid

public void setShowRootGrid(java.lang.String showRootGrid)

The showRootGrid property (default true).

getShowRootGrid

public java.lang.String getShowRootGrid()

getBlankIconSrc

public java.lang.String getBlankIconSrc()

setBlankIconSrc

public void setBlankIconSrc(java.lang.String blankIconSrc)

Blank icon image source.

getExpandIconSrcMinus

public java.lang.String getExpandIconSrcMinus()

setExpandIconSrcMinus

public void setExpandIconSrcMinus(java.lang.String expandIconSrcMinus)

Expand icon (-) image source.

getExpandIconSrcPlus

public java.lang.String getExpandIconSrcPlus()

setExpandIconSrcPlus

public void setExpandIconSrcPlus(java.lang.String expandIconSrcPlus)

Expand Icon (+) image source.

getGridIconSrcC

public java.lang.String getGridIconSrcC()

setGridIconSrcC

public void setGridIconSrcC(java.lang.String gridIconSrcC)

Image source for under child item child icons.

getGridIconSrcL

public java.lang.String getGridIconSrcL()

setGridIconSrcL

public void setGridIconSrcL(java.lang.String gridIconSrcL)

Image source for last child grid.

getGridIconSrcP

public java.lang.String getGridIconSrcP()

setGridIconSrcP

public void setGridIconSrcP(java.lang.String gridIconSrcP)

Image source for under parent item child icons.

getGridIconSrcV

public java.lang.String getGridIconSrcV()

setGridIconSrcV

public void setGridIconSrcV(java.lang.String gridIconSrcV)

Image source for vertical line.

getGridIconSrcX

public java.lang.String getGridIconSrcX()

setGridIconSrcX

public void setGridIconSrcX(java.lang.String gridIconSrcX)

Image source for grid for sole root item.

getGridIconSrcY

public java.lang.String getGridIconSrcY()

setGridIconSrcY

public void setGridIconSrcY(java.lang.String gridIconSrcY)

Image source for grid for last root item.

getIconHeight

public java.lang.String getIconHeight()

setIconHeight

public void setIconHeight(java.lang.String iconHeight)

Icon height (default 18 pixels).

getIconWidth

public java.lang.String getIconWidth()

setIconWidth

public void setIconWidth(java.lang.String iconWidth)

Icon width (default 19 pixels).

getTemplateCssPath

public java.lang.String getTemplateCssPath()

setTemplateCssPath

public void setTemplateCssPath(java.lang.String templateCssPath)

Template css path (default {contextPath}/struts/tree.css.

getToggleDuration

public java.lang.String getToggleDuration()

setToggleDuration

public void setToggleDuration(java.lang.String toggleDuration)

Toggle duration (default 150 ms)

getShowGrid

public java.lang.String getShowGrid()

setShowGrid

public void setShowGrid(java.lang.String showGrid)

Show grid (default true).