org.apache.wicket.ajax.markup.html

Class AjaxLink<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>

Type Parameters:

T - type of model object

All Implemented Interfaces:

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

public abstract class AjaxLink<T>
extends AbstractLink
implements IAjaxLink, IGenericComponent<T>

A component that allows a trigger request to be triggered via html anchor tag

Since:

1.2

Author:

Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

Field Summary

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
AjaxLink(String id) Construct.
AjaxLink(String id, IModel<T> model) Construct.

Method Summary

Methods

Modifier and Type	Method and Description
IModel<T>	getModel() Typesafe getter for the model
T	getModelObject() Typesafe getter for the model's object
protected boolean	getStatelessHint() Returns whether the component can be stateless.
protected AjaxEventBehavior	newAjaxEventBehavior(String event)
abstract void	onClick(AjaxRequestTarget target) Listener method invoked on the ajax request generated when the user clicks the link
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
protected void	onInitialize() This method is meant to be used as an alternative to initialize components.
void	setModel(IModel<T> model) Typesafe setter for the model
void	setModelObject(T object) Typesafe setter for the model object
protected void	updateAjaxAttributes(AjaxRequestAttributes attributes)

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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, 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, createConverter, 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, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, 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

Constructor Detail

AjaxLink

public AjaxLink(String id)

Construct.

Parameters:

id -

AjaxLink

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

Construct.

Parameters:

id -

model -

Method Detail

onInitialize

protected void onInitialize()

Description copied from class: Component

This method is meant to be used as an alternative to initialize components. Usually the component's constructor is used for this task, but sometimes a component cannot be initialized in isolation, it may need to access its parent component or its markup in order to fully initialize. This method is invoked once per component's lifecycle when a path exists from this component to the Page thus providing the component with an atomic callback when the component's environment is built out.

Overrides must call super#Component.onInitialize(). Usually this should be the first thing an override does, much like a constructor.

Parent containers are guaranteed to be initialized before their children

It is safe to use Component.getPage() in this method

NOTE:The timing of this call is not precise, the contract is that it is called sometime before Component.onBeforeRender().

Overrides:

onInitialize in class MarkupContainer

newAjaxEventBehavior

protected AjaxEventBehavior newAjaxEventBehavior(String event)

Parameters:

event - the name of the default event on which this link will listen to

Returns:

the ajax behavior which will be executed when the user clicks the link

updateAjaxAttributes

protected void updateAjaxAttributes(AjaxRequestAttributes attributes)

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

onClick

public abstract void onClick(AjaxRequestTarget target)

Listener method invoked on the ajax request generated when the user clicks the link

Specified by:

onClick in interface IAjaxLink

Parameters:

target -

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

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