com.neurosys.site.wicket.components

Class AssymetricGridView<T>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.repeater.AbstractRepeater

org.apache.wicket.markup.repeater.RepeatingView

org.apache.wicket.markup.repeater.RefreshingView<T>

org.apache.wicket.markup.repeater.AbstractPageableView<T>

org.apache.wicket.markup.repeater.data.DataViewBase<T>

com.neurosys.site.wicket.components.AssymetricGridView<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.navigation.paging.IPageable

public abstract class AssymetricGridView<T>
extends org.apache.wicket.markup.repeater.data.DataViewBase<T>

Support A-Symmetric Grid Views. A verbatim copy of GridView in most places; except those that required tweaking and were proving weird to override cleanly. Issues with GridView that make it unfit for extension:
The GridView class assumes Symmetry of Rows x Cols. In addition due to certain non standardized API methods being final or private the setRows() & setCols() have been overriden completely to circumvent the use of GridView.updateItemsPerPage() (which uses internalSetRowsPerPage) , the name of the method is not appropriate and in the future should be able to override it with asymmetric implementations. Also, columns & rows is private. If getters & setters of columns & rows were simple bean methods those could have been used. But since they involve complex logic that requires visibility of the variables this too becomes unfit for consumption.

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 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
AssymetricGridView(String id, org.apache.wicket.markup.repeater.data.IDataProvider<T> dataProvider, Integer rows, int cols, AssymetricDescriptor assymetricDescriptor)

Method Summary

Modifier and Type	Method and Description
protected void	addItems(Iterator<org.apache.wicket.markup.repeater.Item<T>> items) NOTE CHANGE : Accounts for Assymetrical Structures
protected abstract boolean	currentCellEmpty(int currentRow, int currentCol) The Grid here is not a regular Symmetrical Grid; hence overriding certain aspects of Grid.
protected abstract boolean	currentCellMerged(int currentRow, int currentCol) The Grid here is not a regular Symmetrical Grid; hence overriding certain aspects of Grid.
protected abstract boolean	currentItemInMergedCell(int index) Checks if the Item with the index is a part of a Merged space
protected void	customizeCell(org.apache.wicket.markup.repeater.Item<T> cellItem, int row, int col)
AssymetricDescriptor	getAssymetricDescriptor()
int	getColumns()
org.apache.wicket.markup.repeater.data.IDataProvider<T>	getDataProvider()
Iterator<org.apache.wicket.markup.repeater.Item<T>>	getItems()
int	getRows()
boolean	isAllRows() The Grid will represent all rows from the Data Provider
protected org.apache.wicket.markup.repeater.Item<T>	newEmptyItem(String id, int index) Create a Item which represents an empty cell (there is no model for it in the DataProvider) Can be null if we do not want the empty cell added to the Grid at all.
protected org.apache.wicket.markup.repeater.Item<?>	newRowItem(String id, int index) Create a new Item which will hold a row.
protected abstract void	populateEmptyItem(org.apache.wicket.markup.repeater.Item<T> item, int row, int col) Add component to an Item for which there is no model anymore and is shown in a cell.
void	setAllRows(boolean allRows) The Grid will represent all rows from the Data Provider
void	setAssymetricDescriptor(AssymetricDescriptor assymetricDescriptor)
AssymetricGridView<T>	setColumns(int cols) Sets number of columns
AssymetricGridView<T>	setRows(int rows) Sets number of rows per page
protected void	updateItemsPerPage() NOTE CHANGE : Accounts for Assymetrical Structures

Methods inherited from class org.apache.wicket.markup.repeater.data.DataViewBase

getItemModels, internalGetDataProvider, internalGetItemCount, onDetach

Methods inherited from class org.apache.wicket.markup.repeater.AbstractPageableView

getCurrentPage, getItemCount, getItemModels, getPageCount, getRowCount, getViewOffset, getViewSize, internalGetRowsPerPage, internalSetRowsPerPage, onBeforeRender, setCurrentPage

Methods inherited from class org.apache.wicket.markup.repeater.RefreshingView

getItemReuseStrategy, newItem, newItemFactory, onPopulate, populateItem, setItemReuseStrategy

Methods inherited from class org.apache.wicket.markup.repeater.RepeatingView

newChildId, renderIterator

Methods inherited from class org.apache.wicket.markup.repeater.AbstractRepeater

onRender, renderChild

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, onComponentTagBody, 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, onBeginRequest, onComponentTag, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, 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

Constructor Detail

AssymetricGridView

public AssymetricGridView(String id,
                          org.apache.wicket.markup.repeater.data.IDataProvider<T> dataProvider,
                          Integer rows,
                          int cols,
                          AssymetricDescriptor assymetricDescriptor)

Parameters:

id - component id

dataProvider - data provider

rows - @NotNull false (null implies allRows = true)

Method Detail

getAssymetricDescriptor

public AssymetricDescriptor getAssymetricDescriptor()

setAssymetricDescriptor

public void setAssymetricDescriptor(AssymetricDescriptor assymetricDescriptor)

isAllRows

public boolean isAllRows()

The Grid will represent all rows from the Data Provider

Returns:

boolean

setAllRows

public void setAllRows(boolean allRows)

The Grid will represent all rows from the Data Provider

Parameters:

boolean -

getColumns

public int getColumns()

Returns:

number of columns

setColumns

public AssymetricGridView<T> setColumns(int cols)

Sets number of columns

Parameters:

cols - number of columns

Returns:

this for chaining

getRows

public int getRows()

Returns:

number of rows per page

setRows

public AssymetricGridView<T> setRows(int rows)

Sets number of rows per page

Parameters:

rows - number of rows

Returns:

this for chaining

updateItemsPerPage

protected void updateItemsPerPage()

NOTE CHANGE : Accounts for Assymetrical Structures

currentCellMerged

protected abstract boolean currentCellMerged(int currentRow,
                                             int currentCol)

The Grid here is not a regular Symmetrical Grid; hence overriding certain aspects of Grid. To know which Item is part of Merged space

currentCellEmpty

protected abstract boolean currentCellEmpty(int currentRow,
                                            int currentCol)

The Grid here is not a regular Symmetrical Grid; hence overriding certain aspects of Grid. To know which Item is part of Merged space and should not pick content from the specified IDataProvider.

currentItemInMergedCell

protected abstract boolean currentItemInMergedCell(int index)

Checks if the Item with the index is a part of a Merged space

Parameters:

index - as integer (base starts @ 0)

Returns:

boolean

addItems

protected void addItems(Iterator<org.apache.wicket.markup.repeater.Item<T>> items)

NOTE CHANGE : Accounts for Assymetrical Structures

Overrides:

addItems in class org.apache.wicket.markup.repeater.RefreshingView<T>

Parameters:

items - as < Item < T > >

customizeCell

protected void customizeCell(org.apache.wicket.markup.repeater.Item<T> cellItem,
                             int row,
                             int col)

getDataProvider

public org.apache.wicket.markup.repeater.data.IDataProvider<T> getDataProvider()

Returns:

data provider

getItems

public Iterator<org.apache.wicket.markup.repeater.Item<T>> getItems()

Overrides:

getItems in class org.apache.wicket.markup.repeater.RefreshingView<T>

See Also:

RefreshingView.getItems()

populateEmptyItem

protected abstract void populateEmptyItem(org.apache.wicket.markup.repeater.Item<T> item,
                                          int row,
                                          int col)

Add component to an Item for which there is no model anymore and is shown in a cell.
Called for Merged Cells & Trailing cells that do not have data associated with them

Parameters:

item - Item object

newEmptyItem

protected org.apache.wicket.markup.repeater.Item<T> newEmptyItem(String id,
                                                                 int index)

Create a Item which represents an empty cell (there is no model for it in the DataProvider) Can be null if we do not want the empty cell added to the Grid at all. (ignore them altogether)

Parameters:

id -

index -

Returns:

created item

newRowItem

protected org.apache.wicket.markup.repeater.Item<?> newRowItem(String id,
                                                               int index)

Create a new Item which will hold a row.

Parameters:

id -

index -

Returns:

created Item