You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ad...@apache.org on 2015/01/04 01:12:24 UTC
svn commit: r1649275 - in
/ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree: ModelTree.java
ModelTreeAction.java
Author: adrianc
Date: Sun Jan 4 00:12:24 2015
New Revision: 1649275
URL: http://svn.apache.org/r1649275
Log:
Tree widget documentation, no functional change.
Modified:
ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree/ModelTree.java
ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree/ModelTreeAction.java
Modified: ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree/ModelTree.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree/ModelTree.java?rev=1649275&r1=1649274&r2=1649275&view=diff
==============================================================================
--- ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree/ModelTree.java (original)
+++ ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree/ModelTree.java Sun Jan 4 00:12:24 2015
@@ -68,6 +68,20 @@ import org.xml.sax.SAXException;
@SuppressWarnings("serial")
public class ModelTree extends ModelWidget {
+ /*
+ * ----------------------------------------------------------------------- *
+ * DEVELOPERS PLEASE READ
+ * ----------------------------------------------------------------------- *
+ *
+ * This model is intended to be a read-only data structure that represents
+ * an XML element. Outside of object construction, the class should not
+ * have any behaviors.
+ *
+ * Instances of this class will be shared by multiple threads - therefore
+ * it is immutable. DO NOT CHANGE THE OBJECT'S STATE AT RUN TIME!
+ *
+ */
+
public static final String module = ModelTree.class.getName();
private final String defaultEntityName;
@@ -82,9 +96,6 @@ public class ModelTree extends ModelWidg
private final String rootNodeName;
private final FlexibleStringExpander trailNameExdr;
- // ===== CONSTRUCTORS =====
- /** Default Constructor */
-
public ModelTree(Element treeElement, String location) {
super(treeElement);
this.location = location;
@@ -258,6 +269,11 @@ public class ModelTree extends ModelWidg
}
}
+ /**
+ * Models the <node> element.
+ *
+ * @see <code>widget-tree.xsd</code>
+ */
public static class ModelNode extends ModelWidget {
private final List<ModelWidgetAction> actions;
@@ -920,6 +936,11 @@ public class ModelTree extends ModelWidg
}
}
+ /**
+ * Models the <sub-node> element.
+ *
+ * @see <code>widget-tree.xsd</code>
+ */
public static class ModelSubNode extends ModelWidget {
private final List<ModelWidgetAction> actions;
Modified: ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree/ModelTreeAction.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree/ModelTreeAction.java?rev=1649275&r1=1649274&r2=1649275&view=diff
==============================================================================
--- ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree/ModelTreeAction.java (original)
+++ ofbiz/trunk/framework/widget/src/org/ofbiz/widget/tree/ModelTreeAction.java Sun Jan 4 00:12:24 2015
@@ -51,12 +51,27 @@ import org.ofbiz.widget.WidgetWorker;
import org.ofbiz.widget.tree.ModelTree.ModelNode;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
+
/**
* Abstract tree action.
*/
@SuppressWarnings("serial")
public abstract class ModelTreeAction extends ModelWidgetAction {
+ /*
+ * ----------------------------------------------------------------------- *
+ * DEVELOPERS PLEASE READ
+ * ----------------------------------------------------------------------- *
+ *
+ * This model is intended to be a read-only data structure that represents
+ * an XML element. Outside of object construction, the class should not
+ * have any behaviors.
+ *
+ * Instances of this class will be shared by multiple threads - therefore
+ * it is immutable. DO NOT CHANGE THE OBJECT'S STATE AT RUN TIME!
+ *
+ */
+
public static final String module = ModelTreeAction.class.getName();
public static List<ModelWidgetAction> readNodeActions(ModelWidget modelNode, Element actionsElement) {
@@ -94,6 +109,11 @@ public abstract class ModelTreeAction ex
return modelTree;
}
+ /**
+ * Models the <entity-and> element.
+ *
+ * @see <code>widget-tree.xsd</code>
+ */
public static class EntityAnd extends ModelTreeAction {
private final ByAndFinder finder;
private final String listName;
@@ -149,6 +169,11 @@ public abstract class ModelTreeAction ex
}
}
+ /**
+ * Models the <entity-condition> element.
+ *
+ * @see <code>widget-tree.xsd</code>
+ */
public static class EntityCondition extends ModelTreeAction {
private final ByConditionFinder finder;
private final String listName;
@@ -204,6 +229,11 @@ public abstract class ModelTreeAction ex
}
}
+ /**
+ * Models the <script> element.
+ *
+ * @see <code>widget-tree.xsd</code>
+ */
public static class Script extends ModelTreeAction {
private final String location;
private final String method;
@@ -267,6 +297,11 @@ public abstract class ModelTreeAction ex
}
}
+ /**
+ * Models the <service> element.
+ *
+ * @see <code>widget-tree.xsd</code>
+ */
public static class Service extends ModelTreeAction {
private final FlexibleStringExpander autoFieldMapExdr;
private final Map<FlexibleMapAccessor<Object>, Object> fieldMap;