com.neurosys.site.wicket.components

Class AbstractListPanel<PM,RM,DP extends org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup

org.apache.wicket.markup.html.panel.Panel

com.neurosys.site.wicket.components.AbstractListPanel<PM,RM,DP>

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderPartContainerProvider

Direct Known Subclasses:

UserListPanel

public abstract class AbstractListPanel<PM,RM,DP extends org.apache.wicket.extensions.markup.html.repeater.util.SortableDataProvider>
extends org.apache.wicket.markup.html.panel.Panel

A generic Panel that can represent Simple Lists.
It assumes an extension of SortableDataProvider is used to provide the List.

The Table renders with the css: numberic, itemName, hide.
Wicket ID:

• linkToItem - The Id for the hyperlink in the item
• selectable - The id of the fragment that defines the item list
• listing - The Id of the Table
• addItem - The Id for the icon/Link to Add a new Item to the List

One can also override the 'rows' property to specify the number of rows per listing (before pagination starts)

Generic Params: PM - Page Model Type, RM - Row Model Type, DP - Data Provider Type

Author:

Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields

Modifier and Type	Field and Description
protected int	rows

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
AbstractListPanel(String id, org.apache.wicket.model.IModel<PM> model)

Method Summary

Modifier and Type	Method and Description
Properties	getAdminConfiguration()
protected abstract Class	getClassForOpenPage(org.apache.wicket.model.IModel<RM> rowModel) Define the Class of the Page that is to open (on Link or Add new).
DP	getCustomSortableDataProvider()
protected abstract String	getNameOfItem(org.apache.wicket.model.IModel<RM> rowModel) Get the name of the link/list item for the row
protected abstract org.apache.wicket.PageParameters	getPageParamsForNewItem() Define the Parameters of the page to Open when an Item is Added.
protected abstract org.apache.wicket.PageParameters	getPageParamsForOpenItem(org.apache.wicket.model.IModel<RM> rowModel) Define the Parameters of the page to Open when an Item is selected.
protected abstract void	initDataProviderInstance(org.apache.wicket.model.IModel<PM> model) The Data provider may select list on the panel based on a criteria.
protected void	modifyColumns(List<org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<?>> columns) Can add new coloumns (in addition to ID & Name), can drop also from pre defined columns list etc.
void	onInitialize()
void	setAdminConfiguration(Properties adminConfiguration)
void	setCustomSortableDataProvider(DP customSortableDataProvider)
protected org.apache.wicket.Component	wrapAddButton(org.apache.wicket.Component link, int dataSize) One can change & toggle visibility etc

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

onComponentTag, onComponentTagBody, renderHead

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

newHeaderPartContainer, renderHeadFromAssociatedMarkupFile

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

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onConfigure, onDetach, onEndRequest, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, 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

Field Detail

rows

protected int rows

Constructor Detail

AbstractListPanel

public AbstractListPanel(String id,
                         org.apache.wicket.model.IModel<PM> model)

Method Detail

getAdminConfiguration

public Properties getAdminConfiguration()

setAdminConfiguration

public void setAdminConfiguration(Properties adminConfiguration)

getCustomSortableDataProvider

public DP getCustomSortableDataProvider()

setCustomSortableDataProvider

public void setCustomSortableDataProvider(DP customSortableDataProvider)

initDataProviderInstance

protected abstract void initDataProviderInstance(org.apache.wicket.model.IModel<PM> model)

The Data provider may select list on the panel based on a criteria. The criteria is assumed to come from the Model set into the Panel. This performs that initialization from OnInitialize() in the Panel.

Parameters:

model - as IModel

getPageParamsForOpenItem

protected abstract org.apache.wicket.PageParameters getPageParamsForOpenItem(org.apache.wicket.model.IModel<RM> rowModel)

Define the Parameters of the page to Open when an Item is selected. (See getClassForOpenPage)

Parameters:

rowModel/itemModel - as IModel

getPageParamsForNewItem

protected abstract org.apache.wicket.PageParameters getPageParamsForNewItem()

Define the Parameters of the page to Open when an Item is Added. (See getClassForOpenPage)

getClassForOpenPage

protected abstract Class getClassForOpenPage(org.apache.wicket.model.IModel<RM> rowModel)

Define the Class of the Page that is to open (on Link or Add new). rowModel can be null for references to New Item/Add Item.

Parameters:

rowModel/itemModel - as IModel

getNameOfItem

protected abstract String getNameOfItem(org.apache.wicket.model.IModel<RM> rowModel)

Get the name of the link/list item for the row

Parameters:

rowModel/itemModel - as IModel

Returns:

modifyColumns

protected void modifyColumns(List<org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn<?>> columns)

Can add new coloumns (in addition to ID & Name), can drop also from pre defined columns list etc.

Parameters:

columns - as List of IColumn

onInitialize

public void onInitialize()

Overrides:

onInitialize in class org.apache.wicket.Component

wrapAddButton

protected org.apache.wicket.Component wrapAddButton(org.apache.wicket.Component link,
                                                    int dataSize)

One can change & toggle visibility etc

Parameters:

link -

Returns: