table.headercolumndatatable.TwinHeadersToolbar.java Source code

Introduction

Here is the source code for table.headercolumndatatable.TwinHeadersToolbar.java

Source

package table.headercolumndatatable;

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

import org.apache.wicket.extensions.markup.html.repeater.data.sort.ISortStateLocator;
import org.apache.wicket.extensions.markup.html.repeater.data.sort.OrderByBorder;
import org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable;
import org.apache.wicket.extensions.markup.html.repeater.data.table.DefaultDataTable;
import org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn;
import org.apache.wicket.extensions.markup.html.repeater.data.table.IStyledColumn;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.panel.Panel;
import org.apache.wicket.markup.repeater.RepeatingView;
import table.headercolumndatatable.extra.CssAttributeBehavior;

/**
 * Toolbars that displays column headers. If the column is sortable a sortable header will be
 * displayed.
 *
 * @author Igor Vaynberg (ivaynberg)
 * @see DefaultDataTable
 */
public class TwinHeadersToolbar extends Panel {

    public static final String LABEL_ID = "label";
    public static final String LABEL_2 = "label2";
    private static final long serialVersionUID = 1L;
    private final HeaderColumnDataTable<?> table;

    /**
     * Constructor
     *
     * @param table        data table this toolbar will be attached to
     * @param stateLocator locator for the ISortState implementation used by sortable headers
     */
    public TwinHeadersToolbar(final HeaderColumnDataTable<?> table, final ISortStateLocator stateLocator) {
        super(DataTable.TOOLBAR_COMPONENT_ID);
        this.table = table;

        RepeatingView headers = new RepeatingView("headers");
        add(headers);
        RepeatingView headers2 = new RepeatingView("headers2");
        add(headers2);

        populateHeaders(stateLocator, headers, "header", LABEL_ID, table.getColumns());
        populateHeaders(stateLocator, headers2, "header2", LABEL_2, table.getColumns());
    }

    private void populateHeaders(ISortStateLocator stateLocator, RepeatingView headers, String headerId,
            String labelId, IColumn<?>[] tableColumns) {
        for (final IColumn column : tableColumns) {
            WebMarkupContainer item = new WebMarkupContainer(headers.newChildId());
            headers.add(item);

            WebMarkupContainer header;
            if (column.isSortable()) {
                header = newSortableHeader(headerId, column.getSortProperty(), stateLocator);
            } else {
                header = new WebMarkupContainer(headerId);
            }

            if (column instanceof IStyledColumn) {
                header.add(new CssAttributeBehavior() {
                    private static final long serialVersionUID = 1L;

                    @Override
                    protected String getCssClass() {
                        return ((IStyledColumn<?>) column).getCssClass();
                    }
                });
            }

            item.add(header);
            item.setRenderBodyOnly(true);
            header.add(column.getHeader(labelId));
        }
    }

    protected HeaderColumnDataTable<?> getTable() {
        return table;
    }

    /**
     * Factory method for sortable header components. A sortable header component must have id of
     * <code>headerId</code> and conform to markup specified in <code>TwinHeadersToolbar.html</code>
     *
     * @param headerId header component id
     * @param property property this header represents
     * @param locator  sort state locator
     * @return created header component
     */
    protected WebMarkupContainer newSortableHeader(String headerId, String property, ISortStateLocator locator) {
        return new OrderByBorder(headerId, property, locator) {
            private static final long serialVersionUID = 1L;

            @Override
            protected void onSortChanged() {
                getTable().setCurrentPage(0);
            }
        };
    }

}