wicket.markup.html.form
Class Button

java.lang.Object
  extended by wicket.Component
      extended by wicket.MarkupContainer
          extended by wicket.markup.html.WebMarkupContainer
              extended by wicket.markup.html.form.FormComponent
                  extended by wicket.markup.html.form.Button
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
ImageButton, SubmitLink

public class Button
extends FormComponent

A form button.

Within a form, you can nest Button components. Note that you don't have to do this to let the form work (a simple <input type="submit".. suffices), but if you want to have different kinds of submit behavior it might be a good idea to use Buttons.

The model property is used to set the "value" attribute. It will thus be the label of the button that shows up for end users. If you want the attribute to keep it's markup attribute value, don't provide a model, or let it return an empty string.

When you add a Wicket Button to a form, and that button is clicked, by default the button's onSubmit method is called first, and after that the form's onSubmit method is called. If you want to change this (e.g. you don't want to call the form's onSubmit method, or you want it called before the button's onSubmit method), you can override Form.delegateSubmit.

One other option you should know of is the 'defaultFormProcessing' property of Button components. When you set this to false (default is true), all validation and formupdating is bypassed and the onSubmit method of that button is called directly, and the onSubmit method of the parent form is not called. A common use for this is to create a cancel button.

Author:
Jonathan Locke, Eelco Hillenius
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class wicket.markup.html.form.FormComponent
FormComponent.IVisitor
 
Nested classes/interfaces inherited from class wicket.Component
Component.ComponentModelChange, Component.EnabledChange, Component.VisibilityChange
 
Field Summary
 
Fields inherited from class wicket.markup.html.form.FormComponent
FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR
 
Fields inherited from class wicket.Component
ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER
 
Constructor Summary
Button(java.lang.String id)
          Constructor without a model.
Button(java.lang.String id, IModel model)
          Constructor taking an model for rendering the 'label' of the button (the value attribute of the input/button tag).
 
Method Summary
 boolean getDefaultFormProcessing()
          Gets the defaultFormProcessing property.
protected  java.lang.String getOnClickScript()
          Gets any script that should rendered as the "onclick" attribute of the button.
protected  IModel initModel()
          Override of the default initModel behaviour.
protected  void onComponentTag(ComponentTag tag)
          Processes the component tag.
protected  void onSubmit()
          Override this method to provide special submit handling in a multi-button form.
 Button setDefaultFormProcessing(boolean defaultFormProcessing)
          Sets the defaultFormProcessing property.
 void updateModel()
          This method does nothing, as any model of a button is only used to display the button's label (by setting it's markup attribute "value").
 
Methods inherited from class wicket.markup.html.form.FormComponent
add, checkRequired, clearInput, convert, convertValue, error, getConvertedInput, getForm, getInput, getInputAsArray, getInputName, getLabel, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputAsStringArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, isValidated, onDetach, onDisabled, onInvalid, onValid, processInput, setLabel, setModelValue, setModelValue, setPersistent, setRequired, setType, supportsPersistence, valid, validate, validateRequired, validateValidators
 
Methods inherited from class wicket.markup.html.WebMarkupContainer
getMarkupType, getWebPage
 
Methods inherited from class wicket.MarkupContainer
add, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, internalAdd, internalAttach, internalDetach, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren
 
Methods inherited from class wicket.Component
add, addStateChange, checkComponentTag, checkComponentTagAttribute, continueToOriginalDestination, debug, detachBehaviors, detachModel, detachModels, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getApplicationPages, getApplicationSettings, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getOutputMarkupId, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasErrorMessage, hasFeedbackMessage, info, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isBehaviorAccepted, isEnableAllowed, isEnabled, isHeadRendered, isIgnoreAttributeModifier, isRenderAllowed, isVersioned, isVisible, isVisibleInHierarchy, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onEndRequest, onModelChanged, onModelChanging, onRender, redirectToInterceptPage, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderedBehaviors, renderHead, replaceComponentTagBody, replaceWith, resetHeadRendered, sameRootModel, sameRootModel, setAuto, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMetaData, setModelObject, setOutputMarkupId, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Button

public Button(java.lang.String id)
Constructor without a model. Buttons without models leave the markup attribute "value". Provide a model if you want to set the button's label dynamically.

See Also:
Component.Component(String)

Button

public Button(java.lang.String id,
              IModel model)
Constructor taking an model for rendering the 'label' of the button (the value attribute of the input/button tag). Use a StringResourceModel for a localized value.

Parameters:
id - Component id
model - The model property is used to set the "value" attribute. It will thus be the label of the button that shows up for end users. If you want the attribute to keep it's markup attribute value, don't provide a model, or let it return an empty string.
Method Detail

initModel

protected IModel initModel()
Override of the default initModel behaviour. This component will not use any compound model a parent, but only a model that is explicitly set.

Overrides:
initModel in class Component
Returns:
The model
See Also:
Component.initModel()

getDefaultFormProcessing

public final boolean getDefaultFormProcessing()
Gets the defaultFormProcessing property. When false (default is true), all validation and formupdating is bypassed and the onSubmit method of that button is called directly, and the onSubmit method of the parent form is not called. A common use for this is to create a cancel button.

Returns:
defaultFormProcessing

setDefaultFormProcessing

public final Button setDefaultFormProcessing(boolean defaultFormProcessing)
Sets the defaultFormProcessing property. When false (default is true), all validation and formupdating is bypassed and the onSubmit method of that button is called directly, and the onSubmit method of the parent form is not called. A common use for this is to create a cancel button.

Parameters:
defaultFormProcessing - defaultFormProcessing
Returns:
This

updateModel

public void updateModel()
This method does nothing, as any model of a button is only used to display the button's label (by setting it's markup attribute "value").

Overrides:
updateModel in class FormComponent
See Also:
FormComponent.updateModel()

getOnClickScript

protected java.lang.String getOnClickScript()
Gets any script that should rendered as the "onclick" attribute of the button. Returns null by default, override this method to provide any script.

Returns:
Any onClick JavaScript that should be used, returns null by default

onComponentTag

protected void onComponentTag(ComponentTag tag)
Processes the component tag.

Overrides:
onComponentTag in class FormComponent
Parameters:
tag - Tag to modify
See Also:
Component.onComponentTag(ComponentTag)

onSubmit

protected void onSubmit()
Override this method to provide special submit handling in a multi-button form. It is called whenever the user clicks this particular button.



Copyright © 2004-2007 Wicket developers. All Rights Reserved.