org.wicketstuff.urlfragment

Class BookmarkableAjaxLink<T>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.link.AbstractLink

org.apache.wicket.ajax.markup.html.AjaxLink<T>

org.wicketstuff.urlfragment.BookmarkableAjaxLink<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.ajax.markup.html.IAjaxLink, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<T>, 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 BookmarkableAjaxLink<T>
extends org.apache.wicket.ajax.markup.html.AjaxLink<T>
implements IBookmarkableComponent

This is an AjaxLink which will set an URL fragment parameter in the browser.

You can provide a default parameter to the constructors so it will be set automatically during event handling. You can also set or remove parameters by yourself using #setFragmentParameter(String, String) or removeFragmentParameter(String).

Author:

Martin Knopf

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultarameterName
protected String	defaultParamterValue

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
BookmarkableAjaxLink(String id) Constructor.
BookmarkableAjaxLink(String id, org.apache.wicket.model.IModel<T> model) Constructor.
BookmarkableAjaxLink(String id, org.apache.wicket.model.IModel<T> model, String parameterName, String parameterValue) Constructor.
BookmarkableAjaxLink(String id, String parameterName, String parameterValue) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFragmentParameter(String parameterName, Object parameterValue, String delimiter) Deprecated.
abstract void	onBookmarkableClick(org.apache.wicket.ajax.AjaxRequestTarget target) Handles the click event.
void	onClick(org.apache.wicket.ajax.AjaxRequestTarget target)
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.AjaxLink

getModel, getModelObject, newAjaxEventBehavior, onComponentTag, onInitialize, setModel, setModelObject, updateAjaxAttributes

Methods inherited from class org.apache.wicket.markup.html.link.AbstractLink

disableLink, getBody, onComponentTagBody, onDetach, setBody

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

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onRender, queue, 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, canCallListenerInterfaceAfterExpiry, 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, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, 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, 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

Field Detail

defaultarameterName

protected String defaultarameterName

defaultParamterValue

protected String defaultParamterValue

Constructor Detail

BookmarkableAjaxLink

public BookmarkableAjaxLink(String id)

Constructor.

Parameters:

id -

BookmarkableAjaxLink

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

Constructor.

Parameters:

id -

model -

BookmarkableAjaxLink

public BookmarkableAjaxLink(String id,
                    String parameterName,
                    String parameterValue)

Constructor. Sets given URL fragment parameter in the browser during the click event. Be aware that the given parameter name and value will not be set if they are empty.

Parameters:

id -

parameterName -

parameterValue -

BookmarkableAjaxLink

public BookmarkableAjaxLink(String id,
                    org.apache.wicket.model.IModel<T> model,
                    String parameterName,
                    String parameterValue)

Constructor. Sets given default URL fragment parameter during the click event. Be aware that the given parameter name and value will not be set if either one is empty and that the parameter will be overwritten if it already exists.

Parameters:

id -

model -

parameterName -

parameterValue -

Method Detail

onClick

public void onClick(org.apache.wicket.ajax.AjaxRequestTarget target)

Specified by:

onClick in interface org.apache.wicket.ajax.markup.html.IAjaxLink

Specified by:

onClick in class org.apache.wicket.ajax.markup.html.AjaxLink<T>

onBookmarkableClick

public abstract void onBookmarkableClick(org.apache.wicket.ajax.AjaxRequestTarget target)

Handles the click event. Your default URL fragment parameter was already set automatically if it wasn't empty. You can use urlFragment() inside this method.

Parameters:

target -

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