org.apache.struts2.dojo.components
Class Tree

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

public class Tree
extends ClosingUIBean

Renders a tree widget with AJAX support.

The "id "attribute is normally specified(recommended), such that it could be looked up using javascript if necessary. The "id" attribute is required if the "selectedNotifyTopic" or the "href" attributes are going to be used.

<s:tree id="..." label="..."> <s:treenode id="..." label="..." /> <s:treenode id="..." label="..."> <s:treenode id="..." label="..." /> <s:treenode id="..." label="..." /> </s:treenode> <s:treenode id="..." label="..." /> </s:tree> <s:tree id="..." rootNode="..." nodeIdProperty="..." nodeTitleProperty="..." childCollectionProperty="..." /> <s:url id="nodesUrl" namespace="/nodecorate" action="getNodes" /> <div style="float:left; margin-right: 50px;"> <sx:tree id="tree" href="%{#nodesUrl}" /> </div> On this example the url specified on the "href" attibute will be called to load the elements on the root. The response is expected to be a JSON array of objects like: [ { label: "Node 1", hasChildren: false, id: "Node1" }, { label: "Node 2", hasChildren: true, id: "Node2" }, ] "label" is the text that will be displayed for the node. "hasChildren" marks the node has having children or not (if true, a plus icon will be assigned to the node so it can be expanded). The "id" attribute will be used to load the children of the node, when the node is expanded. When a node is expanded a request will be made to the url in the "href" attribute and the node's "id" will be passed in the parameter "nodeId". The children collection for a node will be loaded only once, to reload the children of a node, use the "reload()" function of the treenode widget. To reload the children nodes of "Node1" from the example above use the following javascript: dojo.widget.byId("Node1").reload();


Field Summary
protected  java.lang.String blankIconSrc
           
protected  java.lang.String childCollectionProperty
           
protected  java.lang.String collapsedNotifyTopics
           
protected  java.lang.String errorNotifyTopics
           
protected  java.lang.String expandedNotifyTopics
           
protected  java.lang.String expandIconSrcMinus
           
protected  java.lang.String expandIconSrcPlus
           
protected  java.lang.String gridIconSrcC
           
protected  java.lang.String gridIconSrcL
           
protected  java.lang.String gridIconSrcP
           
protected  java.lang.String gridIconSrcV
           
protected  java.lang.String gridIconSrcX
           
protected  java.lang.String gridIconSrcY
           
protected  java.lang.String href
           
protected  java.lang.String iconHeight
           
protected  java.lang.String iconWidth
           
protected  java.lang.String nodeIdProperty
           
protected  java.lang.String nodeTitleProperty
           
protected  java.lang.String rootNodeAttr
           
protected  java.lang.String selectedNotifyTopics
           
protected  java.lang.String showGrid
           
protected  java.lang.String showRootGrid
           
protected  java.lang.String templateCssPath
           
protected  java.lang.String toggle
           
protected  java.lang.String toggleDuration
           
 
Fields inherited from class org.apache.struts2.components.UIBean
accesskey, cssClass, cssErrorClass, cssErrorStyle, cssStyle, defaultTemplateDir, defaultUITheme, disabled, dynamicAttributes, id, javascriptTooltip, key, label, labelPosition, labelSeparator, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateEngineManager, templateSuffix, theme, title, tooltip, tooltipConfig, tooltipCssClass, tooltipDelay, tooltipIconPath, value
 
Fields inherited from class org.apache.struts2.components.Component
actionMapper, COMPONENT_STACK, parameters, stack, throwExceptionOnELFailure
 
Constructor Summary
Tree(ValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 
Method Summary
 void addChildrenId(java.lang.String id)
           
protected  void evaluateExtraParams()
           
 java.lang.String getBlankIconSrc()
           
 java.lang.String getChildCollectionProperty()
           
 java.lang.String getDefaultOpenTemplate()
           
protected  java.lang.String getDefaultTemplate()
           
 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 getTheme()
           
 java.lang.String getToggle()
           
 java.lang.String getToggleDuration()
           
 void setBlankIconSrc(java.lang.String blankIconSrc)
           
 void setChildCollectionProperty(java.lang.String childCollectionProperty)
           
 void setCollapsedNotifyTopics(java.lang.String collapsedNotifyTopics)
           
 void setCssClass(java.lang.String cssClass)
           
 void setCssStyle(java.lang.String cssStyle)
           
 void setErrorNotifyTopics(java.lang.String errorNotifyTopics)
           
 void setExpandedNotifyTopics(java.lang.String expandedNotifyTopics)
           
 void setExpandIconSrcMinus(java.lang.String expandIconSrcMinus)
           
 void setExpandIconSrcPlus(java.lang.String expandIconSrcPlus)
           
 void setGridIconSrcC(java.lang.String gridIconSrcC)
           
 void setGridIconSrcL(java.lang.String gridIconSrcL)
           
 void setGridIconSrcP(java.lang.String gridIconSrcP)
           
 void setGridIconSrcV(java.lang.String gridIconSrcV)
           
 void setGridIconSrcX(java.lang.String gridIconSrcX)
           
 void setGridIconSrcY(java.lang.String gridIconSrcY)
           
 void setHref(java.lang.String href)
           
 void setIconHeight(java.lang.String iconHeight)
           
 void setIconWidth(java.lang.String iconWidth)
           
 void setId(java.lang.String id)
           
 void setName(java.lang.String name)
           
 void setNodeIdProperty(java.lang.String nodeIdProperty)
           
 void setNodeTitleProperty(java.lang.String nodeTitleProperty)
           
 void setRootNode(java.lang.String rootNode)
           
 void setSelectedNotifyTopics(java.lang.String selectedNotifyTopics)
           
 void setShowGrid(java.lang.String showGrid)
           
 void setShowRootGrid(java.lang.String showRootGrid)
           
 void setTemplateCssPath(java.lang.String templateCssPath)
           
 void setTheme(java.lang.String theme)
           
 void setToggle(java.lang.String toggle)
           
 void setToggleDuration(java.lang.String toggleDuration)
           
 void setTreeCollapsedTopics(java.lang.String collapsedNotifyTopic)
           
 void setTreeExpandedTopics(java.lang.String expandedNotifyTopic)
           
 void setTreeSelectedTopic(java.lang.String selectedNotifyTopic)
           
 boolean start(java.io.Writer writer)
           
 
Methods inherited from class org.apache.struts2.components.ClosingUIBean
setOpenTemplate
 
Methods inherited from class org.apache.struts2.components.UIBean
addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, ensureAttributeSafelyNotEscaped, escape, evaluateNameValue, evaluateParams, getId, getTemplate, getTemplateDir, getTooltipConfig, getValueClassType, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssErrorClass, setCssErrorStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setDynamicAttributes, setJavascriptTooltip, setKey, setLabel, setLabelposition, setLabelSeparator, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTitle, setTooltip, setTooltipConfig, setTooltipCssClass, setTooltipDelay, setTooltipIconPath, setValue
 
Methods inherited from class org.apache.struts2.components.Component
addAllParameters, addParameter, altSyntax, altSyntax, completeExpressionIfAltSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findStringIfAltSyntax, findValue, findValue, findValue, getComponentStack, getParameters, getStack, popComponentStack, setActionMapper, setThrowExceptionsOnELFailure, stripExpressionIfAltSyntax, stripExpressionIfAltSyntax, toString, usesBody
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

toggle

protected java.lang.String toggle

selectedNotifyTopics

protected java.lang.String selectedNotifyTopics

expandedNotifyTopics

protected java.lang.String expandedNotifyTopics

collapsedNotifyTopics

protected java.lang.String collapsedNotifyTopics

rootNodeAttr

protected java.lang.String rootNodeAttr

childCollectionProperty

protected java.lang.String childCollectionProperty

nodeTitleProperty

protected java.lang.String nodeTitleProperty

nodeIdProperty

protected java.lang.String nodeIdProperty

showRootGrid

protected java.lang.String showRootGrid

showGrid

protected java.lang.String showGrid

blankIconSrc

protected java.lang.String blankIconSrc

gridIconSrcL

protected java.lang.String gridIconSrcL

gridIconSrcV

protected java.lang.String gridIconSrcV

gridIconSrcP

protected java.lang.String gridIconSrcP

gridIconSrcC

protected java.lang.String gridIconSrcC

gridIconSrcX

protected java.lang.String gridIconSrcX

gridIconSrcY

protected java.lang.String gridIconSrcY

expandIconSrcPlus

protected java.lang.String expandIconSrcPlus

expandIconSrcMinus

protected java.lang.String expandIconSrcMinus

iconWidth

protected java.lang.String iconWidth

iconHeight

protected java.lang.String iconHeight

toggleDuration

protected java.lang.String toggleDuration

templateCssPath

protected java.lang.String templateCssPath

href

protected java.lang.String href

errorNotifyTopics

protected java.lang.String errorNotifyTopics
Constructor Detail

Tree

public Tree(ValueStack stack,
            javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
Method Detail

start

public boolean start(java.io.Writer writer)
Overrides:
start in class ClosingUIBean

evaluateExtraParams

protected void evaluateExtraParams()
Overrides:
evaluateExtraParams in class UIBean

addChildrenId

public void addChildrenId(java.lang.String id)

setTheme

public void setTheme(java.lang.String theme)
Overrides:
setTheme in class UIBean

getTheme

public java.lang.String getTheme()
Overrides:
getTheme in class UIBean

getDefaultOpenTemplate

public java.lang.String getDefaultOpenTemplate()
Specified by:
getDefaultOpenTemplate in class ClosingUIBean

getDefaultTemplate

protected java.lang.String getDefaultTemplate()
Specified by:
getDefaultTemplate in class UIBean

getToggle

public java.lang.String getToggle()

setToggle

public void setToggle(java.lang.String toggle)

setTreeSelectedTopic

public void setTreeSelectedTopic(java.lang.String selectedNotifyTopic)

setTreeExpandedTopics

public void setTreeExpandedTopics(java.lang.String expandedNotifyTopic)

setTreeCollapsedTopics

public void setTreeCollapsedTopics(java.lang.String collapsedNotifyTopic)

getRootNode

public java.lang.String getRootNode()

setRootNode

public void setRootNode(java.lang.String rootNode)

getChildCollectionProperty

public java.lang.String getChildCollectionProperty()

setChildCollectionProperty

public void setChildCollectionProperty(java.lang.String childCollectionProperty)

getNodeTitleProperty

public java.lang.String getNodeTitleProperty()

setNodeTitleProperty

public void setNodeTitleProperty(java.lang.String nodeTitleProperty)

getNodeIdProperty

public java.lang.String getNodeIdProperty()

setNodeIdProperty

public void setNodeIdProperty(java.lang.String nodeIdProperty)

setShowRootGrid

public void setShowRootGrid(java.lang.String showRootGrid)

getShowRootGrid

public java.lang.String getShowRootGrid()

getBlankIconSrc

public java.lang.String getBlankIconSrc()

setBlankIconSrc

public void setBlankIconSrc(java.lang.String blankIconSrc)

getExpandIconSrcMinus

public java.lang.String getExpandIconSrcMinus()

setExpandIconSrcMinus

public void setExpandIconSrcMinus(java.lang.String expandIconSrcMinus)

getExpandIconSrcPlus

public java.lang.String getExpandIconSrcPlus()

setExpandIconSrcPlus

public void setExpandIconSrcPlus(java.lang.String expandIconSrcPlus)

getGridIconSrcC

public java.lang.String getGridIconSrcC()

setGridIconSrcC

public void setGridIconSrcC(java.lang.String gridIconSrcC)

getGridIconSrcL

public java.lang.String getGridIconSrcL()

setGridIconSrcL

public void setGridIconSrcL(java.lang.String gridIconSrcL)

getGridIconSrcP

public java.lang.String getGridIconSrcP()

setGridIconSrcP

public void setGridIconSrcP(java.lang.String gridIconSrcP)

getGridIconSrcV

public java.lang.String getGridIconSrcV()

setGridIconSrcV

public void setGridIconSrcV(java.lang.String gridIconSrcV)

getGridIconSrcX

public java.lang.String getGridIconSrcX()

setGridIconSrcX

public void setGridIconSrcX(java.lang.String gridIconSrcX)

getGridIconSrcY

public java.lang.String getGridIconSrcY()

setGridIconSrcY

public void setGridIconSrcY(java.lang.String gridIconSrcY)

getIconHeight

public java.lang.String getIconHeight()

setIconHeight

public void setIconHeight(java.lang.String iconHeight)

getIconWidth

public java.lang.String getIconWidth()

setIconWidth

public void setIconWidth(java.lang.String iconWidth)

getTemplateCssPath

public java.lang.String getTemplateCssPath()

setTemplateCssPath

public void setTemplateCssPath(java.lang.String templateCssPath)

getToggleDuration

public java.lang.String getToggleDuration()

setToggleDuration

public void setToggleDuration(java.lang.String toggleDuration)

getShowGrid

public java.lang.String getShowGrid()

setShowGrid

public void setShowGrid(java.lang.String showGrid)

setCssClass

public void setCssClass(java.lang.String cssClass)
Overrides:
setCssClass in class UIBean

setCssStyle

public void setCssStyle(java.lang.String cssStyle)
Overrides:
setCssStyle in class UIBean

setId

public void setId(java.lang.String id)
Overrides:
setId in class UIBean

setName

public void setName(java.lang.String name)
Overrides:
setName in class UIBean

setCollapsedNotifyTopics

public void setCollapsedNotifyTopics(java.lang.String collapsedNotifyTopics)

setExpandedNotifyTopics

public void setExpandedNotifyTopics(java.lang.String expandedNotifyTopics)

setSelectedNotifyTopics

public void setSelectedNotifyTopics(java.lang.String selectedNotifyTopics)

setHref

public void setHref(java.lang.String href)

setErrorNotifyTopics

public void setErrorNotifyTopics(java.lang.String errorNotifyTopics)


Copyright © 2000-2012 Apache Software Foundation. All Rights Reserved.