Module org.apache.wicket.extensions

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

Class OrderByBorder<S>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.border.Border

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

Type Parameters:

S - the type of the sorting parameter

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IComponentResolver, IRequestableComponent, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

Direct Known Subclasses:

AjaxFallbackOrderByBorder

public class OrderByBorder<S>
extends Border

A component that wraps markup with an OrderByLink. This has the advantage of being able to add the attribute modifier to the wrapping element as opposed to the link, so that it can be attached to <th> or any other element. For example: <th wicket:id="order-by-border">Heading</th>

Author:

Igor Vaynberg ( ivaynberg )

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.border.Border

Border.BorderBodyContainer

Field Summary

Fields

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

Fields inherited from class org.apache.wicket.markup.html.border.Border

BODY, BORDER

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor	Description
OrderByBorder(String id, S property, ISortStateLocator<S> stateLocator)

Method Summary

Modifier and Type	Method	Description
protected OrderByLink<S>	newOrderByLink(String id, S property, ISortStateLocator<S> stateLocator)	create new sort order toggling link
void	onComponentTag(ComponentTag tag)
protected void	onSortChanged()	This method is a hook for subclasses to perform an action after sort has changed

Methods inherited from class org.apache.wicket.markup.html.border.Border

add, addDequeuedComponent, addOrReplace, addToBorder, canDequeueTag, findComponentToDequeue, getBodyContainer, getMarkup, getRegionMarkup, newMarkupSourcingStrategy, onConfigure, queue, queueToBorder, remove, remove, removeAll, removeFromBorder, replace, replaceInBorder, resolve

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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

autoAdd, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, onRender, renderAll, renderAssociatedMarkup, renderNext, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, 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, getMarkupTag, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, 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.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

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 Details

OrderByBorder

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

Parameters:

id - see OrderByLink(java.lang.String, java.lang.Object, org.apache.wicket.extensions.markup.html.repeater.data.sort.ISortStateLocator)

property - see OrderByLink(java.lang.String, java.lang.Object, org.apache.wicket.extensions.markup.html.repeater.data.sort.ISortStateLocator)

stateLocator - see OrderByLink(java.lang.String, java.lang.Object, org.apache.wicket.extensions.markup.html.repeater.data.sort.ISortStateLocator)

Method Details

newOrderByLink

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

create new sort order toggling link

Parameters:

id - component id

property - sort property

stateLocator - sort state locator

Returns:

link

onSortChanged

protected void onSortChanged()

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

onComponentTag

public void onComponentTag(ComponentTag tag)

Overrides:

onComponentTag in class Component