You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@cocoon.apache.org by sy...@apache.org on 2005/10/20 18:03:37 UTC
svn commit: r326930 - in /cocoon/blocks/forms/trunk:
java/org/apache/cocoon/forms/event/ java/org/apache/cocoon/forms/formmodel/
java/org/apache/cocoon/forms/resources/ samples/forms/
Author: sylvain
Date: Thu Oct 20 09:03:19 2005
New Revision: 326930
URL: http://svn.apache.org/viewcvs?rev=326930&view=rev
Log:
Fields with value-changed listeners are triggering form submit automatically. <fi:styling submit-on-change="true"> is no more needed"
Modified:
cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/event/ValueChangedListenerEnabled.java
cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/AbstractWidget.java
cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/BooleanField.java
cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/BooleanFieldDefinition.java
cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/Field.java
cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/Form.java
cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/resources/forms-field-styling.xsl
cocoon/blocks/forms/trunk/samples/forms/carselector_template.xml
cocoon/blocks/forms/trunk/samples/forms/countryselector_template.xml
cocoon/blocks/forms/trunk/samples/forms/datasource_chooser_template.xml
cocoon/blocks/forms/trunk/samples/forms/form1_template.xml
cocoon/blocks/forms/trunk/samples/forms/form1_template_action.xml
cocoon/blocks/forms/trunk/samples/forms/form1_template_action_jx-macro.xml
cocoon/blocks/forms/trunk/samples/forms/form_model_gui_template.xml
cocoon/blocks/forms/trunk/samples/forms/multipage_template.xml
cocoon/blocks/forms/trunk/samples/forms/xhr_carselector_template.xml
Modified: cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/event/ValueChangedListenerEnabled.java
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/event/ValueChangedListenerEnabled.java?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/event/ValueChangedListenerEnabled.java (original)
+++ cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/event/ValueChangedListenerEnabled.java Thu Oct 20 09:03:19 2005
@@ -23,4 +23,6 @@
public void addValueChangedListener(ValueChangedListener listener);
public void removeValueChangedListener(ValueChangedListener listener);
+
+ public boolean hasValueChangedListeners();
}
Modified: cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/AbstractWidget.java
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/AbstractWidget.java?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/AbstractWidget.java (original)
+++ cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/AbstractWidget.java Thu Oct 20 09:03:19 2005
@@ -24,6 +24,7 @@
import org.apache.cocoon.forms.FormsConstants;
import org.apache.cocoon.forms.event.CreateEvent;
+import org.apache.cocoon.forms.event.ValueChangedListenerEnabled;
import org.apache.cocoon.forms.event.WidgetEvent;
import org.apache.cocoon.forms.validation.ValidationErrorAware;
import org.apache.cocoon.forms.validation.WidgetValidator;
@@ -432,6 +433,12 @@
WidgetState state = getCombinedState();
if (state != WidgetState.ACTIVE) {
attrs.addCDATAAttribute("state", getCombinedState().getName());
+ }
+
+ // Add the "listening" attribute is the value has change listeners
+ if (this instanceof ValueChangedListenerEnabled &&
+ ((ValueChangedListenerEnabled)this).hasValueChangedListeners()) {
+ attrs.addCDATAAttribute("listening", "true");
}
return attrs;
}
Modified: cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/BooleanField.java
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/BooleanField.java?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/BooleanField.java (original)
+++ cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/BooleanField.java Thu Oct 20 09:03:19 2005
@@ -60,6 +60,7 @@
public BooleanField(BooleanFieldDefinition definition) {
super(definition);
this.definition = definition;
+ this.listener = definition.getValueChangedListener();
}
public WidgetDefinition getDefinition() {
@@ -160,7 +161,9 @@
value = (Boolean)object;
if (!value.equals(oldValue)) {
Form form = getForm();
- form.addWidgetEvent(new ValueChangedEvent(this, oldValue, value));
+ if (hasValueChangedListeners()) {
+ form.addWidgetEvent(new ValueChangedEvent(this, oldValue, value));
+ }
form.addWidgetUpdate(this);
}
}
@@ -177,17 +180,16 @@
public void removeValueChangedListener(ValueChangedListener listener) {
this.listener = WidgetEventMulticaster.remove(this.listener, listener);
}
-
- private void fireValueChangedEvent(ValueChangedEvent event) {
- if (this.listener != null) {
- this.listener.valueChanged(event);
- }
+
+ public boolean hasValueChangedListeners() {
+ return this.listener != null || this.getForm().hasFormHandler();
}
public void broadcastEvent(WidgetEvent event) {
if (event instanceof ValueChangedEvent) {
- this.definition.fireValueChangedEvent((ValueChangedEvent)event);
- fireValueChangedEvent((ValueChangedEvent)event);
+ if (this.listener != null) {
+ this.listener.valueChanged((ValueChangedEvent)event);
+ }
} else {
// Other kinds of events
super.broadcastEvent(event);
Modified: cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/BooleanFieldDefinition.java
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/BooleanFieldDefinition.java?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/BooleanFieldDefinition.java (original)
+++ cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/BooleanFieldDefinition.java Thu Oct 20 09:03:19 2005
@@ -80,6 +80,10 @@
this.listener = WidgetEventMulticaster.add(this.listener, listener);
}
+ public ValueChangedListener getValueChangedListener() {
+ return this.listener;
+ }
+
public void fireValueChangedEvent(ValueChangedEvent event) {
if (this.listener != null) {
this.listener.valueChanged(event);
Modified: cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/Field.java
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/Field.java?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/Field.java (original)
+++ cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/Field.java Thu Oct 20 09:03:19 2005
@@ -119,6 +119,7 @@
public Field(FieldDefinition fieldDefinition) {
super(fieldDefinition);
this.fieldDefinition = fieldDefinition;
+ this.listener = fieldDefinition.getValueChangedListener();
}
public final FieldDefinition getFieldDefinition() {
@@ -524,22 +525,15 @@
this.listener = WidgetEventMulticaster.remove(this.listener, listener);
}
- private boolean hasValueChangedListeners() {
- return this.listener != null ||
- this.fieldDefinition.hasValueChangedListeners() ||
- this.getForm().hasFormHandler();
- }
-
- private void fireValueChangedEvent(ValueChangedEvent event) {
- if (this.listener != null) {
- this.listener.valueChanged(event);
- }
+ public boolean hasValueChangedListeners() {
+ return this.listener != null || this.getForm().hasFormHandler();
}
public void broadcastEvent(WidgetEvent event) {
if (event instanceof ValueChangedEvent) {
- getFieldDefinition().fireValueChangedEvent((ValueChangedEvent)event);
- fireValueChangedEvent((ValueChangedEvent)event);
+ if (this.listener != null) {
+ this.listener.valueChanged((ValueChangedEvent)event);
+ }
} else {
// Other kinds of events
super.broadcastEvent(event);
Modified: cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/Form.java
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/Form.java?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/Form.java (original)
+++ cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/formmodel/Form.java Thu Oct 20 09:03:19 2005
@@ -200,13 +200,13 @@
*/
public void setSubmitWidget(Widget widget) {
if (this.submitWidget != null && this.submitWidget != widget) {
- throw new IllegalStateException("SubmitWidget already set to " + this.submitWidget +
+ throw new IllegalStateException("Submit widget already set to " + this.submitWidget +
". Cannot set also " + widget);
}
// Check that the submit widget is active
if (widget.getCombinedState() != WidgetState.ACTIVE) {
- throw new IllegalStateException("Widget " + widget + " that submited the form is not active.");
+ throw new IllegalStateException("Widget " + widget + " that submitted the form is not active.");
}
// If the submit widget is not an action (e.g. a field with an event listener),
Modified: cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/resources/forms-field-styling.xsl
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/resources/forms-field-styling.xsl?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/resources/forms-field-styling.xsl (original)
+++ cocoon/blocks/forms/trunk/java/org/apache/cocoon/forms/resources/forms-field-styling.xsl Thu Oct 20 09:03:19 2005
@@ -88,6 +88,11 @@
<xsl:template match="fi:*" mode="styling">
<xsl:apply-templates select="fi:styling/@*" mode="styling"/>
+ <!-- Auto submit on fields which are listening -->
+ <xsl:if test="@listening = 'true' and not(fi:styling/@submit-on-change = 'false')">
+ <xsl:attribute name="onchange">forms_submitForm(this)</xsl:attribute>
+ </xsl:if>
+
<xsl:if test="@state = 'disabled'">
<xsl:attribute name="disabled">disabled</xsl:attribute>
</xsl:if>
Modified: cocoon/blocks/forms/trunk/samples/forms/carselector_template.xml
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/samples/forms/carselector_template.xml?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/samples/forms/carselector_template.xml (original)
+++ cocoon/blocks/forms/trunk/samples/forms/carselector_template.xml Thu Oct 20 09:03:19 2005
@@ -65,15 +65,9 @@
<fi:group>
<fi:styling layout="columns"/>
<fi:items>
- <ft:widget id="make">
- <fi:styling submit-on-change="true"/>
- </ft:widget>
- <ft:widget id="type">
- <fi:styling submit-on-change="true"/>
- </ft:widget>
- <ft:widget id="model">
- <fi:styling submit-on-change="true"/>
- </ft:widget>
+ <ft:widget id="make"/>
+ <ft:widget id="type"/>
+ <ft:widget id="model"/>
<ft:widget id="message"/>
<ft:widget id="buy"/>
</fi:items>
Modified: cocoon/blocks/forms/trunk/samples/forms/countryselector_template.xml
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/samples/forms/countryselector_template.xml?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/samples/forms/countryselector_template.xml (original)
+++ cocoon/blocks/forms/trunk/samples/forms/countryselector_template.xml Thu Oct 20 09:03:19 2005
@@ -38,12 +38,8 @@
<fi:group>
<fi:styling layout="columns"/>
<fi:items>
- <ft:widget id="us-nonus">
- <fi:styling submit-on-change="true"/>
- </ft:widget>
- <ft:widget id="country">
- <fi:styling submit-on-change="true"/>
- </ft:widget>
+ <ft:widget id="us-nonus"/>
+ <ft:widget id="country"/>
<ft:widget id="message"/>
<input type="submit"/>
</fi:items>
Modified: cocoon/blocks/forms/trunk/samples/forms/datasource_chooser_template.xml
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/samples/forms/datasource_chooser_template.xml?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/samples/forms/datasource_chooser_template.xml (original)
+++ cocoon/blocks/forms/trunk/samples/forms/datasource_chooser_template.xml Thu Oct 20 09:03:19 2005
@@ -31,7 +31,7 @@
<p>Datasource name: <ft:widget id="name"/></p>
<fieldset>
<legend>Type:
- <ft:widget id="sourcetype"><fi:styling submit-on-change="true"/></ft:widget>
+ <ft:widget id="sourcetype"/>
</legend>
<ft:union id="datasource">
<ft:case id="">
Modified: cocoon/blocks/forms/trunk/samples/forms/form1_template.xml
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/samples/forms/form1_template.xml?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/samples/forms/form1_template.xml (original)
+++ cocoon/blocks/forms/trunk/samples/forms/form1_template.xml Thu Oct 20 09:03:19 2005
@@ -55,9 +55,7 @@
<fi:label>Number fields</fi:label>
<fi:styling layout="columns"/>
<fi:items>
- <ft:widget id="number1">
- <fi:styling submit-on-change="true"/>
- </ft:widget>
+ <ft:widget id="number1"/>
<ft:widget id="number2"/>
<ft:widget id="account"/>
<ft:widget id="cowheight">
Modified: cocoon/blocks/forms/trunk/samples/forms/form1_template_action.xml
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/samples/forms/form1_template_action.xml?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/samples/forms/form1_template_action.xml (original)
+++ cocoon/blocks/forms/trunk/samples/forms/form1_template_action.xml Thu Oct 20 09:03:19 2005
@@ -51,9 +51,7 @@
<fi:label>Number fields</fi:label>
<fi:styling layout="columns"/>
<fi:items>
- <ft:widget id="number1">
- <fi:styling submit-on-change="true"/>
- </ft:widget>
+ <ft:widget id="number1"/>
<ft:widget id="number2"/>
<ft:widget id="account"/>
<ft:widget id="cowheight">
Modified: cocoon/blocks/forms/trunk/samples/forms/form1_template_action_jx-macro.xml
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/samples/forms/form1_template_action_jx-macro.xml?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/samples/forms/form1_template_action_jx-macro.xml (original)
+++ cocoon/blocks/forms/trunk/samples/forms/form1_template_action_jx-macro.xml Thu Oct 20 09:03:19 2005
@@ -54,9 +54,7 @@
<fi:label>Number fields</fi:label>
<fi:styling layout="columns"/>
<fi:items>
- <ft:widget id="number1">
- <fi:styling submit-on-change="true"/>
- </ft:widget>
+ <ft:widget id="number1"/>
<ft:widget id="number2"/>
<ft:widget id="account"/>
<ft:widget id="cowheight">
Modified: cocoon/blocks/forms/trunk/samples/forms/form_model_gui_template.xml
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/samples/forms/form_model_gui_template.xml?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/samples/forms/form_model_gui_template.xml (original)
+++ cocoon/blocks/forms/trunk/samples/forms/form_model_gui_template.xml Thu Oct 20 09:03:19 2005
@@ -44,7 +44,7 @@
</td>
<td>
<ft:widget id="type">
- <fi:styling list-type="dropdown" submit-on-change="true"/>
+ <fi:styling list-type="dropdown"/>
</ft:widget>
<ft:union id="union">
Modified: cocoon/blocks/forms/trunk/samples/forms/multipage_template.xml
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/samples/forms/multipage_template.xml?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/samples/forms/multipage_template.xml (original)
+++ cocoon/blocks/forms/trunk/samples/forms/multipage_template.xml Thu Oct 20 09:03:19 2005
@@ -59,9 +59,7 @@
<fi:label>Number fields</fi:label>
<fi:styling type="fieldset" layout="columns"/>
<fi:items>
- <ft:widget id="number1">
- <fi:styling submit-on-change="true"/>
- </ft:widget>
+ <ft:widget id="number1"/>
<ft:widget id="number2"/>
<ft:widget id="account"/>
<ft:widget id="cowheight">
Modified: cocoon/blocks/forms/trunk/samples/forms/xhr_carselector_template.xml
URL: http://svn.apache.org/viewcvs/cocoon/blocks/forms/trunk/samples/forms/xhr_carselector_template.xml?rev=326930&r1=326929&r2=326930&view=diff
==============================================================================
--- cocoon/blocks/forms/trunk/samples/forms/xhr_carselector_template.xml (original)
+++ cocoon/blocks/forms/trunk/samples/forms/xhr_carselector_template.xml Thu Oct 20 09:03:19 2005
@@ -108,9 +108,7 @@
<ft:widget id="type">
<fi:styling submit-on-change="false" onchange="changeType(document.getElementById('make'), this); return false;"/>
</ft:widget>
- <ft:widget id="model">
- <fi:styling submit-on-change="true"/>
- </ft:widget>
+ <ft:widget id="model"/>
<ft:widget id="message"/>
<input type="submit" value="Buy it!"/>
</fi:items>
Re: svn commit: r326930 - in /cocoon/blocks/forms/trunk: java/org/apache/cocoon/forms/event/
java/org/apache/cocoon/forms/formmodel/ java/org/apache/cocoon/forms/resources/
samples/forms/
Posted by Joerg Heinicke <jo...@gmx.de>.
On 23.10.2005 10:52, Sylvain Wallez wrote:
> The only case where form behaviour will be different will be for fields
> that have change listeners but no submit-on-change="true" in the
> template. These forms will not be broken, but will roundtrip too much to
> the server.
It depends on how you define "broken". A changed behaviour might be a
break too.
Your change seems to be sensible though. What did we learn at GT about
simplifying Cocoon: "configuration by exception" or "convention over
configuration".
Don't we have a upgrading guide where this change can/should be mentioned?
Jörg
Re: svn commit: r326930 - in /cocoon/blocks/forms/trunk: java/org/apache/cocoon/forms/event/
java/org/apache/cocoon/forms/formmodel/ java/org/apache/cocoon/forms/resources/
samples/forms/
Posted by Vadim Gritsenko <va...@reverycodes.com>.
Sylvain Wallez wrote:
> Vadim Gritsenko wrote:
>
>> - but please mention that when upgrading from 2.1.7 all templates has
>> to be updated to include submit-on-change="false" to keep'em forms
>> from breaking:
>>
>> <ft id="foo">
>> <fi:styling submit-on-change="false">
>> </ft>
>
> Sorry, I don't see the point here. The submit-on-change is automatic for
> those fields that _do have_ change listeners. From my experience, most
> if not all fields with change listeners have a submit-on-change='true',
> meaning nothing will change for the vast majority of forms.
My experience is inverse: most fields with change listeners have no
submit-on-change.
> The only case where form behaviour will be different will be for fields
> that have change listeners but no submit-on-change="true" in the
> template. These forms will not be broken, but will roundtrip too much to
> the server.
That's exactly the scenario which I meant. Some forms will be broken, as
previously you could rely on fact that form submit happens only once, when form
is submitted. Now, you will get multiple form round-trips per single submit.
That is significant departure in logic which warrants mentioning.
Vadim
Re: svn commit: r326930 - in /cocoon/blocks/forms/trunk: java/org/apache/cocoon/forms/event/
java/org/apache/cocoon/forms/formmodel/ java/org/apache/cocoon/forms/resources/
samples/forms/
Posted by Sylvain Wallez <sy...@apache.org>.
Vadim Gritsenko wrote:
> sylvain@apache.org wrote:
>> Author: sylvain
>> Date: Thu Oct 20 09:03:19 2005
>> New Revision: 326930
>>
>> URL: http://svn.apache.org/viewcvs?rev=326930&view=rev
>> Log:
>> Fields with value-changed listeners are triggering form submit
>> automatically. <fi:styling submit-on-change="true"> is no more needed"
>
> That's significant change. I don't see an entry in (2.1) status.xml yet
That's right. I wanted to commit things before the code freeze, and will
update status.xml and docs this week.
> - but please mention that when upgrading from 2.1.7 all templates has
> to be updated to include submit-on-change="false" to keep'em forms
> from breaking:
>
> <ft id="foo">
> <fi:styling submit-on-change="false">
> </ft>
Sorry, I don't see the point here. The submit-on-change is automatic for
those fields that _do have_ change listeners. From my experience, most
if not all fields with change listeners have a submit-on-change='true',
meaning nothing will change for the vast majority of forms.
The only case where form behaviour will be different will be for fields
that have change listeners but no submit-on-change="true" in the
template. These forms will not be broken, but will roundtrip too much to
the server.
Sylvain
--
Sylvain Wallez Anyware Technologies
http://people.apache.org/~sylvain http://www.anyware-tech.com
Apache Software Foundation Member Research & Technology Director
Re: svn commit: r326930 - in /cocoon/blocks/forms/trunk: java/org/apache/cocoon/forms/event/
java/org/apache/cocoon/forms/formmodel/ java/org/apache/cocoon/forms/resources/
samples/forms/
Posted by Vadim Gritsenko <va...@reverycodes.com>.
sylvain@apache.org wrote:
> Author: sylvain
> Date: Thu Oct 20 09:03:19 2005
> New Revision: 326930
>
> URL: http://svn.apache.org/viewcvs?rev=326930&view=rev
> Log:
> Fields with value-changed listeners are triggering form submit automatically. <fi:styling submit-on-change="true"> is no more needed"
That's significant change. I don't see an entry in (2.1) status.xml yet - but
please mention that when upgrading from 2.1.7 all templates has to be updated to
include submit-on-change="false" to keep'em forms from breaking:
<ft id="foo">
<fi:styling submit-on-change="false">
</ft>
Vadim