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

Class NavigationToolbar

  • All Implemented Interfaces:
    Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IMetadataContext<Serializable,​org.apache.wicket.Component>, org.apache.wicket.IQueueRegion, 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
    Direct Known Subclasses:
    AjaxNavigationToolbar
    public class NavigationToolbar
extends AbstractToolbar
    Toolbar that displays links used to navigate the pages of the datatable as well as a message about which rows are being displayed and their total number in the data table.
    Author:
    Igor Vaynberg (ivaynberg)
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class org.apache.wicket.markup.html.panel.Panel

        PANEL

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.apache.wicket.Component newComplexNavigatorLabel​(String navigatorId, org.apache.wicket.markup.html.navigation.paging.IPageableItems table)
      Factory method used to create the navigator component in place of label that will be used by the datatable.
      protected org.apache.wicket.markup.html.WebComponent newNavigatorLabel​(String navigatorId, DataTable<?,​?> table)
      Factory method used to create the navigator label that will be used by the datatable.
      protected org.apache.wicket.markup.html.navigation.paging.PagingNavigator newPagingNavigator​(String navigatorId, DataTable<?,​?> table)
      Factory method used to create the paging navigator that will be used by the datatable
      protected void onConfigure()

      • Methods inherited from class org.apache.wicket.markup.html.panel.Panel

        getRegionMarkup, newMarkupSourcingStrategy

      • 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, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderAssociatedMarkup, renderNext, replace, 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, onComponentTag, 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 interface org.apache.wicket.IQueueRegion

        dequeue, newDequeueContext

    • Constructor Detail

      • NavigationToolbar

        public NavigationToolbar​(DataTable<?,​?> table)
        Constructor
        Parameters:
        table - data table this toolbar will be attached to

    • Method Detail

      • newPagingNavigator

        protected org.apache.wicket.markup.html.navigation.paging.PagingNavigator newPagingNavigator​(String navigatorId,
                                                                                             DataTable<?,​?> table)
        Factory method used to create the paging navigator that will be used by the datatable
        Parameters:
        navigatorId - component id the navigator should be created with
        table - dataview used by datatable
        Returns:
        paging navigator that will be used to navigate the data table

      • newNavigatorLabel

        protected org.apache.wicket.markup.html.WebComponent newNavigatorLabel​(String navigatorId,
                                                                       DataTable<?,​?> table)
        Factory method used to create the navigator label that will be used by the datatable. Use newComplexNavigatorLabel(String, IPageableItems) instead if you want to override label with a more complex component.
        Parameters:
        navigatorId - component id navigator label should be created with
        table - DataTable used by datatable
        Returns:
        navigator label that will be used to navigate the data table

      • newComplexNavigatorLabel

        protected org.apache.wicket.Component newComplexNavigatorLabel​(String navigatorId,
                                                               org.apache.wicket.markup.html.navigation.paging.IPageableItems table)
        Factory method used to create the navigator component in place of label that will be used by the datatable. This method takes precedence over newNavigatorLabel(String, DataTable). By default it returns null. NOTE: This is just a HACK to not break API in wicket 9.x and support use case of a more complex component as label. In wicket 10.x we will simply change the return type of NavigationToolbar#newNavigatorLabel(String, DataTable).
        Parameters:
        navigatorId - component id navigator label should be created with
        table - DataTable used by label
        Returns:
        navigator label that will be used to navigate the data table

      • onConfigure

        protected void onConfigure()
        Overrides:
        onConfigure in class org.apache.wicket.Component