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

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

Type Parameters:

T - The model object type

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IGenericComponent<T>, IRequestListener, IFormSubmitListener, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

StatelessForm

public class Form<T>
extends WebMarkupContainer
implements IFormSubmitListener, IGenericComponent<T>

Container for FormComponents (such as CheckBoxes, ListChoices or TextFields). Subclass this class to receive submit notifications through onSubmit() or nest multiple IFormSubmittingComponents if you want to vary submit behavior. In the former case it is not necessary to use any of Wicket's classes (such as Button or SubmitLink), just putting e.g. <input type="submit" value="go"/> suffices.

As a IFormSubmitListener the form gets notified of listener requests in onFormSubmitted(). By default, the processing of this submit works like this:

• All nested FormComponents are notified of new input via FormComponent.inputChanged()
• The form submitter is looked up, e.g. a Button is contained in the component hierarchy of this form and was clicked by the user:
  • If an IFormSubmitter was found which IFormSubmitter.getDefaultFormProcessing() returns false (default is true ), it's IFormSubmitter.onSubmit() method will be called right away, thus all further processing is skipped. This has the same effect as nesting a normal link in the form.
    If needed the form submitter can continue processing however, by calling validate() to execute form validation, hasError() to find out whether validate() resulted in validation errors, and updateFormComponentModels() to update the models of nested form components.
  • Otherwise this form is further processed via process(IFormSubmitter), resulting in all nested components being validated via FormComponent.validate().
    
    • If form validation failed, all nested form components will be marked invalid, and onError() is called to allow clients to provide custom error handling code.
    • Otherwise the nested components will be asked to update their models via FormComponent.updateModel(). After that submit notification is delegated to the IFormSubmitter.onSubmit() (if just found) before calling onSubmit() on this form. Subclasses may override delegateSubmit(IFormSubmitter) if they want a different behavior.

A Form can be configured for handling uploads with multipart requests (e.g. files) by calling setMultiPart(boolean) (although Wicket will try to automatically detect this for you). Use this with FileUploadField components. You can attach multiple FileUploadField components for multiple file uploads.

In case of an upload error two resource keys are available to specify error messages: uploadTooLarge and uploadFailed, i.e. for a form with id myform in MyPage.properties:

 myform.uploadTooLarge=You have uploaded a file that is over the allowed limit of 2Mb
 

Forms can be nested. You can put a form in another form. Since HTML doesn't allow nested <form> tags, the inner forms will be rendered using the <div> tag. You have to submit the inner forms using explicit components (like Button or SubmitLink), you can't rely on implicit submit behavior (by using just <input type="submit"> that is not attached to a component).

When a nested form is submitted, the user entered values in outer (parent) forms are preserved and only the fields in the submitted form are validated.

Author:

Jonathan Locke, Juergen Donnerstag, Eelco Hillenius, Cameron Braid, Johan Compagner, Igor Vaynberg (ivaynberg), David Leangen

See Also:

Serialized Form

Nested Class Summary

static class	Form.MethodMismatchResponse Response when a submission method mismatch is detected
static class	Form.ValidationVisitor Visitor used for validation

Field Summary

static String	ENCTYPE_MULTIPART_FORM_DATA
static String	METHOD_GET Constant for specifying how a form is submitted, in this case using get.
static String	METHOD_POST Constant for specifying how a form is submitted, in this case using post.

Fields inherited from class org.apache.wicket.Component

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

Fields inherited from interface org.apache.wicket.markup.html.form.IFormSubmitListener

INTERFACE

Constructor Summary

Form(String id)
Constructs a form with no validation.

Form(String id, IModel<T> model)

Method Summary

void	add(IFormValidator validator) Adds a form validator to the form.
protected void	appendDefaultButtonField(MarkupStream markupStream, ComponentTag openTag) If a default IFormSubmittingComponent was set on this form, this method will be called to render an extra field with an invisible style so that pressing enter in one of the textfields will do a form submit using this component.
protected void	beforeUpdateFormComponentModels() Template method to allow clients to do any processing (like recording the current model so that, in case onSubmit does further validation, the model can be rolled back) before the actual updating of form component models is done.
protected void	callOnError(IFormSubmitter submitter) Calls onError on this Form and any enabled and visible nested form, if the respective Form actually has errors.
void	clearInput() Clears the input from the form's nested children of type FormComponent.
protected void	delegateSubmit(IFormSubmitter submittingComponent) Called (by the default implementation of 'process') when all fields validated, the form was updated and it's data was allowed to be persisted.
protected boolean	encodeUrlInHiddenFields()
void	error(String error, Map<String,Object> args) Registers an error feedback message for this component
static Form<?>	findForm(Component component)
IFormSubmitter	findSubmittingButton() Gets the IFormSubmittingComponent which submitted this form.
protected CharSequence	getActionUrl() Generates the action url for the form
IFormSubmittingComponent	getDefaultButton() Gets the default IFormSubmittingComponent.
Collection<IFormValidator>	getFormValidators() Gets all IFormValidators added to this form
String	getHiddenFieldId() Returns the HiddenFieldId which will be used as the name and id property of the hiddenfield that is generated for event dispatches.
protected String	getInputNamePrefix() Allows to customize input names of form components inside this form.
CharSequence	getJsForInterfaceUrl(CharSequence url) This generates a piece of javascript code that sets the url in the special hidden field and submits the form.
Bytes	getMaxSize() Gets the maximum size for uploads.
protected String	getMethod() Gets the HTTP submit method that will appear in form markup.
IModel<T>	getModel() Typesafe getter for the model
T	getModelObject() Typesafe getter for the model's object
Form<?>	getRootForm() Returns the root form or this, if this is the root form.
static String	getRootFormRelativeId(Component component) Utility method to assemble an id to distinct form components from different nesting levels.
protected boolean	getStatelessHint() Returns whether the component can be stateless.
String	getValidatorKeyPrefix() Returns the prefix used when building validator keys.
protected boolean	handleMultiPart() Handles multi-part processing of the submitted data.
boolean	hasError() Gets whether the current form has any error registered.
protected void	internalOnModelChanged() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
boolean	isMultiPart()
boolean	isRootForm() Returns whether the form is a root form, which means that there's no other form in it's parent hierarchy.
boolean	isSubmitted() Checks if this form has been submitted during the current request
protected void	markFormComponentsInvalid() Mark each form component on this form invalid.
protected void	markFormComponentsValid() Mark each form component on this form and on nested forms valid.
protected void	onBeforeRender() Called just before a component is rendered.
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Append an additional hidden input tag to support anchor tags that can submit a form.
protected void	onDetach() Called to allow a component to detach resources after use.
protected void	onError() Method to override if you want to do something special when an error occurs (other than simply displaying validation errors).
protected void	onFileUploadException(FileUploadException e, Map<String,Object> model) The default message may look like "..
void	onFormSubmitted() THIS METHOD IS NOT PART OF THE WICKET API.
void	onFormSubmitted(IFormSubmitter submitter) THIS METHOD IS NOT PART OF THE WICKET API.
protected Form.MethodMismatchResponse	onMethodMismatch() Called when a form has been submitted using a method differing from return value of getMethod().
protected void	onSubmit() Implemented by subclasses to deal with form submits.
protected void	onValidate() Callback during the validation stage of the form
protected void	onValidateModelObjects() Called after form components have updated their models.
void	process(IFormSubmitter submittingComponent) Process the form.
protected void	registerJavaScriptNamespaces(IHeaderResponse response) Produces javascript that registereds Wicket.Forms namespaces
void	remove(IFormValidator validator) Removes a form validator from the form.
void	renderHead(IHeaderResponse response) Render to the web response whatever the component wants to contribute to the head section.
protected void	renderPlaceholderTag(ComponentTag tag, Response response) Renders a placeholder tag for the component when it is invisible and Component.setOutputMarkupPlaceholderTag(boolean) has been called with true.
void	setDefaultButton(IFormSubmittingComponent submittingComponent) Sets the default IFormSubmittingComponent.
void	setMaxSize(Bytes maxSize) Sets the maximum size for uploads.
void	setModel(IModel<T> model) Typesafe setter for the model
void	setModelObject(T object) Typesafe setter for the model object
void	setMultiPart(boolean multiPart) Set to true to use enctype='multipart/form-data', and to process file uploads by default multiPart = false
Component	setVersioned(boolean isVersioned)
protected void	updateFormComponentModels() Update the model of all components on this form and nested forms using the fields that were sent with the current request.
protected void	validate() Validates the form by checking required fields, converting raw input and running validators for every form component, and last running global form validators.
protected void	validateComponents() Triggers type conversion on form components
protected void	validateFormValidator(IFormValidator validator) Validates form with the given form validator
protected void	validateFormValidators() Triggers any added IFormValidators.
<R> R	visitFormComponents(IVisitor<FormComponent<?>,R> visitor) Convenient and typesafe way to visit all the form components on a form.
<R> R	visitFormComponentsPostOrder(IVisitor<? extends FormComponent<?>,R> visitor) Convenient and typesafe way to visit all the form components on a form postorder (deepest first)
boolean	wantSubmitOnNestedFormSubmit() Whether this form wants to be submitted too if a nested form is submitted.
protected void	writeParamsAsHiddenFields(String[] params, AppendingStringBuffer buffer)

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

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Field Detail

ENCTYPE_MULTIPART_FORM_DATA

public static final String ENCTYPE_MULTIPART_FORM_DATA

See Also:

Constant Field Values

METHOD_GET

public static final String METHOD_GET

Constant for specifying how a form is submitted, in this case using get.

See Also:

Constant Field Values

METHOD_POST

public static final String METHOD_POST

Constant for specifying how a form is submitted, in this case using post.

See Also:

Constant Field Values

Constructor Detail

Form

public Form(String id)

Constructs a form with no validation.

Parameters:

id - See Component

Form

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

Parameters:

id - See Component

model - See Component

See Also:

Component.Component(String, IModel)

Method Detail

add

public void add(IFormValidator validator)

Adds a form validator to the form.

Parameters:

validator - validator

Throws:

IllegalArgumentException - if validator is null

See Also:

IFormValidator

remove

public void remove(IFormValidator validator)

Removes a form validator from the form.

Parameters:

validator - validator

Throws:

IllegalArgumentException - if validator is null

See Also:

IFormValidator

clearInput

public final void clearInput()

Clears the input from the form's nested children of type FormComponent. This method is typically called when a form needs to be reset.

error

public final void error(String error,
                        Map<String,Object> args)

Registers an error feedback message for this component

Parameters:

error - error message

args - argument replacement map for ${key} variables

findSubmittingButton

public final IFormSubmitter findSubmittingButton()

Gets the IFormSubmittingComponent which submitted this form.

Returns:

The component which submitted this form, or null if the processing was not triggered by a registered IFormSubmittingComponent

getDefaultButton

public final IFormSubmittingComponent getDefaultButton()

Gets the default IFormSubmittingComponent. If set (not null), a hidden submit component will be rendered right after the form tag, so that when users press enter in a textfield, this submit component's action will be selected. If no default component is set (it is null), nothing additional is rendered.

WARNING: note that this is a best effort only. Unfortunately having a 'default' button in a form is ill defined in the standards, and of course IE has it's own way of doing things.

There can be only one default submit component per form hierarchy. So if you want to get the default component on a nested form, it will actually delegate the call to root form.

Returns:

The submit component to set as the default IFormSubmittingComponent, or null when you want to 'unset' any previously set default IFormSubmittingComponent

getFormValidators

public final Collection<IFormValidator> getFormValidators()

Gets all IFormValidators added to this form

Returns:

unmodifiable collection of IFormValidators

getJsForInterfaceUrl

public final CharSequence getJsForInterfaceUrl(CharSequence url)

This generates a piece of javascript code that sets the url in the special hidden field and submits the form. Warning: This code should only be called in the rendering phase for form components inside the form because it uses the css/javascript id of the form which can be stored in the markup.

Parameters:

url - The interface url that has to be stored in the hidden field and submitted

Returns:

The javascript code that submits the form.

getMaxSize

public final Bytes getMaxSize()

Gets the maximum size for uploads. If null, the setting IApplicationSettings.getDefaultMaximumUploadSize() is used.

Returns:

the maximum size

getRootForm

public Form<?> getRootForm()

Returns the root form or this, if this is the root form.

Returns:

root form or this form

getValidatorKeyPrefix

public String getValidatorKeyPrefix()

Returns the prefix used when building validator keys. This allows a form to use a separate "set" of keys. For example if prefix "short" is returned, validator key short.Required will be tried instead of Required key.

This can be useful when different designs are used for a form. In a form where error messages are displayed next to their respective form components as opposed to at the top of the form, the ${label} attribute is of little use and only causes redundant information to appear in the message. Forms like these can return the "short" (or any other string) validator prefix and declare key: short.Required=required to override the longer message which is usually declared like this: Required=${label} is a required field

Returned prefix will be used for all form components. The prefix can also be overridden on form component level by overriding FormComponent.getValidatorKeyPrefix()

Returns:

prefix prepended to validator keys

hasError

public final boolean hasError()

Gets whether the current form has any error registered.

Returns:

True if this form has at least one error.

isRootForm

public boolean isRootForm()

Returns whether the form is a root form, which means that there's no other form in it's parent hierarchy.

Returns:

true if form is a root form, false otherwise

isSubmitted

public final boolean isSubmitted()

Checks if this form has been submitted during the current request

Returns:

true if the form has been submitted during this request, false otherwise

onFormSubmitted

public final void onFormSubmitted()

THIS METHOD IS NOT PART OF THE WICKET API. DO NOT ATTEMPT TO OVERRIDE OR CALL IT. Handles form submissions.

Specified by:

onFormSubmitted in interface IFormSubmitListener

See Also:

onFormSubmitted(IFormSubmitter)

onMethodMismatch

protected Form.MethodMismatchResponse onMethodMismatch()

Called when a form has been submitted using a method differing from return value of getMethod(). For example, someone can copy and paste the action url and invoke the form using a GET instead of the desired POST. This method allows the user to react to this situation.

Returns:

response that can either abort or continue the processing of the form

onFormSubmitted

public final void onFormSubmitted(IFormSubmitter submitter)

THIS METHOD IS NOT PART OF THE WICKET API. DO NOT ATTEMPT TO OVERRIDE OR CALL IT. Handles form submissions.

Parameters:

submitter - listener that will receive form processing events, if null the form will attempt to locate one

See Also:

validate()

wantSubmitOnNestedFormSubmit

public boolean wantSubmitOnNestedFormSubmit()

Whether this form wants to be submitted too if a nested form is submitted. By default, this is false, so when a nested form is submitted, this form will not be submitted. If this method is overridden to return true, this form will be submitted.

Returns:

Whether this form wants to be submitted too if a nested form is submitted.

process

public void process(IFormSubmitter submittingComponent)

Process the form. Though you can override this method to provide your own algorithm, it is not recommended to do so.

See the class documentation for further details on the form processing

Parameters:

submittingComponent - component responsible for submitting the form, or null if none (eg the form has been submitted via the enter key or javascript calling form.onsubmit())

See Also:

for an easy way to process submitting component in the default manner

callOnError

protected void callOnError(IFormSubmitter submitter)

Calls onError on this Form and any enabled and visible nested form, if the respective Form actually has errors.

Parameters:

submitter -

setDefaultButton

public final void setDefaultButton(IFormSubmittingComponent submittingComponent)

Sets the default IFormSubmittingComponent. If set (not null), a hidden submit component will be rendered right after the form tag, so that when users press enter in a textfield, this submit component's action will be selected. If no default component is set (so unset by calling this method with null), nothing additional is rendered.

WARNING: note that this is a best effort only. Unfortunately having a 'default' button in a form is ill defined in the standards, and of course IE has it's own way of doing things.

There can be only one default button per form hierarchy. So if you set default button on a nested form, it will actually delegate the call to root form.

Parameters:

submittingComponent - The component to set as the default submitting component, or null when you want to 'unset' any previously set default component

setMaxSize

public final void setMaxSize(Bytes maxSize)

Sets the maximum size for uploads. If null, the setting IApplicationSettings.getDefaultMaximumUploadSize() is used.

Parameters:

maxSize - The maximum size

setMultiPart

public void setMultiPart(boolean multiPart)

Set to true to use enctype='multipart/form-data', and to process file uploads by default multiPart = false

Parameters:

multiPart - whether this form should behave as a multipart form

setVersioned

public final Component setVersioned(boolean isVersioned)

Overrides:

setVersioned in class Component

Parameters:

isVersioned - True to turn on versioning for this component, false to turn it off for this component and any children.

Returns:

This

See Also:

Component.setVersioned(boolean)

visitFormComponents

public final <R> R visitFormComponents(IVisitor<FormComponent<?>,R> visitor)

Convenient and typesafe way to visit all the form components on a form.

Type Parameters:

R - return object type

Parameters:

visitor - The visitor interface to call

Returns:

user provided in callback

visitFormComponentsPostOrder

public final <R> R visitFormComponentsPostOrder(IVisitor<? extends FormComponent<?>,R> visitor)

Convenient and typesafe way to visit all the form components on a form postorder (deepest first)

Type Parameters:

R - Return object type

Parameters:

visitor - The visitor interface to call

Returns:

whatever you provided

appendDefaultButtonField

protected void appendDefaultButtonField(MarkupStream markupStream,
                                        ComponentTag openTag)

If a default IFormSubmittingComponent was set on this form, this method will be called to render an extra field with an invisible style so that pressing enter in one of the textfields will do a form submit using this component. This method is overridable as what we do is best effort only, and may not what you want in specific situations. So if you have specific usability concerns, or want to follow another strategy, you may override this method.

Parameters:

markupStream - The markup stream

openTag - The open tag for the body

beforeUpdateFormComponentModels

protected void beforeUpdateFormComponentModels()

Template method to allow clients to do any processing (like recording the current model so that, in case onSubmit does further validation, the model can be rolled back) before the actual updating of form component models is done.

delegateSubmit

protected void delegateSubmit(IFormSubmitter submittingComponent)

Called (by the default implementation of 'process') when all fields validated, the form was updated and it's data was allowed to be persisted. It is meant for delegating further processing to clients.

This implementation first finds out whether the form processing was triggered by a nested IFormSubmittingComponent of this form. If that is the case, that component's onSubmitBefore/AfterForm methods are called appropriately..

Regardless of whether a submitting component was found, the form's onSubmit method is called next.

Parameters:

submittingComponent - the component that triggered this form processing, or null if the processing was triggered by something else (like a non-Wicket submit button or a javascript execution)

getHiddenFieldId

public final String getHiddenFieldId()

Returns the HiddenFieldId which will be used as the name and id property of the hiddenfield that is generated for event dispatches.

Returns:

The name and id of the hidden field.

getMethod

protected String getMethod()

Gets the HTTP submit method that will appear in form markup. If no method is specified in the template, "post" is the default. Note that the markup-declared HTTP method may not correspond to the one actually used to submit the form; in an Ajax submit, for example, JavaScript event handlers may submit the form with a "get" even when the form method is declared as "post." Therefore this method should not be considered a guarantee of the HTTP method used, but a value for the markup only. Override if you have a requirement to alter this behavior.

Returns:

the submit method specified in markup.

getStatelessHint

protected boolean getStatelessHint()

Description copied from class: Component

Returns whether the component can be stateless. Also the component behaviors must be stateless, otherwise the component will be treat as stateful. In order for page to be stateless (and not to be stored in session), all components (and component behaviors) must be stateless.

Overrides:

getStatelessHint in class Component

Returns:

whether the component can be stateless

See Also:

Component.getStatelessHint()

isMultiPart

public boolean isMultiPart()

Returns:

True if is multipart

handleMultiPart

protected boolean handleMultiPart()

Handles multi-part processing of the submitted data.

WARNING

If this method is overridden it can break FileUploadFields on this form

Returns:

false if form is multipart and upload failed

onFileUploadException

protected void onFileUploadException(FileUploadException e,
                                     Map<String,Object> model)

The default message may look like ".. may not exceed 10240 Bytes..". Which is ok, but sometimes you may want something like "10KB". By subclassing this method you may replace maxSize in the model or add you own property and use that in your error message.

Don't forget to call super.onFileUploadException(e, model) at the end of your method.

Parameters:

e -

model -

internalOnModelChanged

protected void internalOnModelChanged()

Description copied from class: Component

THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE.

Called anytime a model is changed via setModel or setModelObject.

Overrides:

internalOnModelChanged in class Component

See Also:

Component.internalOnModelChanged()

markFormComponentsInvalid

protected final void markFormComponentsInvalid()

Mark each form component on this form invalid.

markFormComponentsValid

protected final void markFormComponentsValid()

Mark each form component on this form and on nested forms valid.

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: Component

Processes the component tag. Overrides of this method most likely should call the super implementation.

Overrides:

onComponentTag in class Component

Parameters:

tag - Tag to modify

See Also:

Component.onComponentTag(ComponentTag)

getActionUrl

protected CharSequence getActionUrl()

Generates the action url for the form

Returns:

action url

renderPlaceholderTag

protected void renderPlaceholderTag(ComponentTag tag,
                                    Response response)

Description copied from class: Component

Renders a placeholder tag for the component when it is invisible and Component.setOutputMarkupPlaceholderTag(boolean) has been called with true.

Overrides:

renderPlaceholderTag in class Component

Parameters:

tag - component tag

response - response

See Also:

Component.renderPlaceholderTag(org.apache.wicket.markup.ComponentTag, org.apache.wicket.request.Response)

encodeUrlInHiddenFields

protected boolean encodeUrlInHiddenFields()

Returns:

true if form's method is 'get'

onComponentTagBody

public void onComponentTagBody(MarkupStream markupStream,
                               ComponentTag openTag)

Append an additional hidden input tag to support anchor tags that can submit a form.

Overrides:

onComponentTagBody in class MarkupContainer

Parameters:

markupStream - The markup stream

openTag - The open tag for the body

writeParamsAsHiddenFields

protected void writeParamsAsHiddenFields(String[] params,
                                         AppendingStringBuffer buffer)

Parameters:

params -

buffer -

onDetach

protected void onDetach()

Description copied from class: Component

Called to allow a component to detach resources after use. Overrides of this method MUST call the super implementation, the most logical place to do this is the last line of the override method.

Overrides:

onDetach in class Component

See Also:

Component.onDetach()

onError

protected void onError()

Method to override if you want to do something special when an error occurs (other than simply displaying validation errors).

onBeforeRender

protected void onBeforeRender()

Description copied from class: Component

Called just before a component is rendered.

NOTE: If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Overrides:

onBeforeRender in class Component

onSubmit

protected void onSubmit()

Implemented by subclasses to deal with form submits.

updateFormComponentModels

protected final void updateFormComponentModels()

Update the model of all components on this form and nested forms using the fields that were sent with the current request. This method only updates models when the Form.validate() is called first that takes care of the conversion for the FormComponents. Normally this method will not be called when a validation error occurs in one of the form components.

See Also:

FormComponent.updateModel()

validate

protected final void validate()

Validates the form by checking required fields, converting raw input and running validators for every form component, and last running global form validators. This method is typically called before updating any models.

NOTE: in most cases, custom validations on the form can be achieved using an IFormValidator that can be added using addValidator().

onValidate

protected void onValidate()

Callback during the validation stage of the form

onValidateModelObjects

protected void onValidateModelObjects()

Called after form components have updated their models. This is a late-stage validation that allows outside frameworks to validate any beans that the form is updating. This validation method is not preferred because at this point any errors will not unroll any changes to the model object, so the model object is in a modified state potentially containing illegal values. However, with external frameworks there may not be an alternate way to validate the model object. A good example of this is a JSR303 Bean Validator validating the model object to check any class-level constraints, in order to check such constaints the model object must contain the values set by the user.

validateComponents

protected final void validateComponents()

Triggers type conversion on form components

validateFormValidator

protected final void validateFormValidator(IFormValidator validator)

Validates form with the given form validator

Parameters:

validator -

validateFormValidators

protected final void validateFormValidators()

Triggers any added IFormValidators.

getInputNamePrefix

protected String getInputNamePrefix()

Allows to customize input names of form components inside this form.

Returns:

String that well be used as prefix to form component input names

getModel

public final IModel<T> getModel()

Description copied from interface: IGenericComponent

Typesafe getter for the model

Specified by:

getModel in interface IGenericComponent<T>

Returns:

the model

setModel

public final void setModel(IModel<T> model)

Description copied from interface: IGenericComponent

Typesafe setter for the model

Specified by:

setModel in interface IGenericComponent<T>

Parameters:

model - the new model

getModelObject

public final T getModelObject()

Description copied from interface: IGenericComponent

Typesafe getter for the model's object

Specified by:

getModelObject in interface IGenericComponent<T>

Returns:

the model object

setModelObject

public final void setModelObject(T object)

Description copied from interface: IGenericComponent

Typesafe setter for the model object

Specified by:

setModelObject in interface IGenericComponent<T>

Parameters:

object - the new model object

findForm

public static Form<?> findForm(Component component)

Parameters:

component -

Returns:

The parent form for component

renderHead

public void renderHead(IHeaderResponse response)

Render to the web response whatever the component wants to contribute to the head section.

Specified by:

renderHead in interface IHeaderContributor

Overrides:

renderHead in class Component

Parameters:

response - Response object

registerJavaScriptNamespaces

protected void registerJavaScriptNamespaces(IHeaderResponse response)

Produces javascript that registereds Wicket.Forms namespaces

Parameters:

response -

getRootFormRelativeId

public static String getRootFormRelativeId(Component component)

Utility method to assemble an id to distinct form components from different nesting levels. Useful to generate input names attributes.

Parameters:

component -

Returns:

form relative identification string