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 14:41:04 UTC
svn commit: r1649331 - in
/ofbiz/trunk/framework/widget/src/org/ofbiz/widget: ModelWidgetAction.java
form/ModelFormAction.java menu/ModelMenuAction.java
Author: adrianc
Date: Sun Jan 4 13:41:03 2015
New Revision: 1649331
URL: http://svn.apache.org/r1649331
Log:
JavaDocs for widget actions, no functional change.
Modified:
ofbiz/trunk/framework/widget/src/org/ofbiz/widget/ModelWidgetAction.java
ofbiz/trunk/framework/widget/src/org/ofbiz/widget/form/ModelFormAction.java
ofbiz/trunk/framework/widget/src/org/ofbiz/widget/menu/ModelMenuAction.java
Modified: ofbiz/trunk/framework/widget/src/org/ofbiz/widget/ModelWidgetAction.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/widget/src/org/ofbiz/widget/ModelWidgetAction.java?rev=1649331&r1=1649330&r2=1649331&view=diff
==============================================================================
--- ofbiz/trunk/framework/widget/src/org/ofbiz/widget/ModelWidgetAction.java (original)
+++ ofbiz/trunk/framework/widget/src/org/ofbiz/widget/ModelWidgetAction.java Sun Jan 4 13:41:03 2015
@@ -82,6 +82,13 @@ public abstract class ModelWidgetAction
public static final String module = ModelWidgetAction.class.getName();
+ /**
+ * Returns a new <code>ModelWidgetAction</code> instance, built from <code>actionElement</code>.
+ *
+ * @param modelWidget The <code>ModelWidget</code> that contains the <actions> element
+ * @param actionElement
+ * @return A new <code>ModelWidgetAction</code> instance
+ */
public static ModelWidgetAction newInstance(ModelWidget modelWidget, Element actionElement) {
if ("set".equals(actionElement.getNodeName())) {
return new SetField(modelWidget, actionElement);
@@ -117,6 +124,12 @@ public abstract class ModelWidgetAction
return Collections.unmodifiableList(actions);
}
+ /**
+ * Executes the actions contained in <code>actions</code>.
+ *
+ * @param actions
+ * @param context
+ */
public static void runSubActions(List<ModelWidgetAction> actions, Map<String, Object> context) {
if (actions == null)
return;
@@ -146,12 +159,28 @@ public abstract class ModelWidgetAction
public abstract void accept(ModelActionVisitor visitor);
+ /**
+ * Returns the <code>ModelWidget</code> that contains the <actions> element.
+ *
+ * @return The <code>ModelWidget</code> that contains the <actions> element
+ */
public ModelWidget getModelWidget() {
return modelWidget;
}
+ /**
+ * Executes this action.
+ *
+ * @param context
+ * @throws GeneralException
+ */
public abstract void runAction(Map<String, Object> context) throws GeneralException;
+ /**
+ * Models the <entity-and> element.
+ *
+ * @see <code>widget-screen.xsd</code>
+ */
public static class EntityAnd extends ModelWidgetAction {
private final ByAndFinder finder;
@@ -181,6 +210,11 @@ public abstract class ModelWidgetAction
}
}
+ /**
+ * Models the <entity-condition> element.
+ *
+ * @see <code>widget-screen.xsd</code>
+ */
public static class EntityCondition extends ModelWidgetAction {
private final ByConditionFinder finder;
@@ -210,6 +244,11 @@ public abstract class ModelWidgetAction
}
}
+ /**
+ * Models the <entity-one> element.
+ *
+ * @see <code>widget-common.xsd</code>
+ */
public static class EntityOne extends ModelWidgetAction {
private final PrimaryKeyFinder finder;
@@ -239,6 +278,11 @@ public abstract class ModelWidgetAction
}
}
+ /**
+ * Models the <get-related> element.
+ *
+ * @see <code>widget-common.xsd</code>
+ */
public static class GetRelated extends ModelWidgetAction {
private final FlexibleMapAccessor<List<GenericValue>> listNameAcsr;
private final FlexibleMapAccessor<Map<String, Object>> mapAcsr;
@@ -299,6 +343,11 @@ public abstract class ModelWidgetAction
}
}
+ /**
+ * Models the <get-related-one> element.
+ *
+ * @see <code>widget-common.xsd</code>
+ */
public static class GetRelatedOne extends ModelWidgetAction {
private final String relationName;
private final FlexibleMapAccessor<Object> toValueNameAcsr;
@@ -347,6 +396,11 @@ public abstract class ModelWidgetAction
}
}
+ /**
+ * Models the <property-map> element.
+ *
+ * @see <code>widget-common.xsd</code>
+ */
public static class PropertyMap extends ModelWidgetAction {
private final FlexibleStringExpander globalExdr;
private final FlexibleMapAccessor<ResourceBundleMapWrapper> mapNameAcsr;
@@ -404,6 +458,11 @@ public abstract class ModelWidgetAction
}
}
+ /**
+ * Models the <property-to-field> element.
+ *
+ * @see <code>widget-common.xsd</code>
+ */
public static class PropertyToField extends ModelWidgetAction {
private final FlexibleMapAccessor<List<? extends Object>> argListAcsr;
private final FlexibleStringExpander defaultExdr;
@@ -460,6 +519,11 @@ public abstract class ModelWidgetAction
}
}
+ /**
+ * Models the <script> element.
+ *
+ * @see <code>widget-common.xsd</code>
+ */
public static class Script extends ModelWidgetAction {
private final String location;
private final String method;
@@ -495,6 +559,11 @@ public abstract class ModelWidgetAction
}
}
+ /**
+ * Models the <service> element.
+ *
+ * @see <code>widget-screen.xsd</code>
+ */
public static class Service extends ModelWidgetAction {
private final FlexibleStringExpander autoFieldMapExdr;
private final Map<FlexibleMapAccessor<Object>, Object> fieldMap;
@@ -576,6 +645,11 @@ public abstract class ModelWidgetAction
}
}
+ /**
+ * Models the <set> element.
+ *
+ * @see <code>widget-common.xsd</code>
+ */
public static class SetField extends ModelWidgetAction {
private final FlexibleStringExpander defaultExdr;
private final FlexibleMapAccessor<Object> field;
Modified: ofbiz/trunk/framework/widget/src/org/ofbiz/widget/form/ModelFormAction.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/widget/src/org/ofbiz/widget/form/ModelFormAction.java?rev=1649331&r1=1649330&r2=1649331&view=diff
==============================================================================
--- ofbiz/trunk/framework/widget/src/org/ofbiz/widget/form/ModelFormAction.java (original)
+++ ofbiz/trunk/framework/widget/src/org/ofbiz/widget/form/ModelFormAction.java Sun Jan 4 13:41:03 2015
@@ -72,6 +72,11 @@ public abstract class ModelFormAction {
return Collections.unmodifiableList(actions);
}
+ /**
+ * Models the <call-parent-actions> element.
+ *
+ * @see <code>widget-form.xsd</code>
+ */
@SuppressWarnings("serial")
public static class CallParentActions extends ModelWidgetAction {
private final ActionsKind kind;;
@@ -117,6 +122,11 @@ public abstract class ModelFormAction {
}
}
+ /**
+ * Models the <service> element.
+ *
+ * @see <code>widget-form.xsd</code>
+ */
@SuppressWarnings("serial")
public static class Service extends ModelWidgetAction {
private final FlexibleStringExpander autoFieldMapExdr;
Modified: ofbiz/trunk/framework/widget/src/org/ofbiz/widget/menu/ModelMenuAction.java
URL: http://svn.apache.org/viewvc/ofbiz/trunk/framework/widget/src/org/ofbiz/widget/menu/ModelMenuAction.java?rev=1649331&r1=1649330&r2=1649331&view=diff
==============================================================================
--- ofbiz/trunk/framework/widget/src/org/ofbiz/widget/menu/ModelMenuAction.java (original)
+++ ofbiz/trunk/framework/widget/src/org/ofbiz/widget/menu/ModelMenuAction.java Sun Jan 4 13:41:03 2015
@@ -43,7 +43,7 @@ import org.ofbiz.widget.ModelWidgetActio
import org.w3c.dom.Element;
/**
- * Widget Library - Screen model class
+ * Abstract menu action.
*/
public abstract class ModelMenuAction {
@@ -62,6 +62,11 @@ public abstract class ModelMenuAction {
return Collections.unmodifiableList(actions);
}
+ /**
+ * Models the <set> element.
+ *
+ * @see <code>widget-common.xsd</code>
+ */
@SuppressWarnings("serial")
public static class SetField extends ModelWidgetAction {
private final FlexibleMapAccessor<Object> field;