tapestry-framework/src/java/org/apache/tapestry/valid/ValidationDelegate.java - tapestry4 - Git at Google

 // Copyright 2004, 2005 The Apache Software Foundation
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
 //
 //     http://www.apache.org/licenses/LICENSE-2.0
 //
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.

 package org.apache.tapestry.valid;

 import org.apache.tapestry.IMarkupWriter;
 import org.apache.tapestry.IRender;
 import org.apache.tapestry.IRequestCycle;
 import org.apache.tapestry.Tapestry;
 import org.apache.tapestry.form.IFormComponent;

 import java.util.*;

 /**
  * A base implementation of {@link IValidationDelegate} that can be used as a
  * managed bean. This class is often subclassed, typically to override
  * presentation details.
  *
  * @author Howard Lewis Ship
  * @since 1.0.5
  */

 public class ValidationDelegate implements IValidationDelegate
 {

     private static final long serialVersionUID = 6215074338439140780L;

     private transient IFormComponent _currentComponent;

     private transient String _focusField;

     private transient int _focusPriority = -1;

     /**
      * A list of {@link IFieldTracking}.
      */

     private final List _trackings = new ArrayList();

     /**
      * A map of {@link IFieldTracking}, keyed on form element name.
      */

     private final Map _trackingMap = new HashMap();

     public void clear()
     {
         _currentComponent = null;
         _trackings.clear();
         _trackingMap.clear();
     }

     public void clearErrors()
     {
         if (_trackings == null)
             return;

         Iterator i = _trackings.iterator();
         while(i.hasNext())
         {
             FieldTracking ft = (FieldTracking) i.next();
             ft.setErrorRenderer(null);
             ft.setRenderError(false);
         }
     }

     /**
      * If the form component is in error, places a &lt;font color="red"&lt;
      * around it. Note: this will only work on the render phase after a rewind,
      * and will be confused if components are inside any kind of loop.
      */

     public void writeLabelPrefix(IFormComponent component,
             IMarkupWriter writer, IRequestCycle cycle)
     {
         if (isInError(component))
         {
             writer.begin("font");
             writer.attribute("color", "red");
         }
     }

     /**
      * Does nothing by default. {@inheritDoc}
      */

     public void writeLabelAttributes(IMarkupWriter writer, IRequestCycle cycle,
             IFormComponent component)
     {
     }

     /**
      * {@inheritDoc}
      */
     public void beforeLabelText(IMarkupWriter writer, IRequestCycle cycle, IFormComponent component)
     {
     }

     /**
      * {@inheritDoc}
      */
     public void afterLabelText(IMarkupWriter writer, IRequestCycle cycle, IFormComponent component)
     {
     }

     /**
      * Closes the &lt;font&gt; element,started by
      * {@link #writeLabelPrefix(IFormComponent,IMarkupWriter,IRequestCycle)},
      * if the form component is in error.
      */

     public void writeLabelSuffix(IFormComponent component,
             IMarkupWriter writer, IRequestCycle cycle)
     {
         if (isInError(component))
         {
             writer.end();
         }
     }

     /**
      * Returns the {@link IFieldTracking}for the current component, if any. The
      * {@link IFieldTracking}is usually created in
      * {@link #record(String, ValidationConstraint)}or in
      * {@link #record(IRender, ValidationConstraint)}.
      * <p>
      * Components may be rendered multiple times, with multiple names (provided
      * by the {@link org.apache.tapestry.form.Form}, care must be taken that
      * this method is invoked <em>after</em> the Form has provided a unique
      * {@link IFormComponent#getName()}for the component.
      *
      * @see #setFormComponent(IFormComponent)
      * @return the {@link FieldTracking}, or null if the field has no tracking.
      */

     protected FieldTracking getComponentTracking()
     {
         return (FieldTracking) _trackingMap.get(_currentComponent.getName());
     }

     public void setFormComponent(IFormComponent component)
     {
         _currentComponent = component;
     }

     public boolean isInError()
     {
         IFieldTracking tracking = getComponentTracking();

         return tracking != null && tracking.isInError();
     }

     public String getFieldInputValue()
     {
         IFieldTracking tracking = getComponentTracking();

         return tracking == null ? null : tracking.getInput();
     }

     /**
      * Returns all the field trackings as an unmodifiable List.
      */

     public List getFieldTracking()
     {
         if (Tapestry.size(_trackings) == 0) return null;

         return Collections.unmodifiableList(_trackings);
     }

     /** @since 3.0.2 */
     public IFieldTracking getCurrentFieldTracking()
     {
         return findCurrentTracking();
     }

     public void reset()
     {
         IFieldTracking tracking = getComponentTracking();

         if (tracking != null)
         {
             _trackings.remove(tracking);
             _trackingMap.remove(tracking.getFieldName());
         }
     }

     /**
      * Invokes {@link #record(String, ValidationConstraint)}, or
      * {@link #record(IRender, ValidationConstraint)}if the
      * {@link ValidatorException#getErrorRenderer() error renderer property}is
      * not null.
      */

     public void record(ValidatorException ex)
     {
         IRender errorRenderer = ex.getErrorRenderer();

         if (errorRenderer == null)
             record(ex.getMessage(), ex.getConstraint());
         else
             record(errorRenderer, ex.getConstraint());
     }

     /**
      * Invokes {@link #record(IRender, ValidationConstraint)}, after wrapping
      * the message parameter in a {@link RenderString}.
      */

     public void record(String message, ValidationConstraint constraint)
     {
         record(new RenderString(message), constraint);
     }

     /**
      * Records error information about the currently selected component, or
      * records unassociated (with any field) errors.
      * <p>
      * Currently, you may have at most one error per <em>field</em> (note the
      * difference between field and component), but any number of unassociated
      * errors.
      * <p>
      * Subclasses may override the default error message (based on other
      * factors, such as the field and constraint) before invoking this
      * implementation.
      *
      * @since 1.0.9
      */

     public void record(IRender errorRenderer, ValidationConstraint constraint)
     {
         FieldTracking tracking = findCurrentTracking();

         // Note that recording two errors for the same field is not advised; the
         // second will override the first.

         tracking.setErrorRenderer(errorRenderer);
         tracking.setConstraint(constraint);
     }

     /** @since 4.0 */

     public void record(IFormComponent field, String message)
     {
         setFormComponent(field);

         record(message, null);
     }

     public void recordFieldInputValue(String input)
     {
         FieldTracking tracking = findCurrentTracking();

         tracking.setInput(input);
     }

     /**
      * Finds or creates the field tracking for the
      * {@link #setFormComponent(IFormComponent)} &nbsp;current component. If no
      * current component, an unassociated error is created and returned.
      *
      * @since 3.0
      */

     protected FieldTracking findCurrentTracking()
     {
         FieldTracking result = null;

         if (_currentComponent == null)
         {
             result = new FieldTracking();

             // Add it to the field trackings, but not to the
             // map.

             _trackings.add(result);
         }
         else
         {
             result = getComponentTracking();

             if (result == null)
             {
                 String fieldName = _currentComponent.getName();

                 result = new FieldTracking(fieldName, _currentComponent);

                 _trackings.add(result);
                 _trackingMap.put(fieldName, result);
             }
         }

         return result;
     }

     /**
      * Does nothing. Override in a subclass to decorate fields.
      */

     public void writePrefix(IMarkupWriter writer, IRequestCycle cycle,
             IFormComponent component, IValidator validator)
     {
     }

     /**
      * Currently appends a single css class attribute of <code>fieldInvalid</code> if the field
      * is in error.  If the field has a matching constraint of {@link ValidationConstraint#REQUIRED}
      * the <code>fieldMissing</code> is written instead.
      */

     public void writeAttributes(IMarkupWriter writer, IRequestCycle cycle,
             IFormComponent component, IValidator validator)
     {
         IFieldTracking tracking = getFieldTracking(component);
         if (tracking == null || !tracking.getRenderError())
             return;

         if (tracking.getConstraint() != null
             && tracking.getConstraint() == ValidationConstraint.REQUIRED)
         {
             writer.appendAttribute("class", "fieldMissing");
         } else if (tracking.isInError())
         {

             writer.appendAttribute("class", "fieldInvalid");
         }
     }

     /**
      * Default implementation; if the current field is in error, then a suffix
      * is written. The suffix is:
      * <code>&amp;nbsp;&lt;font color="red"&gt;**&lt;/font&gt;</code>.
      */

     public void writeSuffix(IMarkupWriter writer, IRequestCycle cycle,
             IFormComponent component, IValidator validator)
     {
         IFieldTracking tracking = getComponentTracking();

         if (tracking != null && tracking.isInError() && tracking.getRenderError())
         {
             writer.printRaw("&nbsp;");
             writer.begin("font");
             writer.attribute("color", "red");
             writer.print("**");
             writer.end();
         }
     }

     public boolean getHasErrors()
     {
         return getFirstError() != null;
     }

     /**
      * A convienience, as most pages just show the first error on the page.
      * <p>
      * As of release 1.0.9, this returns an instance of {@link IRender}, not a
      * {@link String}.
      */

     public IRender getFirstError()
     {
         if (Tapestry.size(_trackings) == 0)
             return null;

         Iterator i = _trackings.iterator();

         while(i.hasNext())
         {
             IFieldTracking tracking = (IFieldTracking) i.next();

             if (tracking.isInError()) return tracking.getErrorRenderer();
         }

         return null;
     }

     /**
      * Checks to see if the field is in error. This will <em>not</em> work
      * properly in a loop, but is only used by {@link FieldLabel}. Therefore,
      * using {@link FieldLabel}in a loop (where the {@link IFormComponent}is
      * renderred more than once) will not provide correct results.
      */

     protected boolean isInError(IFormComponent component)
     {
         // Get the name as most recently rendered.

         String fieldName = component.getName();

         IFieldTracking tracking = (IFieldTracking) _trackingMap.get(fieldName);

         return tracking != null && tracking.isInError();
     }

     protected IFieldTracking getFieldTracking(IFormComponent component)
     {
         String fieldName = component.getName();

         return (IFieldTracking) _trackingMap.get(fieldName);
     }

     /**
      * Returns a {@link List}of {@link IFieldTracking}s. This is the master
      * list of trackings, except that it omits and trackings that are not
      * associated with a particular field. May return an empty list, or null.
      * <p>
      * Order is not determined, though it is likely the order in which
      * components are laid out on in the template (this is subject to change).
      */

     public List getAssociatedTrackings()
     {
         int count = Tapestry.size(_trackings);

         if (count == 0) return null;

         List result = new ArrayList(count);

         for(int i = 0; i < count; i++)
         {
             IFieldTracking tracking = (IFieldTracking) _trackings.get(i);

             if (tracking.getFieldName() == null) continue;

             result.add(tracking);
         }

         return result;
     }

     /**
      * Like {@link #getAssociatedTrackings()}, but returns only the
      * unassociated trackings. Unassociated trackings are new (in release
      * 1.0.9), and are why interface {@link IFieldTracking}is not very well
      * named.
      * <p>
      * The trackings are returned in an unspecified order, which (for the
      * moment, anyway) is the order in which they were added (this could change
      * in the future, or become more concrete).
      */

     public List getUnassociatedTrackings()
     {
         int count = Tapestry.size(_trackings);

         if (count == 0) return null;

         List result = new ArrayList(count);

         for(int i = 0; i < count; i++)
         {
             IFieldTracking tracking = (IFieldTracking) _trackings.get(i);

             if (tracking.getFieldName() != null) continue;

             result.add(tracking);
         }

         return result;
     }

     public List getErrorRenderers()
     {
         List result = new ArrayList();

         Iterator i = _trackings.iterator();
         while(i.hasNext())
         {
             IFieldTracking tracking = (IFieldTracking) i.next();

             IRender errorRenderer = tracking.getErrorRenderer();

             if (errorRenderer != null)
                 result.add(errorRenderer);
         }

         return result;
     }

     /** @since 4.0 */

     public void registerForFocus(IFormComponent field, int priority)
     {
         if (priority > _focusPriority)
         {
             _focusField = field.getClientId();
             _focusPriority = priority;
         }
     }

     /**
      * Returns the focus field, or null if no form components registered for
      * focus (i.e., they were all disabled).
      */

     public String getFocusField()
     {
         return _focusField;
     }

 }
	// Copyright 2004, 2005 The Apache Software Foundation
	//
	// Licensed under the Apache License, Version 2.0 (the "License");
	// you may not use this file except in compliance with the License.
	// You may obtain a copy of the License at
	//
	// http://www.apache.org/licenses/LICENSE-2.0
	//
	// Unless required by applicable law or agreed to in writing, software
	// distributed under the License is distributed on an "AS IS" BASIS,
	// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	// See the License for the specific language governing permissions and
	// limitations under the License.

	package org.apache.tapestry.valid;

	import org.apache.tapestry.IMarkupWriter;
	import org.apache.tapestry.IRender;
	import org.apache.tapestry.IRequestCycle;
	import org.apache.tapestry.Tapestry;
	import org.apache.tapestry.form.IFormComponent;

	import java.util.*;

	/**
	* A base implementation of {@link IValidationDelegate} that can be used as a
	* managed bean. This class is often subclassed, typically to override
	* presentation details.
	*
	* @author Howard Lewis Ship
	* @since 1.0.5
	*/

	public class ValidationDelegate implements IValidationDelegate
	{

	private static final long serialVersionUID = 6215074338439140780L;

	private transient IFormComponent _currentComponent;

	private transient String _focusField;

	private transient int _focusPriority = -1;

	/**
	* A list of {@link IFieldTracking}.
	*/

	private final List _trackings = new ArrayList();

	/**
	* A map of {@link IFieldTracking}, keyed on form element name.
	*/

	private final Map _trackingMap = new HashMap();

	public void clear()
	{
	_currentComponent = null;
	_trackings.clear();
	_trackingMap.clear();
	}

	public void clearErrors()
	{
	if (_trackings == null)
	return;

	Iterator i = _trackings.iterator();
	while(i.hasNext())
	{
	FieldTracking ft = (FieldTracking) i.next();
	ft.setErrorRenderer(null);
	ft.setRenderError(false);
	}
	}

	/**
	* If the form component is in error, places a <font color="red"<
	* around it. Note: this will only work on the render phase after a rewind,
	* and will be confused if components are inside any kind of loop.
	*/

	public void writeLabelPrefix(IFormComponent component,
	IMarkupWriter writer, IRequestCycle cycle)
	{
	if (isInError(component))
	{
	writer.begin("font");
	writer.attribute("color", "red");
	}
	}

	/**
	* Does nothing by default. {@inheritDoc}
	*/

	public void writeLabelAttributes(IMarkupWriter writer, IRequestCycle cycle,
	IFormComponent component)
	{
	}

	/**
	* {@inheritDoc}
	*/
	public void beforeLabelText(IMarkupWriter writer, IRequestCycle cycle, IFormComponent component)
	{
	}

	/**
	* {@inheritDoc}
	*/
	public void afterLabelText(IMarkupWriter writer, IRequestCycle cycle, IFormComponent component)
	{
	}

	/**
	* Closes the <font> element,started by
	* {@link #writeLabelPrefix(IFormComponent,IMarkupWriter,IRequestCycle)},
	* if the form component is in error.
	*/

	public void writeLabelSuffix(IFormComponent component,
	IMarkupWriter writer, IRequestCycle cycle)
	{
	if (isInError(component))
	{
	writer.end();
	}
	}

	/**
	* Returns the {@link IFieldTracking}for the current component, if any. The
	* {@link IFieldTracking}is usually created in
	* {@link #record(String, ValidationConstraint)}or in
	* {@link #record(IRender, ValidationConstraint)}.
	* <p>
	* Components may be rendered multiple times, with multiple names (provided
	* by the {@link org.apache.tapestry.form.Form}, care must be taken that
	* this method is invoked <em>after</em> the Form has provided a unique
	* {@link IFormComponent#getName()}for the component.
	*
	* @see #setFormComponent(IFormComponent)
	* @return the {@link FieldTracking}, or null if the field has no tracking.
	*/

	protected FieldTracking getComponentTracking()
	{
	return (FieldTracking) _trackingMap.get(_currentComponent.getName());
	}

	public void setFormComponent(IFormComponent component)
	{
	_currentComponent = component;
	}

	public boolean isInError()
	{
	IFieldTracking tracking = getComponentTracking();

	return tracking != null && tracking.isInError();
	}

	public String getFieldInputValue()
	{
	IFieldTracking tracking = getComponentTracking();

	return tracking == null ? null : tracking.getInput();
	}

	/**
	* Returns all the field trackings as an unmodifiable List.
	*/

	public List getFieldTracking()
	{
	if (Tapestry.size(_trackings) == 0) return null;

	return Collections.unmodifiableList(_trackings);
	}

	/** @since 3.0.2 */
	public IFieldTracking getCurrentFieldTracking()
	{
	return findCurrentTracking();
	}

	public void reset()
	{
	IFieldTracking tracking = getComponentTracking();

	if (tracking != null)
	{
	_trackings.remove(tracking);
	_trackingMap.remove(tracking.getFieldName());
	}
	}

	/**
	* Invokes {@link #record(String, ValidationConstraint)}, or
	* {@link #record(IRender, ValidationConstraint)}if the
	* {@link ValidatorException#getErrorRenderer() error renderer property}is
	* not null.
	*/

	public void record(ValidatorException ex)
	{
	IRender errorRenderer = ex.getErrorRenderer();

	if (errorRenderer == null)
	record(ex.getMessage(), ex.getConstraint());
	else
	record(errorRenderer, ex.getConstraint());
	}

	/**
	* Invokes {@link #record(IRender, ValidationConstraint)}, after wrapping
	* the message parameter in a {@link RenderString}.
	*/

	public void record(String message, ValidationConstraint constraint)
	{
	record(new RenderString(message), constraint);
	}

	/**
	* Records error information about the currently selected component, or
	* records unassociated (with any field) errors.
	* <p>
	* Currently, you may have at most one error per <em>field</em> (note the
	* difference between field and component), but any number of unassociated
	* errors.
	* <p>
	* Subclasses may override the default error message (based on other
	* factors, such as the field and constraint) before invoking this
	* implementation.
	*
	* @since 1.0.9
	*/

	public void record(IRender errorRenderer, ValidationConstraint constraint)
	{
	FieldTracking tracking = findCurrentTracking();

	// Note that recording two errors for the same field is not advised; the
	// second will override the first.

	tracking.setErrorRenderer(errorRenderer);
	tracking.setConstraint(constraint);
	}

	/** @since 4.0 */

	public void record(IFormComponent field, String message)
	{
	setFormComponent(field);

	record(message, null);
	}

	public void recordFieldInputValue(String input)
	{
	FieldTracking tracking = findCurrentTracking();

	tracking.setInput(input);
	}

	/**
	* Finds or creates the field tracking for the
	* {@link #setFormComponent(IFormComponent)}  current component. If no
	* current component, an unassociated error is created and returned.
	*
	* @since 3.0
	*/

	protected FieldTracking findCurrentTracking()
	{
	FieldTracking result = null;

	if (_currentComponent == null)
	{
	result = new FieldTracking();

	// Add it to the field trackings, but not to the
	// map.

	_trackings.add(result);
	}
	else
	{
	result = getComponentTracking();

	if (result == null)
	{
	String fieldName = _currentComponent.getName();

	result = new FieldTracking(fieldName, _currentComponent);

	_trackings.add(result);
	_trackingMap.put(fieldName, result);
	}
	}

	return result;
	}

	/**
	* Does nothing. Override in a subclass to decorate fields.
	*/

	public void writePrefix(IMarkupWriter writer, IRequestCycle cycle,
	IFormComponent component, IValidator validator)
	{
	}

	/**
	* Currently appends a single css class attribute of <code>fieldInvalid</code> if the field
	* is in error. If the field has a matching constraint of {@link ValidationConstraint#REQUIRED}
	* the <code>fieldMissing</code> is written instead.
	*/

	public void writeAttributes(IMarkupWriter writer, IRequestCycle cycle,
	IFormComponent component, IValidator validator)
	{
	IFieldTracking tracking = getFieldTracking(component);
	if (tracking == null \|\| !tracking.getRenderError())
	return;

	if (tracking.getConstraint() != null
	&& tracking.getConstraint() == ValidationConstraint.REQUIRED)
	{
	writer.appendAttribute("class", "fieldMissing");
	} else if (tracking.isInError())
	{

	writer.appendAttribute("class", "fieldInvalid");
	}
	}

	/**
	* Default implementation; if the current field is in error, then a suffix
	* is written. The suffix is:
	* <code>&nbsp;<font color="red">**</font></code>.
	*/

	public void writeSuffix(IMarkupWriter writer, IRequestCycle cycle,
	IFormComponent component, IValidator validator)
	{
	IFieldTracking tracking = getComponentTracking();

	if (tracking != null && tracking.isInError() && tracking.getRenderError())
	{
	writer.printRaw(" ");
	writer.begin("font");
	writer.attribute("color", "red");
	writer.print("**");
	writer.end();
	}
	}

	public boolean getHasErrors()
	{
	return getFirstError() != null;
	}

	/**
	* A convienience, as most pages just show the first error on the page.
	* <p>
	* As of release 1.0.9, this returns an instance of {@link IRender}, not a
	* {@link String}.
	*/

	public IRender getFirstError()
	{
	if (Tapestry.size(_trackings) == 0)
	return null;

	Iterator i = _trackings.iterator();

	while(i.hasNext())
	{
	IFieldTracking tracking = (IFieldTracking) i.next();

	if (tracking.isInError()) return tracking.getErrorRenderer();
	}

	return null;
	}

	/**
	* Checks to see if the field is in error. This will <em>not</em> work
	* properly in a loop, but is only used by {@link FieldLabel}. Therefore,
	* using {@link FieldLabel}in a loop (where the {@link IFormComponent}is
	* renderred more than once) will not provide correct results.
	*/

	protected boolean isInError(IFormComponent component)
	{
	// Get the name as most recently rendered.

	String fieldName = component.getName();

	IFieldTracking tracking = (IFieldTracking) _trackingMap.get(fieldName);

	return tracking != null && tracking.isInError();
	}

	protected IFieldTracking getFieldTracking(IFormComponent component)
	{
	String fieldName = component.getName();

	return (IFieldTracking) _trackingMap.get(fieldName);
	}

	/**
	* Returns a {@link List}of {@link IFieldTracking}s. This is the master
	* list of trackings, except that it omits and trackings that are not
	* associated with a particular field. May return an empty list, or null.
	* <p>
	* Order is not determined, though it is likely the order in which
	* components are laid out on in the template (this is subject to change).
	*/

	public List getAssociatedTrackings()
	{
	int count = Tapestry.size(_trackings);

	if (count == 0) return null;

	List result = new ArrayList(count);

	for(int i = 0; i < count; i++)
	{
	IFieldTracking tracking = (IFieldTracking) _trackings.get(i);

	if (tracking.getFieldName() == null) continue;

	result.add(tracking);
	}

	return result;
	}

	/**
	* Like {@link #getAssociatedTrackings()}, but returns only the
	* unassociated trackings. Unassociated trackings are new (in release
	* 1.0.9), and are why interface {@link IFieldTracking}is not very well
	* named.
	* <p>
	* The trackings are returned in an unspecified order, which (for the
	* moment, anyway) is the order in which they were added (this could change
	* in the future, or become more concrete).
	*/

	public List getUnassociatedTrackings()
	{
	int count = Tapestry.size(_trackings);

	if (count == 0) return null;

	List result = new ArrayList(count);

	for(int i = 0; i < count; i++)
	{
	IFieldTracking tracking = (IFieldTracking) _trackings.get(i);

	if (tracking.getFieldName() != null) continue;

	result.add(tracking);
	}

	return result;
	}

	public List getErrorRenderers()
	{
	List result = new ArrayList();

	Iterator i = _trackings.iterator();
	while(i.hasNext())
	{
	IFieldTracking tracking = (IFieldTracking) i.next();

	IRender errorRenderer = tracking.getErrorRenderer();

	if (errorRenderer != null)
	result.add(errorRenderer);
	}

	return result;
	}

	/** @since 4.0 */

	public void registerForFocus(IFormComponent field, int priority)
	{
	if (priority > _focusPriority)
	{
	_focusField = field.getClientId();
	_focusPriority = priority;
	}
	}

	/**
	* Returns the focus field, or null if no form components registered for
	* focus (i.e., they were all disabled).
	*/

	public String getFocusField()
	{
	return _focusField;
	}

	}