diff --git a/plugins/dojo/src/main/java/org/apache/struts2/dojo/components/Tree.java b/plugins/dojo/src/main/java/org/apache/struts2/dojo/components/Tree.java
index f73c2e1d3..1b8b07198 100644
--- a/plugins/dojo/src/main/java/org/apache/struts2/dojo/components/Tree.java
+++ b/plugins/dojo/src/main/java/org/apache/struts2/dojo/components/Tree.java
@@ -37,18 +37,15 @@ import com.opensymphony.xwork2.util.ValueStack;
*
* Renders a tree widget with AJAX support.
*
- * The "id "attribute is normally specified, such that it could be looked up using
- * javascript if necessary. The "id" attribute is required if the "treeSelectedTopic"
- * attribute is going to be used.
+ * 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.
*
*
*
- * Examples
- *
+ *
*
- *
- *
- * <-- statically -->
+ * Tree loaded statically
* <s:tree id="..." label="...">
* <s:treenode id="..." label="..." />
* <s:treenode id="..." label="...">
@@ -57,18 +54,62 @@ import com.opensymphony.xwork2.util.ValueStack;
* &;lt;/s:treenode>
* <s:treenode id="..." label="..." />
* </s:tree>
- *
- * <-- dynamically -->
+ *
+ *
+ *
+ *
+ * Tree loaded dynamically
+ *
* <s:tree
* id="..."
* rootNode="..."
* nodeIdProperty="..."
* nodeTitleProperty="..."
* childCollectionProperty="..." />
- *
- *
*
- *
+ *
+ *
+ *
+ * Tree loaded dynamically using AJAX
+ *
+ * <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();
+ *
+ *
*/
@StrutsTag(name="tree", tldTagClass="org.apache.struts2.dojo.views.jsp.ui.TreeTag", description="Render a tree widget.")
public class Tree extends ClosingUIBean {
@@ -76,31 +117,33 @@ public class Tree extends ClosingUIBean {
private static final String TEMPLATE = "tree-close";
private static final String OPEN_TEMPLATE = "tree";
- private String toggle = "fade";
- private String selectedNotifyTopics;
- private String expandedNotifyTopics;
- private String collapsedNotifyTopics;
+ protected String toggle;
+ protected String selectedNotifyTopics;
+ protected String expandedNotifyTopics;
+ protected String collapsedNotifyTopics;
protected String rootNodeAttr;
protected String childCollectionProperty;
protected String nodeTitleProperty;
protected String nodeIdProperty;
- private String showRootGrid;
-
- private String showGrid;
- private String blankIconSrc;
- private String gridIconSrcL;
- private String gridIconSrcV;
- private String gridIconSrcP;
- private String gridIconSrcC;
- private String gridIconSrcX;
- private String gridIconSrcY;
- private String expandIconSrcPlus;
- private String expandIconSrcMinus;
- private String iconWidth;
- private String iconHeight;
- private String toggleDuration;
- private String templateCssPath;
+ protected String showRootGrid;
+ protected String showGrid;
+ protected String blankIconSrc;
+ protected String gridIconSrcL;
+ protected String gridIconSrcV;
+ protected String gridIconSrcP;
+ protected String gridIconSrcC;
+ protected String gridIconSrcX;
+ protected String gridIconSrcY;
+ protected String expandIconSrcPlus;
+ protected String expandIconSrcMinus;
+ protected String iconWidth;
+ protected String iconHeight;
+ protected String toggleDuration;
+ protected String templateCssPath;
+ protected String href;
+ protected String errorNotifyTopics;
+
public Tree(ValueStack stack, HttpServletRequest request, HttpServletResponse response) {
super(stack, request, response);
}
@@ -108,12 +151,12 @@ public class Tree extends ClosingUIBean {
public boolean start(Writer writer) {
boolean result = super.start(writer);
- if (this.label == null) {
+ if (this.label == null && (href == null)) {
if ((rootNodeAttr == null)
|| (childCollectionProperty == null)
|| (nodeTitleProperty == null)
|| (nodeIdProperty == null)) {
- fieldError("label","The TreeTag requires either a value for 'label' or ALL of 'rootNode', " +
+ fieldError("label","The TreeTag requires either a value for 'label' or 'href' or ALL of 'rootNode', " +
"'childCollectionProperty', 'nodeTitleProperty', and 'nodeIdProperty'", null);
}
}
@@ -125,6 +168,8 @@ public class Tree extends ClosingUIBean {
if (toggle != null) {
addParameter("toggle", findString(toggle));
+ } else {
+ addParameter("toggle", "fade");
}
if (selectedNotifyTopics != null) {
@@ -212,6 +257,11 @@ public class Tree extends ClosingUIBean {
if (templateCssPath != null) {
addParameter("templateCssPath", findString(templateCssPath));
}
+ if (href != null)
+ addParameter("href", findString(href));
+ if (errorNotifyTopics != null)
+ addParameter("errorNotifyTopics", findString(errorNotifyTopics));
+
}
@Override
@@ -469,5 +519,17 @@ public class Tree extends ClosingUIBean {
public void setSelectedNotifyTopics(String selectedNotifyTopics) {
this.selectedNotifyTopics = selectedNotifyTopics;
}
+
+ @StrutsTagAttribute(description="Url used to load the list of children nodes for an specific node, whose id will be " +
+ "passed as a parameter named 'nodeId' (empty for root)")
+ public void setHref(String href) {
+ this.href = href;
+ }
+
+ @StrutsTagAttribute(description="Comma delimmited list of topics that will published after the request(if the request fails)." +
+ "Only valid if 'href' is set")
+ public void setErrorNotifyTopics(String errorNotifyTopics) {
+ this.errorNotifyTopics = errorNotifyTopics;
+ }
}
diff --git a/plugins/dojo/src/main/java/org/apache/struts2/dojo/views/jsp/ui/TreeTag.java b/plugins/dojo/src/main/java/org/apache/struts2/dojo/views/jsp/ui/TreeTag.java
index a00e2c533..4eb673212 100644
--- a/plugins/dojo/src/main/java/org/apache/struts2/dojo/views/jsp/ui/TreeTag.java
+++ b/plugins/dojo/src/main/java/org/apache/struts2/dojo/views/jsp/ui/TreeTag.java
@@ -36,32 +36,33 @@ public class TreeTag extends AbstractClosingTag {
private static final long serialVersionUID = 2735218501058548013L;
- private String toggle;
- private String selectedNotifyTopics;
- private String expandedNotifyTopics;
- private String collapsedNotifyTopics;
- private String rootNode;
- private String childCollectionProperty;
- private String nodeTitleProperty;
- private String nodeIdProperty;
- private String showRootGrid;
-
- private String showGrid;
- private String blankIconSrc;
- private String gridIconSrcL;
- private String gridIconSrcV;
- private String gridIconSrcP;
- private String gridIconSrcC;
- private String gridIconSrcX;
- private String gridIconSrcY;
- private String expandIconSrcPlus;
- private String expandIconSrcMinus;
- private String iconWidth;
- private String iconHeight;
- private String toggleDuration;
- private String templateCssPath;
-
+ protected String toggle;
+ protected String selectedNotifyTopics;
+ protected String expandedNotifyTopics;
+ protected String collapsedNotifyTopics;
+ protected String rootNode;
+ protected String childCollectionProperty;
+ protected String nodeTitleProperty;
+ protected String nodeIdProperty;
+ protected String showRootGrid;
+ protected String showGrid;
+ protected String blankIconSrc;
+ protected String gridIconSrcL;
+ protected String gridIconSrcV;
+ protected String gridIconSrcP;
+ protected String gridIconSrcC;
+ protected String gridIconSrcX;
+ protected String gridIconSrcY;
+ protected String expandIconSrcPlus;
+ protected String expandIconSrcMinus;
+ protected String iconWidth;
+ protected String iconHeight;
+ protected String toggleDuration;
+ protected String templateCssPath;
+ protected String href;
+ protected String errorNotifyTopics;
+
public Component getBean(ValueStack stack, HttpServletRequest req, HttpServletResponse res) {
return new Tree(stack,req,res);
}
@@ -70,53 +71,32 @@ public class TreeTag extends AbstractClosingTag {
super.populateParams();
Tree tree = (Tree) component;
- if (childCollectionProperty != null)
- tree.setChildCollectionProperty(childCollectionProperty);
- if (nodeIdProperty != null)
- tree.setNodeIdProperty(nodeIdProperty);
- if (nodeTitleProperty != null)
- tree.setNodeTitleProperty(nodeTitleProperty);
- if (rootNode != null)
- tree.setRootNode(rootNode);
- if (toggle != null)
- tree.setToggle(toggle);
- if (selectedNotifyTopics != null)
- tree.setSelectedNotifyTopics(selectedNotifyTopics);
- if (expandedNotifyTopics != null)
- tree.setExpandedNotifyTopics(expandedNotifyTopics);
- if (collapsedNotifyTopics != null)
- tree.setCollapsedNotifyTopics(collapsedNotifyTopics);
- if (showRootGrid != null)
- tree.setShowRootGrid(showRootGrid);
+ tree.setChildCollectionProperty(childCollectionProperty);
+ tree.setNodeIdProperty(nodeIdProperty);
+ tree.setNodeTitleProperty(nodeTitleProperty);
+ tree.setRootNode(rootNode);
+ tree.setToggle(toggle);
+ tree.setSelectedNotifyTopics(selectedNotifyTopics);
+ tree.setExpandedNotifyTopics(expandedNotifyTopics);
+ tree.setCollapsedNotifyTopics(collapsedNotifyTopics);
+ tree.setShowRootGrid(showRootGrid);
- if (showGrid != null)
- tree.setShowGrid(showGrid);
- if (blankIconSrc != null)
- tree.setBlankIconSrc(blankIconSrc);
- if (gridIconSrcL != null)
- tree.setGridIconSrcL(gridIconSrcC);
- if (gridIconSrcV != null)
- tree.setGridIconSrcV(gridIconSrcV);
- if (gridIconSrcP != null)
- tree.setGridIconSrcP(gridIconSrcP);
- if (gridIconSrcC != null)
- tree.setGridIconSrcC(gridIconSrcC);
- if (gridIconSrcX != null)
- tree.setGridIconSrcX(gridIconSrcX);
- if (gridIconSrcY != null)
- tree.setGridIconSrcY(gridIconSrcY);
- if (expandIconSrcPlus != null)
- tree.setExpandIconSrcPlus(expandIconSrcPlus);
- if (expandIconSrcMinus != null)
- tree.setExpandIconSrcMinus(expandIconSrcMinus);
- if (iconWidth != null)
- tree.setIconWidth(iconWidth);
- if (iconHeight != null)
- tree.setIconHeight(iconHeight);
- if (toggleDuration != null)
- tree.setToggleDuration(toggleDuration);
- if (templateCssPath != null)
- tree.setTemplateCssPath(templateCssPath);
+ tree.setShowGrid(showGrid);
+ tree.setBlankIconSrc(blankIconSrc);
+ tree.setGridIconSrcL(gridIconSrcC);
+ tree.setGridIconSrcV(gridIconSrcV);
+ tree.setGridIconSrcP(gridIconSrcP);
+ tree.setGridIconSrcC(gridIconSrcC);
+ tree.setGridIconSrcX(gridIconSrcX);
+ tree.setGridIconSrcY(gridIconSrcY);
+ tree.setExpandIconSrcPlus(expandIconSrcPlus);
+ tree.setExpandIconSrcMinus(expandIconSrcMinus);
+ tree.setIconWidth(iconWidth);
+ tree.setIconHeight(iconHeight);
+ tree.setToggleDuration(toggleDuration);
+ tree.setTemplateCssPath(templateCssPath);
+ tree.setHref(href);
+ tree.setErrorNotifyTopics(errorNotifyTopics);
}
public String getToggle() {
@@ -305,5 +285,13 @@ public class TreeTag extends AbstractClosingTag {
public void setSelectedNotifyTopics(String selectedNotifyTopics) {
this.selectedNotifyTopics = selectedNotifyTopics;
}
+
+ public void setHref(String href) {
+ this.href = href;
+ }
+
+ public void setErrorNotifyTopics(String errorNotifyTopics) {
+ this.errorNotifyTopics = errorNotifyTopics;
+ }
}
diff --git a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/StrutsTree.js b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/StrutsTree.js
new file mode 100644
index 000000000..fa4a26330
--- /dev/null
+++ b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/StrutsTree.js
@@ -0,0 +1,59 @@
+dojo.provide("struts.widget.StrutsTree");
+
+dojo.require("dojo.widget.Tree");
+
+dojo.widget.defineWidget(
+ "struts.widget.StrutsTree",
+ dojo.widget.Tree, {
+ widgetType : "StrutsTree",
+
+ href : "",
+ errorNotifyTopics : "",
+ errorNotifyTopicsArray : null,
+
+ postCreate : function() {
+ struts.widget.StrutsTree.superclass.postCreate.apply(this);
+
+ //error topics
+ if(!dojo.string.isBlank(this.errorNotifyTopics)) {
+ this.errorNotifyTopicsArray = this.errorNotifyTopics.split(",");
+ }
+
+ var self = this;
+ if(!dojo.string.isBlank(this.href)) {
+ dojo.io.bind({
+ url: this.href,
+ useCache: false,
+ preventCache: true,
+ handler: function(type, data, e) {
+ if(type == 'load') {
+ //data should be an array
+ if(data) {
+ dojo.lang.forEach(data, function(descr) {
+ //create node for eachd descriptor
+ var newNode = dojo.widget.createWidget("struts:StrutsTreeNode",{
+ title : descr.label,
+ isFolder: descr.hasChildren,
+ widgetId: descr.id
+ });
+ self.addChild(newNode);
+ });
+ }
+ } else {
+ //publish error topics
+ if(self.errorNotifyTopicsArray) {
+ dojo.lang.forEach(self.errorNotifyTopicsArray, function(topic) {
+ try {
+ dojo.event.topic.publish(topic, data, e, self);
+ } catch(ex){
+ dojo.debug(ex);
+ }
+ });
+ }
+ }
+ },
+ mimetype: "text/json"
+ });
+ }
+ }
+});
\ No newline at end of file
diff --git a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/StrutsTreeNode.js b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/StrutsTreeNode.js
new file mode 100644
index 000000000..1c5a80660
--- /dev/null
+++ b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/StrutsTreeNode.js
@@ -0,0 +1,66 @@
+dojo.provide("struts.widget.StrutsTreeNode");
+
+dojo.require("dojo.widget.TreeNode");
+
+dojo.widget.defineWidget(
+ "struts.widget.StrutsTreeNode",
+ dojo.widget.TreeNode, {
+ widgetType : "StrutsTreeNode",
+
+ loaded : false,
+
+ expand : function() {
+ if(!this.loaded) {
+ this.reload();
+ }
+ struts.widget.StrutsTreeNode.superclass.expand.apply(this);
+ },
+
+ removeChildren : function() {
+ var self = this;
+ var childrenCopy = dojo.lang.toArray(this.children);
+ dojo.lang.forEach(childrenCopy, function(node) {
+ self.removeNode(node);
+ });
+ },
+
+ reload : function() {
+ var href = this.tree.href;
+ this.loaded = true;
+
+ if(!dojo.string.isBlank(href)) {
+ //clear children list
+ this.removeChildren();
+ //pass widgetId as parameter
+ var tmpHref = href + (href.indexOf("?") > -1 ? "&" : "?") + "nodeId=" + this.widgetId;
+
+ var self = this;
+ this.markLoading();
+
+ dojo.io.bind({
+ url: tmpHref,
+ useCache: false,
+ preventCache: true,
+ handler: function(type, data, e) {
+ if(type == 'load') {
+ //data should be an array
+ if(data) {
+ dojo.lang.forEach(data, function(descr) {
+ //create node for eachd descriptor
+ var newNode = dojo.widget.createWidget("struts:StrutsTreeNode",{
+ title : descr.label,
+ isFolder: descr.hasChildren,
+ widgetId: descr.id
+ });
+ self.addChild(newNode);
+ });
+ }
+ }
+
+ self.unMarkLoading();
+ },
+ mimetype: "text/json"
+ });
+ }
+ }
+});
\ No newline at end of file
diff --git a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/__package__.js b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/__package__.js
index ddf55e554..8f1f6fcd2 100644
--- a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/__package__.js
+++ b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts/widget/__package__.js
@@ -7,6 +7,8 @@ dojo.kwCompoundRequire({
"struts.widget.StrutsDatePicker",
"struts.widget.BindEvent",
"struts.widget.StrutsTreeSelector",
- "struts.widget.StrutsTabContainer"]
+ "struts.widget.StrutsTabContainer",
+ "struts.widget.StrutsTreeNode",
+ "struts.widget.StrutsTree"]
});
dojo.provide("struts.widget.*");
diff --git a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js
index 54dc8658f..cdd0bbf5f 100644
--- a/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js
+++ b/plugins/dojo/src/main/resources/org/apache/struts2/static/dojo/struts_dojo.js
@@ -17706,6 +17706,968 @@ return t;
}
}
}});
-dojo.kwCompoundRequire({common:["struts.widget.Bind","struts.widget.BindDiv","struts.widget.BindAnchor","struts.widget.ComboBox","struts.widget.StrutsTimePicker","struts.widget.StrutsDatePicker","struts.widget.BindEvent","struts.widget.StrutsTreeSelector","struts.widget.StrutsTabContainer"]});
+dojo.provide("dojo.widget.TreeNode");
+dojo.widget.defineWidget("dojo.widget.TreeNode",dojo.widget.HtmlWidget,function(){
+this.actionsDisabled=[];
+},{widgetType:"TreeNode",loadStates:{UNCHECKED:"UNCHECKED",LOADING:"LOADING",LOADED:"LOADED"},actions:{MOVE:"MOVE",REMOVE:"REMOVE",EDIT:"EDIT",ADDCHILD:"ADDCHILD"},isContainer:true,lockLevel:0,templateString:(" "+"
"+"\t\t${this.title} "+" "+"
${this.afterLabel} "+"
"+"
'
+ + '
'
+ + ' ${this.title} '
+ + ' '
+ + '
${this.afterLabel} '
+ + '
'
+ + '
+ href="${parameters.href}"
+
+ <#if parameters.errorNotifyTopics?if_exists != "">
+ errorNotifyTopics="${parameters.errorNotifyTopics?html}"<#rt/>
+
<#if parameters.blankIconSrc?exists>
gridIconSrcT="<@s.url value='${parameters.blankIconSrc}' encode="false" includeParams='none'/>"
@@ -77,15 +83,12 @@
|| parameters.collapsedNotifyTopics?exists>
selector="treeSelector_${parameters.id?default("")}"
- <#if parameters.treeCollapsedTopic?exists>
- publishCollapsedTopic="${parameters.treeCollapsedTopic?html}"
-
<#if parameters.toggle?exists>
toggle="${parameters.toggle?html}"
>
<#if parameters.label?exists>
-
id="${stack.findValue(parameters.nodeIdProperty)}"
<#else>
diff --git a/plugins/dojo/src/main/resources/template/ajax/treenode-include.ftl b/plugins/dojo/src/main/resources/template/ajax/treenode-include.ftl
index 02c2d1d75..e594e19a6 100644
--- a/plugins/dojo/src/main/resources/template/ajax/treenode-include.ftl
+++ b/plugins/dojo/src/main/resources/template/ajax/treenode-include.ftl
@@ -1,4 +1,4 @@
-
+
<#list stack.findValue(parameters.childCollectionProperty.toString()) as child>
${stack.push(child)}
<#include "/${parameters.templateDir}/ajax/treenode-include.ftl" />
diff --git a/plugins/dojo/src/main/resources/template/ajax/treenode.ftl b/plugins/dojo/src/main/resources/template/ajax/treenode.ftl
index 858ed45e0..bffa9c606 100644
--- a/plugins/dojo/src/main/resources/template/ajax/treenode.ftl
+++ b/plugins/dojo/src/main/resources/template/ajax/treenode.ftl
@@ -1,4 +1,4 @@
-
childIconSrc="<@s.url value='${parameters.childIconSrc}' includeParams='none' encode='false' />"
diff --git a/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/tree-1.txt b/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/tree-1.txt
index eadb67ce2..302cf16e2 100644
--- a/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/tree-1.txt
+++ b/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/tree-1.txt
@@ -6,36 +6,36 @@
// dojo.hostenv.writeIncludes();
-->
-
-
-
-
-
diff --git a/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/tree-2.txt b/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/tree-2.txt
index f64c2b601..a7a871bb3 100644
--- a/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/tree-2.txt
+++ b/plugins/dojo/src/test/resources/org/apache/struts2/dojo/views/jsp/ui/tree-2.txt
@@ -6,58 +6,58 @@
// dojo.hostenv.writeIncludes();
-->
-