org.apache.wicket.extensions.markup.html.repeater.data.sort

Class OrderByLink<S>

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.markup.html.link.Link<Void>

org.apache.wicket.extensions.markup.html.repeater.data.sort.OrderByLink<S>

Type Parameters:

S - the type of the sorting parameter

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IGenericComponent<Void>, IRequestListener, IHeaderContributor, ILinkListener, IRequestableComponent, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

AjaxFallbackOrderByLink

public class OrderByLink<S>
extends Link<Void>

A component that represents a sort header. When the link is clicked it will toggle the state of a sortable property within the sort state object.

Author:

Phil Kulak, Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SORT_ASCENDING_CSS_CLASS_KEY
static String	SORT_DESCENDING_CSS_CLASS_KEY
static String	SORT_NONE_CSS_CLASS_KEY

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

Fields inherited from interface org.apache.wicket.markup.html.link.ILinkListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
OrderByLink(String id, S property, ISortStateLocator<S> stateLocator) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected SortOrder	nextSortOrder(SortOrder order) returns the next sort order when changing it
void	onClick()
void	onComponentTag(ComponentTag tag)
protected void	onSortChanged() This method is a hook for subclasses to perform an action after sort has changed
OrderByLink<S>	sort() Re-sort data provider according to this link

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

appendAnchor, getAnchor, getAutoEnable, getModel, getModelObject, getOnClickScript, getPopupSettings, getStatelessHint, getURL, isEnabled, linksTo, onLinkClicked, setAnchor, setAutoEnable, setModel, setModelObject, setPopupSettings

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, onInitialize, 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, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, 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

Field Detail

SORT_ASCENDING_CSS_CLASS_KEY

public static final String SORT_ASCENDING_CSS_CLASS_KEY

SORT_DESCENDING_CSS_CLASS_KEY

public static final String SORT_DESCENDING_CSS_CLASS_KEY

SORT_NONE_CSS_CLASS_KEY

public static final String SORT_NONE_CSS_CLASS_KEY

Constructor Detail

OrderByLink

public OrderByLink(String id,
           S property,
           ISortStateLocator<S> stateLocator)

Constructor.

Parameters:

id - the component id of the link

property - the name of the sortable property this link represents. this value will be used as parameter for sort state object methods. sort state object will be located via the stateLocator argument.

stateLocator - locator used to locate sort state object that this will use to read/write state of sorted properties

Method Detail

onClick

public final void onClick()

Specified by:

onClick in class Link<Void>

See Also:

Link

onSortChanged

protected void onSortChanged()

This method is a hook for subclasses to perform an action after sort has changed

sort

public final OrderByLink<S> sort()

Re-sort data provider according to this link

Returns:

this

nextSortOrder

protected SortOrder nextSortOrder(SortOrder order)

returns the next sort order when changing it

Parameters:

order - previous sort order

Returns:

next sort order

onComponentTag

public void onComponentTag(ComponentTag tag)

Overrides:

onComponentTag in class Link<Void>