org.wicketstuff.urlfragment

Class BookmarkableAjaxButton

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<String>

org.apache.wicket.markup.html.form.Button

org.apache.wicket.ajax.markup.html.form.AjaxButton

org.wicketstuff.urlfragment.BookmarkableAjaxButton

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<String>, org.apache.wicket.markup.html.form.IFormModelUpdateListener, org.apache.wicket.markup.html.form.IFormSubmitter, org.apache.wicket.markup.html.form.IFormSubmittingComponent, org.apache.wicket.markup.html.form.IFormVisitorParticipant, org.apache.wicket.markup.html.form.ILabelProvider<String>, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable, IBookmarkableComponent

public abstract class BookmarkableAjaxButton
extends org.apache.wicket.ajax.markup.html.form.AjaxButton
implements IBookmarkableComponent

This is an AjaxButton with the ability to set and remove URL fragment parameters.

You can set or remove parameters using #setFragmentParameter(String, String) or removeFragmentParameter(String) during your handling of the submit and error event.

Author:

Martin Knopf

See Also:

Serialized Form

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_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
BookmarkableAjaxButton(String id)
BookmarkableAjaxButton(String id, org.apache.wicket.markup.html.form.Form<?> form)
BookmarkableAjaxButton(String id, org.apache.wicket.model.IModel<String> model)
BookmarkableAjaxButton(String id, org.apache.wicket.model.IModel<String> model, org.apache.wicket.markup.html.form.Form<?> form)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFragmentParameter(String parameterName, Object parameterValue, String delimiter) Deprecated.
protected abstract void	onBookmarkableError(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.markup.html.form.Form<?> form) Override to handle the error event.
protected abstract void	onBookmarkableSubmit(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.markup.html.form.Form<?> form) Override to handle the submit event.
protected void	onError(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.markup.html.form.Form<?> form)
protected void	onSubmit(org.apache.wicket.ajax.AjaxRequestTarget target, org.apache.wicket.markup.html.form.Form<?> form)
void	removeFragmentParameter(String parameterName) Deprecated.
void	renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
void	setFragmentParameter(String parameterName, Object parameterValue) Deprecated.
protected UrlFragment	urlFragment() Returns a UrlFragment connected to the current AjaxRequestTarget.

Methods inherited from class org.apache.wicket.ajax.markup.html.form.AjaxButton

getChannel, getForm, newAjaxFormSubmitBehavior, onAfterSubmit, onInitialize, updateAjaxAttributes

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

getDefaultFormProcessing, getOnClickScript, initModel, onAfterSubmit, onComponentTag, onError, onSubmit, setDefaultFormProcessing, updateModel

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

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

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

getLabel

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, onComponentTagBody, 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, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, 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

Methods inherited from interface org.apache.wicket.markup.html.form.IFormSubmittingComponent

getInputName

Constructor Detail

BookmarkableAjaxButton

public BookmarkableAjaxButton(String id)

BookmarkableAjaxButton

public BookmarkableAjaxButton(String id,
                      org.apache.wicket.model.IModel<String> model)

BookmarkableAjaxButton

public BookmarkableAjaxButton(String id,
                      org.apache.wicket.markup.html.form.Form<?> form)

BookmarkableAjaxButton

public BookmarkableAjaxButton(String id,
                      org.apache.wicket.model.IModel<String> model,
                      org.apache.wicket.markup.html.form.Form<?> form)

Method Detail

onSubmit

protected void onSubmit(org.apache.wicket.ajax.AjaxRequestTarget target,
            org.apache.wicket.markup.html.form.Form<?> form)

Overrides:

onSubmit in class org.apache.wicket.ajax.markup.html.form.AjaxButton

onError

protected void onError(org.apache.wicket.ajax.AjaxRequestTarget target,
           org.apache.wicket.markup.html.form.Form<?> form)

Overrides:

onError in class org.apache.wicket.ajax.markup.html.form.AjaxButton

onBookmarkableSubmit

protected abstract void onBookmarkableSubmit(org.apache.wicket.ajax.AjaxRequestTarget target,
                        org.apache.wicket.markup.html.form.Form<?> form)

Override to handle the submit event. You can use urlFragment() inside this method.

Parameters:

target -

form -

onBookmarkableError

protected abstract void onBookmarkableError(org.apache.wicket.ajax.AjaxRequestTarget target,
                       org.apache.wicket.markup.html.form.Form<?> form)

Override to handle the error event. You can use urlFragment() inside this method.

Parameters:

target -

form -

setFragmentParameter

@Deprecated
public void setFragmentParameter(String parameterName,
                                   Object parameterValue)

Deprecated.

Description copied from interface: IBookmarkableComponent

Sets the given URL fragment parameter by adding a JavaScript to the current AjaxRequestTarget.

The parameter will be overwritten if it already exists.

Specified by:

setFragmentParameter in interface IBookmarkableComponent

Parameters:

parameterName - the name of your URL fragment parameter to set

parameterValue - the value of your URL fragment parameter to set

addFragmentParameter

@Deprecated
public void addFragmentParameter(String parameterName,
                                   Object parameterValue,
                                   String delimiter)

Deprecated.

Description copied from interface: IBookmarkableComponent

Use the following instead: urlFragment().addParameter(parameterName, parameterValue, delimiter);

Sets the given URL fragment parameter by adding a JavaScript to the current AjaxRequestTarget.

The parameter will be created if it doesn't exists yet.

The value will be appended with the specified delimiter if the parameter already exists.

Specified by:

addFragmentParameter in interface IBookmarkableComponent

Parameters:

parameterName - the name of your URL fragment parameter to set

parameterValue - the value of your URL fragment parameter to set

delimiter - the delimiter the given value will be appended with if the given parameter already exists

removeFragmentParameter

@Deprecated
public void removeFragmentParameter(String parameterName)

Deprecated.

Description copied from interface: IBookmarkableComponent

Use the following instead: urlFragment().removeParameter(parameterName);

Removes the given URL fragment parameter by adding a JavaScript to the current AjaxRequestTarget.

Specified by:

removeFragmentParameter in interface IBookmarkableComponent

Parameters:

parameterName - the name of your URL fragment parameter to set

urlFragment

protected UrlFragment urlFragment()

Returns a UrlFragment connected to the current AjaxRequestTarget. Use the UrlFragment to update the URL fragment in the browser after the current AJAX event.

Returns:

renderHead

public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)

Specified by:

renderHead in interface org.apache.wicket.markup.html.IHeaderContributor

Overrides:

renderHead in class org.apache.wicket.Component