org.apache.wicket.markup.html.form
Class FormComponentPanel<T>

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.form.LabeledWebMarkupContainer
                  org.apache.wicket.markup.html.form.FormComponent<T>
                      org.apache.wicket.markup.html.form.FormComponentPanel<T>

Type Parameters:

T - The model object type

All Implemented Interfaces:

Serializable, IClusterable, IConverterLocator, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>, IHeaderPartContainerProvider

Direct Known Subclasses:

DateField, DateTimeField, MultiFileUploadField, Multiply

public abstract class FormComponentPanel<T>
extends FormComponent<T>
implements IHeaderPartContainerProvider

Panel (has it's own markup, defined between tags), that can act as a form component. It typically wouldn't receive any input yourself, and often you can get by with nesting form components in panels proper. However, using this panel can help you with building components act to the outside world as one component, but internally uses separate components. This component would then use these nested components to handle it's internal state, and would use that internal state to get to one model object.

It is recommended that you override FormComponent.convertInput() and let it set the value that represents the compound value of the nested components. Often, this goes hand-in-hand with overriding Component.onBeforeRender(), where you would analyze the model value, break it up and distribute the appropriate values over the child components.

Here is a simple example of a panel with two components that multiplies and sets that as the master model object. Note that for this simple example, setting the model value wouldn't make sense, as the lhs and rhs cannot be known. For more complete examples of using this class, see the wicket-datetime project.

 public class Multiply extends FormComponentPanel
 {
        private TextField left;
        private int lhs = 0;
        private int rhs = 0;
        private TextField right;
 
        public Multiply(String id)
        {
                super(id);
                init();
        }
 
        public Multiply(String id, IModel model)
        {
                super(id, model);
                init();
        }
 
        protected void convertInput()
        {
                Integer lhs = (Integer)left.getConvertedInput();
                Integer rhs = (Integer)right.getConvertedInput();
                setConvertedInput(lhs * rhs);
        }
 
        private void init()
        {
                add(left = new TextField("left", new PropertyModel(this, "lhs"), Integer.class));
                add(right = new TextField("right", new PropertyModel(this, "rhs"), Integer.class));
                left.setRequired(true);
                right.setRequired(true);
        }
 }
 

With this markup:

   <wicket:panel>
     <input type="text" wicket:id="left" size="2" /> * <input type="text" wicket:id="right" size="2" />
   </wicket:panel>
 

Which could be used, for example as:

   add(new Multiply("multiply"), new PropertyModel(m, "multiply")));
   add(new Label("multiplyLabel", new PropertyModel(m, "multiply")));
 

and:

   <span wicket:id="multiply">[multiply]</span>
   = <span wicket:id="multiplyLabel">[result]</span>
 

Author:

eelcohillenius

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.FormComponent

FormComponent.AbstractVisitor, FormComponent.IVisitor

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

FormComponentPanel(String id)
Construct.

FormComponentPanel(String id, IModel<T> model)
Construct.

Method Summary

boolean	checkRequired() Checks if the form component's 'required' requirement is met by first checking FormComponent.isRequired() to see if it has to check for requirement.
HeaderPartContainer	newHeaderPartContainer(String id, String scope) Create a new HeaderPartContainer.
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
protected void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Handle the container's body.
void	renderHead(HtmlHeaderContainer container) Check the associated markup file for a wicket header tag

Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

add, add, clearInput, convertInput, convertValue, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, newValidatable, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, supportsPersistence, trim, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel, setLabelInternal

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FormComponentPanel

public FormComponentPanel(String id)

Construct.

Parameters:

id -

FormComponentPanel

public FormComponentPanel(String id,
                          IModel<T> model)

Construct.

Parameters:

id -

model -

Method Detail

checkRequired

public boolean checkRequired()

Description copied from class: FormComponent

Checks if the form component's 'required' requirement is met by first checking FormComponent.isRequired() to see if it has to check for requirement. If that is true then by default it checks if the input is null or an empty String Strings.isEmpty(CharSequence)

Subclasses that overwrite this method should also call FormComponent.isRequired() first.

Overrides:

checkRequired in class FormComponent<T>

Returns:

true if the 'required' requirement is met, false otherwise

See Also:

FormComponent.checkRequired()

newHeaderPartContainer

public HeaderPartContainer newHeaderPartContainer(String id,
                                                  String scope)

Description copied from interface: IHeaderPartContainerProvider

Create a new HeaderPartContainer. Users may wish to do that to implemented more sophisticated header scoping strategies.

Specified by:

newHeaderPartContainer in interface IHeaderPartContainerProvider

Parameters:

id - The header component's id

scope - The default scope of the header

Returns:

The new HeaderPartContainer

See Also:

IHeaderPartContainerProvider.newHeaderPartContainer(java.lang.String, java.lang.String)

renderHead

public void renderHead(HtmlHeaderContainer container)

Check the associated markup file for a wicket header tag

Overrides:

renderHead in class Component

Parameters:

container - The HtmlHeaderContainer

See Also:

Component.renderHead(org.apache.wicket.markup.html.internal.HtmlHeaderContainer)

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: FormComponent

Processes the component tag.

Overrides:

onComponentTag in class FormComponent<T>

Parameters:

tag - Tag to modify

See Also:

Component.onComponentTag(org.apache.wicket.markup.ComponentTag)

onComponentTagBody

protected void onComponentTagBody(MarkupStream markupStream,
                                  ComponentTag openTag)

Description copied from class: MarkupContainer

Handle the container's body. If your override of this method does not advance the markup stream to the close tag for the openTag, a runtime exception will be thrown by the framework.

Overrides:

onComponentTagBody in class MarkupContainer

Parameters:

markupStream - The markup stream

openTag - The open tag for the body

See Also:

Component.onComponentTagBody(org.apache.wicket.markup.MarkupStream, org.apache.wicket.markup.ComponentTag)