Package org.hippoecm.frontend.plugins.standards.list

Class AbstractListingPlugin<T>

java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
org.apache.wicket.markup.html.panel.Panel
org.hippoecm.frontend.service.render.AbstractRenderService<T>
org.hippoecm.frontend.service.render.RenderService<T>
org.hippoecm.frontend.service.render.RenderPlugin<T>
org.hippoecm.frontend.plugins.standards.list.AbstractListingPlugin<T>
All Implemented Interfaces:
Serializable, Iterable<org.apache.wicket.Component>, EventListener, 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, IObserver, IPlugin, ListDataTable.TableSelectionListener<Node>, IRenderService
Direct Known Subclasses:
ExpandCollapseListingPlugin
public abstract class AbstractListingPlugin<T> extends RenderPlugin<T> implements ListDataTable.TableSelectionListener<Node>
Base class for displaying a list of nodes. This class will take care of observing the provider, instantiating the datatable. Subclasses must provide a table definition and a data provider.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.hippoecm.frontend.service.render.RenderService

    RenderService.ExtensionPoint

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected ListDataTable<Node>
    dataTable
     

    Fields inherited from class org.hippoecm.frontend.service.render.AbstractRenderService

    BEHAVIOR, children, CSS_ID, DEFAULT_LOCALE, EXTENSIONS_ID, FEEDBACK, FEEDBACK_SCOPE, MODEL_ID, SKIN_ID, VARIANT_ID, VISIBLE, WICKET_ID

    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

    Fields inherited from interface org.hippoecm.frontend.plugin.IPlugin

    CLASSNAME

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractListingPlugin(IPluginContext context, IPluginConfig config)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected ListDataTable<Node>
    getListDataTable(String id, TableDefinition<Node> tableDefinition, org.apache.wicket.extensions.markup.html.repeater.data.table.ISortableDataProvider<Node,String> dataProvider, ListDataTable.TableSelectionListener<Node> selectionListener, boolean triState, ListPagingDefinition pagingDefinition)
     
    protected org.apache.wicket.model.IModel<Node>
    getSelectedModel()
     
    protected TableDefinition<Node>
    getTableDefinition()
     
    protected boolean
    isOrderable()
     
    protected abstract org.apache.wicket.extensions.markup.html.repeater.data.table.ISortableDataProvider<Node,String>
    newDataProvider()
     
    protected ListDataTable<Node>
    newListDataTable(String id, TableDefinition<Node> tableDefinition, org.apache.wicket.extensions.markup.html.repeater.data.table.ISortableDataProvider<Node,String> dataProvider, ListDataTable.TableSelectionListener<Node> selectionListener, boolean triState, ListPagingDefinition pagingDefinition)
     
    protected abstract TableDefinition<Node>
    newTableDefinition()
     
    void
    onModelChanged()
     
    protected void
    onSelectionChanged(org.apache.wicket.model.IModel<Node> model)
     
    protected void
    onStop()
    Called during the stop phase of the plugin.
    void
    render(PluginRequestTarget target)
    Called after user events and JCR events have been handled, but before the rendering has started.
    void
    selectionChanged(org.apache.wicket.model.IModel model)
     
    protected void
    setSelectedModel(org.apache.wicket.model.IModel<Node> model)
     
    void
    updateSelection(org.apache.wicket.model.IModel<Node> model)
     

    Methods inherited from class org.hippoecm.frontend.service.render.RenderPlugin

    newPlugin, newPlugin, onStart, start, stop

    Methods inherited from class org.hippoecm.frontend.service.render.RenderService

    createExtensionPoint

    Methods inherited from class org.hippoecm.frontend.service.render.AbstractRenderService

    addExtensionPoint, bind, focus, getBundleName, getComponent, getDialogService, getId, getMarkupId, getModel, getModelObject, getObservable, getParentService, getPluginConfig, getPluginContext, getResourceBundleModel, getSession, getVariation, isActive, onAfterRender, onBeforeRender, onComponentTag, onComponentTagBody, onEvent, redraw, removeExtensionPoint, setDefaultModel, setModel, setModelObject, unbind, updateModel

    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, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, 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, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, 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, onConfigure, onEvent, 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

  • Constructor Details

  • Method Details

    • getSelectedModel

      protected org.apache.wicket.model.IModel<Node> getSelectedModel()

    • setSelectedModel

      protected void setSelectedModel(org.apache.wicket.model.IModel<Node> model)

    • getListDataTable

      protected ListDataTable<Node> getListDataTable(String id, TableDefinition<Node> tableDefinition, org.apache.wicket.extensions.markup.html.repeater.data.table.ISortableDataProvider<Node,String> dataProvider, ListDataTable.TableSelectionListener<Node> selectionListener, boolean triState, ListPagingDefinition pagingDefinition)

    • newListDataTable

      protected ListDataTable<Node> newListDataTable(String id, TableDefinition<Node> tableDefinition, org.apache.wicket.extensions.markup.html.repeater.data.table.ISortableDataProvider<Node,String> dataProvider, ListDataTable.TableSelectionListener<Node> selectionListener, boolean triState, ListPagingDefinition pagingDefinition)

    • getTableDefinition

      protected TableDefinition<Node> getTableDefinition()

    • newDataProvider

      protected abstract org.apache.wicket.extensions.markup.html.repeater.data.table.ISortableDataProvider<Node,String> newDataProvider()

    • newTableDefinition

      protected abstract TableDefinition<Node> newTableDefinition()

    • selectionChanged

      public void selectionChanged(org.apache.wicket.model.IModel model)
      Specified by:
      selectionChanged in interface ListDataTable.TableSelectionListener<T>

    • updateSelection

      public void updateSelection(org.apache.wicket.model.IModel<Node> model)

    • onSelectionChanged

      protected void onSelectionChanged(org.apache.wicket.model.IModel<Node> model)

    • onModelChanged

      public void onModelChanged()
      Overrides:
      onModelChanged in class org.apache.wicket.Component

    • render

      public void render(PluginRequestTarget target)
      Description copied from class: AbstractRenderService
      Called after user events and JCR events have been handled, but before the rendering has started. Plugins can register Components with the request target to enlist in the rendering phase.

      Implementations that use extensions must call the same method on those.

      Specified by:
      render in interface IRenderService
      Overrides:
      render in class RenderPlugin<T>

    • isOrderable

      protected boolean isOrderable()

    • onStop

      protected void onStop()
      Description copied from class: RenderPlugin
      Called during the stop phase of the plugin.

      NOTE* If you override this, you *must* call super.onStop() within your implementation.

      Overrides:
      onStop in class RenderPlugin<T>