This is an automated email from the ASF dual-hosted git repository. dashorst pushed a commit to branch archive/wicket-1.1.x in repository https://gitbox.apache.org/repos/asf/wicket.git
commit 7420387dd8a91b6c04cf1576cbe6151886f9bb02 Author: Igor Vaynberg <[email protected]> AuthorDate: Thu Nov 17 03:07:35 2005 +0000 introduced AbstractDataTable to make user customization easy. a few todos complete. git-svn-id: https://svn.apache.org/repos/asf/incubator/wicket/branches/WICKET_1_1@458058 13f79535-47bb-0310-9956-ffa450edef68 --- .../{DataTable.java => AbstractDataTable.java} | 92 +++++++++--- .../markup/html/repeater/data/table/DataTable.java | 161 +++++++++------------ .../markup/html/repeater/data/table/IColumn.java | 31 ++-- 3 files changed, 158 insertions(+), 126 deletions(-) diff --git a/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/DataTable.java b/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/AbstractDataTable.java similarity index 55% copy from wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/DataTable.java copy to wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/AbstractDataTable.java index 7c5916e92d..2bea5ea38c 100644 --- a/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/DataTable.java +++ b/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/AbstractDataTable.java @@ -22,6 +22,7 @@ import java.util.List; import wicket.AttributeModifier; import wicket.Component; +import wicket.WicketRuntimeException; import wicket.extensions.markup.html.repeater.data.DataView; import wicket.extensions.markup.html.repeater.data.sort.ISortableDataProvider; import wicket.extensions.markup.html.repeater.data.sort.OrderByBorder; @@ -30,21 +31,54 @@ import wicket.markup.html.WebMarkupContainer; import wicket.markup.html.basic.Label; import wicket.markup.html.list.ListItem; import wicket.markup.html.list.ListView; -import wicket.markup.html.navigation.paging.PagingNavigator; import wicket.markup.html.panel.Panel; +import wicket.model.AbstractReadOnlyModel; import wicket.model.IModel; import wicket.model.Model; /** + * Base class for components that wish to display a table of data by specifying + * a list of columns pragmatically rather then through html. * - * @author Igor Vaynberg ( ivaynberg ) + * Provides useful features such as sortable header and even/odd css row classes + * + * Example of minimum markup needed by subclasses: + * + * + * <pre> + * <thead> + * <tr> + * <span wicket:id="headers"> + * <th wicket:id="header"> + * <span wicket:id="label">[header-label]</span> + * </th> + * </span> + * </tr> + * </thead> + * <tbody> + * <tr wicket:id="rows"> + * <td wicket:id="cells"> + * <span wicket:id="cell">[cell]</span> + * </td> + * </tr> + * </tbody> + * </pre> + * + * + * @author Igor Vaynberg (ivaynberg) * */ -public class DataTable extends Panel +public class AbstractDataTable extends Panel { private static final long serialVersionUID = 1L; + private static final String CELL_ITEM_ID = "cell"; + + private final DataView dataView; + /** + * Constructor + * * @param id * component id * @param columns @@ -54,12 +88,29 @@ public class DataTable extends Panel * @param rowsPerPage * number of rows per page */ - public DataTable(String id, final List columns, ISortableDataProvider dataProvider, + public AbstractDataTable(String id, final List columns, ISortableDataProvider dataProvider, int rowsPerPage) + { + this(id, columns, new Model(dataProvider), rowsPerPage); + } + + /** + * Constructor + * + * @param id + * component id + * @param columns + * list of IColumn objects + * @param dataProvider + * imodel for data provider + * @param rowsPerPage + * number of rows per page + */ + public AbstractDataTable(String id, final List columns, IModel dataProvider, int rowsPerPage) { super(id); - final DataView dataView = new DataView("rows", dataProvider) + dataView = new DataView("rows", dataProvider) { private static final long serialVersionUID = 1L; @@ -67,8 +118,7 @@ public class DataTable extends Panel { final IModel rowModel = item.getModel(); - // TODO change model to abstractreadonlymodel if patch applied - item.add(new AttributeModifier("class", true, new Model() + item.add(new AttributeModifier("class", true, new AbstractReadOnlyModel() { private static final long serialVersionUID = 1L; @@ -86,8 +136,16 @@ public class DataTable extends Panel protected void populateItem(ListItem item) { final IColumn column = (IColumn)item.getModelObject(); - column.populateItem(item, "cell", rowModel); - item.get("cell").setRenderBodyOnly(true); + column.populateItem(item, CELL_ITEM_ID, rowModel); + + if (item.get("cell") == null) + { + throw new WicketRuntimeException(column.getClass().getName() + + ".populateItem() failed to add a component with id [" + + CELL_ITEM_ID + "] to the provided [cellItem] argument"); + } + + item.get(CELL_ITEM_ID).setRenderBodyOnly(true); } }); @@ -123,18 +181,10 @@ public class DataTable extends Panel }); - add(new PagingNavigator("navigator", dataView) - { - private static final long serialVersionUID = 1L; - - public boolean isVisible() - { - return dataView.getItemCount() > 0; - } - }); - - add(new NavigatorLabel("navigatorLabel", dataView)); } - + protected final DataView getDataView() + { + return dataView; + } } diff --git a/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/DataTable.java b/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/DataTable.java index 7c5916e92d..ed3d9b682d 100644 --- a/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/DataTable.java +++ b/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/DataTable.java @@ -1,50 +1,46 @@ /* - * $Id$ - * $Revision$ + * $Id$ $Revision$ * $Date$ - * - * ==================================================================== - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * + * + * ==================================================================== Licensed + * under the Apache License, Version 2.0 (the "License"); you may not use this + * file except in compliance with the License. You may obtain a copy of the + * License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations under + * the License. */ package wicket.extensions.markup.html.repeater.data.table; import java.util.List; -import wicket.AttributeModifier; -import wicket.Component; import wicket.extensions.markup.html.repeater.data.DataView; import wicket.extensions.markup.html.repeater.data.sort.ISortableDataProvider; -import wicket.extensions.markup.html.repeater.data.sort.OrderByBorder; -import wicket.extensions.markup.html.repeater.pageable.Item; -import wicket.markup.html.WebMarkupContainer; -import wicket.markup.html.basic.Label; -import wicket.markup.html.list.ListItem; -import wicket.markup.html.list.ListView; +import wicket.markup.html.WebComponent; import wicket.markup.html.navigation.paging.PagingNavigator; -import wicket.markup.html.panel.Panel; import wicket.model.IModel; import wicket.model.Model; /** + * Provides a default implementation of AbstractDataTable with a paging + * navigator and a paging navigator label * - * @author Igor Vaynberg ( ivaynberg ) + * @see AbstractDataTable * + * @author Igor Vaynberg ( ivaynberg ) */ -public class DataTable extends Panel +public class DataTable extends AbstractDataTable { private static final long serialVersionUID = 1L; /** + * Constructor + * * @param id * component id * @param columns @@ -57,73 +53,44 @@ public class DataTable extends Panel public DataTable(String id, final List columns, ISortableDataProvider dataProvider, int rowsPerPage) { - super(id); - - final DataView dataView = new DataView("rows", dataProvider) - { - private static final long serialVersionUID = 1L; - - protected void populateItem(final Item item) - { - final IModel rowModel = item.getModel(); - - // TODO change model to abstractreadonlymodel if patch applied - item.add(new AttributeModifier("class", true, new Model() - { - private static final long serialVersionUID = 1L; - - public Object getObject(Component component) - { - return (item.getIndex() % 2 == 0) ? "odd" : "even"; - } - - })); - - item.add(new ListView("cells", columns) - { - private static final long serialVersionUID = 1L; - - protected void populateItem(ListItem item) - { - final IColumn column = (IColumn)item.getModelObject(); - column.populateItem(item, "cell", rowModel); - item.get("cell").setRenderBodyOnly(true); - } - - }); - - } - - }; - - dataView.setItemsPerPage(rowsPerPage); - - add(dataView); + this(id, columns, new Model(dataProvider), rowsPerPage); + } + /** + * Constructor + * + * @param id + * component id + * @param columns + * list of IColumn objects + * @param dataProvider + * imodel for data provider + * @param rowsPerPage + * number of rows per page + */ + public DataTable(String id, final List columns, IModel dataProvider, int rowsPerPage) + { + super(id, columns, dataProvider, rowsPerPage); - add(new ListView("headers", columns) - { - private static final long serialVersionUID = 1L; + add(newPagingNavigator("navigator", getDataView())); - protected void populateItem(ListItem item) - { - final IColumn column = (IColumn)item.getModelObject(); - WebMarkupContainer header = null; - if (column.isSortable()) - { - header = new OrderByBorder("header", column.getSortProperty(), dataView); - } - else - { - header = new WebMarkupContainer("header"); - } - item.add(header); - header.add(new Label("label", column.getDisplayModel())); - } + add(newNavigatorLabel("navigatorLabel", getDataView())); + } - }); - add(new PagingNavigator("navigator", dataView) + /** + * Factory method used to create the paging navigator that will be used by + * the datatable + * + * @param navigatorId + * component id the navigator should be created with + * @param dataView + * dataview used by datatable + * @return paging navigator that will be used by the datatable + */ + protected PagingNavigator newPagingNavigator(String navigatorId, final DataView dataView) + { + return new PagingNavigator(navigatorId, dataView) { private static final long serialVersionUID = 1L; @@ -131,10 +98,22 @@ public class DataTable extends Panel { return dataView.getItemCount() > 0; } - }); - - add(new NavigatorLabel("navigatorLabel", dataView)); + }; } - + /** + * Factory method used to create the navigator label that will be used by + * the datatable + * + * @param navigatorId + * component id navigator label should be created with + * @param dataView + * dataview used by datatable + * @return navigator label that will be used by the datatable + * + */ + protected WebComponent newNavigatorLabel(String navigatorId, final DataView dataView) + { + return new NavigatorLabel(navigatorId, dataView); + } } diff --git a/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/IColumn.java b/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/IColumn.java index 0da3f6baf2..5a83d84805 100644 --- a/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/IColumn.java +++ b/wicket-extensions/src/java/wicket/extensions/markup/html/repeater/data/table/IColumn.java @@ -1,20 +1,19 @@ /* - * $Id$ - * $Revision$ + * $Id$ $Revision$ * $Date$ - * - * ==================================================================== - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * + * + * ==================================================================== Licensed + * under the Apache License, Version 2.0 (the "License"); you may not use this + * file except in compliance with the License. You may obtain a copy of the + * License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations under + * the License. */ package wicket.extensions.markup.html.repeater.data.table; @@ -40,6 +39,10 @@ public interface IColumn extends Serializable /** * Method used to populate a cell in the generated table. * + * <b>Implementation MUST add a component to the cellItem argument using the + * component id provided by componentId argument, otherwise a + * WicketRuntimeException will be thrown</b> + * * @param cellItem * the list item representing the current table cell being * rendered
