com.thruzero.common.web.model.container.AbstractPanel.java Source code

Introduction

Here is the source code for com.thruzero.common.web.model.container.AbstractPanel.java

Source

/*
 *   Copyright 2012 George Norman
 *
 *   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 com.thruzero.common.web.model.container;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang3.StringUtils;

import com.thruzero.common.core.infonode.InfoNodeElement;
import com.thruzero.common.core.support.SimpleIdGenerator;
import com.thruzero.common.web.model.css.StyleClass;

/**
 * Abstract base class for a UI panel.
 *
 * @author George Norman
 */
public abstract class AbstractPanel {
    private final String id;
    private final String title;
    private final String titleLink;
    private final String collapseDirection;
    private final boolean useWhiteChevron;
    private final StyleClass headerStyleClass;
    private final List<InfoNodeElement> toolbar = new ArrayList<InfoNodeElement>();

    public AbstractPanel(String id, String title, String titleLink, String collapseDirection,
            boolean useWhiteChevron, StyleClass headerStyleClass, List<InfoNodeElement> toolbar) {
        this.id = StringUtils.isEmpty(id) ? SimpleIdGenerator.getInstance().getNextIdAsString() : id;
        this.title = title;
        this.titleLink = titleLink;
        this.collapseDirection = collapseDirection;
        this.useWhiteChevron = useWhiteChevron;
        this.headerStyleClass = headerStyleClass;

        if (toolbar != null) {
            this.toolbar.addAll(toolbar);
        }
    }

    /**
     * Returns the ID of this panel.
     */
    public String getId() {
        return id;
    }

    /**
     * Returns the text used to render the panel's title in the header.
     */
    public String getTitle() {
        return title;
    }

    /**
     * Returns optional href used to render the panel's title link in the header.
     */
    public String getTitleLink() {
        return titleLink;
    }

    /**
     * Returns the collapse direction for a collapsible panel (in or out).
     */
    public String getCollapseDirection() {
        return collapseDirection;
    }

    /**
     * Returns true if the expand/collapse toggle icon should be white.
     */
    public boolean isUseWhiteChevron() {
        return useWhiteChevron;
    }

    /**
     * Returns the optional style class used to render the panel's header.
     */
    public String getHeaderStyleClass() {
        return headerStyleClass == null ? "" : headerStyleClass.toString();
    }

    /**
     * Returns the type of panel this instance represents (the type is the simple class name of this instance and is used to determine its renderer).
     */
    public String getPanelType() {
        return getClass().getSimpleName();
    }

    /** Returns the List of optional buttons to render as a toolbar in the panel titleBar. */
    public List<InfoNodeElement> getToolbar() {
        return toolbar;
    }

}