CheckBoxColumn (Wicket Phonebook Example 1.5-rc2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

wicket.contrib.phonebook.web
Class CheckBoxColumn<T>

java.lang.Object
  org.apache.wicket.extensions.markup.html.repeater.data.table.AbstractColumn<T>
      org.apache.wicket.extensions.markup.html.repeater.data.table.HeaderlessColumn<T>
          wicket.contrib.phonebook.web.CheckBoxColumn<T>

All Implemented Interfaces:: Serializable, ICellPopulator<T>, IColumn<T>, IStyledColumn<T>, IClusterable, IDetachable

public abstract class CheckBoxColumn<T>
extends HeaderlessColumn<T>
extends HeaderlessColumn<T>

Checkbox column for DataTable

Author:: ivaynberg
See Also:: CheckBoxModel, Serialized Form

Constructor Summary
`CheckBoxColumn(IModel<Collection<Serializable>> selectionModel)` Constructor

Method Summary
`protected abstract Serializable`	`getModelObjectToken(IModel<T> model)` Generates a token from the model object that will represent the selected state of this row.
`void`	`populateItem(Item<ICellPopulator<T>> cellItem, String componentId, IModel<T> rowModel)`

Methods inherited from class org.apache.wicket.extensions.markup.html.repeater.data.table.HeaderlessColumn
`getHeader`

Methods inherited from class org.apache.wicket.extensions.markup.html.repeater.data.table.AbstractColumn
`detach, getCssClass, getDisplayModel, getSortProperty, isSortable`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

CheckBoxColumn

public CheckBoxColumn(IModel<Collection<Serializable>> selectionModel)

Constructor

Parameters:: selectionModel - model that represents a collection of selected tokens generated by getModelObjectToken(IModel). Usually this collection is a Set of primary keys.

Method Detail

populateItem

public void populateItem(Item<ICellPopulator<T>> cellItem,
                         String componentId,
                         IModel<T> rowModel)

getModelObjectToken

protected abstract Serializable getModelObjectToken(IModel<T> model)

Generates a token from the model object that will represent the selected state of this row. The implementation should usually return a primary key of the object inside the provided model. Example: return ((User)model.getObject()).getId();

Parameters:: model - model that contains an object bound to current row of the table
Returns:: a token which will uniquely identify the selection of this row