net.dontdrinkandroot.wicket.component.basic.AbstractList.java Source code

Introduction

Here is the source code for net.dontdrinkandroot.wicket.component.basic.AbstractList.java

Source

/**
 * Copyright (C) 2012-2014 Philip W. Sorst <philip@sorst.net>
 * and individual contributors as indicated
 * by the @authors tag.
 *
 * 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.
 */
package net.dontdrinkandroot.wicket.component.basic;

import java.util.List;

import net.dontdrinkandroot.wicket.model.ListItemModel;

import org.apache.wicket.Component;
import org.apache.wicket.markup.ComponentTag;
import org.apache.wicket.markup.html.panel.GenericPanel;
import org.apache.wicket.markup.repeater.RepeatingView;
import org.apache.wicket.model.IModel;
import org.apache.wicket.util.string.Strings;

public abstract class AbstractList<T> extends GenericPanel<List<T>> {

    private RepeatingView itemView;

    public AbstractList(String id, IModel<List<T>> model) {

        super(id, model);
    }

    @Override
    protected void onInitialize() {

        super.onInitialize();

        this.itemView = new RepeatingView("item") {

            @Override
            protected void onPopulate() {

                this.removeAll();

                IModel<List<T>> model = AbstractList.this.getModel();

                if (model != null && model.getObject() != null) {
                    for (int idx = 0; idx < model.getObject().size(); idx++) {
                        IModel<T> itemModel = new ListItemModel<T>(model, idx);
                        Component listComponent = AbstractList.this.createListComponent(this.newChildId(),
                                itemModel);
                        AbstractList.this.processListComponent(listComponent);
                        this.add(listComponent);
                    }
                }
            }
        };
        this.add(this.itemView);
    }

    @Override
    protected void onComponentTag(ComponentTag tag) {

        super.onComponentTag(tag);
        this.checkComponentTag(tag, "ul", "li");
    }

    protected final void checkComponentTag(final ComponentTag tag, String... names) {

        for (String name : names) {
            if (tag.getName().equals(name)) {
                return;
            }
        }

        String joinedNames = Strings.join(",", names);
        String msg = String.format("Component [%s] (path = [%s]) must be applied to a tag of type [%s], not: %s",
                this.getId(), this.getPath(), joinedNames, tag.toUserDebugString());

        this.findMarkupStream().throwMarkupException(msg);
    }

    protected void processListComponent(Component listComponent) {

        /* Override to apply styles to list component */
    }

    protected abstract Component createListComponent(String id, IModel<T> model);

}