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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, IHeaderContributor, IComponentResolver, IRequestableComponent, IHierarchical<Component>

public class OrderByBorder
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 inherited from class org.apache.wicket.markup.html.border.Border

BODY, BORDER

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

OrderByBorder(java.lang.String id, java.lang.String property, ISortStateLocator stateLocator)

OrderByBorder(java.lang.String id, java.lang.String property, ISortStateLocator stateLocator, OrderByLink.ICssProvider cssProvider)

Method Summary

protected OrderByLink	newOrderByLink(java.lang.String id, java.lang.String property, ISortStateLocator stateLocator) create new sort order toggling link
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, addOrReplace, addToBorder, getBodyContainer, getMarkup, newMarkupSourcingStrategy, remove, remove, removeAll, removeFromBorder, replace, replaceInBorder, resolve

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

getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkupType, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, onRender, renderAll, renderAssociatedMarkup, renderNext, 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, 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, getFeedbackMessage, 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, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OrderByBorder

public OrderByBorder(java.lang.String id,
                     java.lang.String property,
                     ISortStateLocator stateLocator,
                     OrderByLink.ICssProvider cssProvider)

Parameters:

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

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

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

cssProvider - see OrderByLink.OrderByLink(String, String, ISortStateLocator, org.apache.wicket.extensions.markup.html.repeater.data.sort.OrderByLink.ICssProvider)

OrderByBorder

public OrderByBorder(java.lang.String id,
                     java.lang.String property,
                     ISortStateLocator stateLocator)

Parameters:

id - see OrderByLink.OrderByLink(String, String, ISortStateLocator)

property - see OrderByLink.OrderByLink(String, String, ISortStateLocator)

stateLocator - see OrderByLink.OrderByLink(String, String, ISortStateLocator)

Method Detail

newOrderByLink

protected OrderByLink newOrderByLink(java.lang.String id,
                                     java.lang.String property,
                                     ISortStateLocator 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