org.gwt.advanced.client.ui.widget.tab.TabPosition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of advanced-gwt Show documentation
The set of useful GWT components
There is a newer version: 2.0.9
/*
 * Copyright 2008-2012 Sergey Skladchikov
 *
 * 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 org.gwt.advanced.client.ui.widget.tab;

/**
 * This enumeration describes possible tabs band positions.
 *
 * @author Sergey Skladchikov
 * @since 1.4.6
 */
public class TabPosition {
    /** above the content */
    public static final TabPosition TOP = new TabPosition("top", new TopBandRenderer(), LayoutPosition.TOP);
    /** left side */
    public static final TabPosition LEFT = new TabPosition("left", new LeftBandRenderer(), LayoutPosition.LEFT);
    /** right side */
    public static final TabPosition RIGHT = new TabPosition("right", new RightBandRenderer(), LayoutPosition.RIGHT);
    /** bottom the content */
    public static final TabPosition BOTTOM = new TabPosition("bottom", new BottomBandRenderer(), LayoutPosition.BOTTOM);

    /** This enum contains layout positions of the tabs in the {@link org.gwt.advanced.client.ui.widget.AdvancedTabPanel} */
    public enum LayoutPosition {
        TOP, LEFT, RIGHT, BOTTOM
    }

    /** position name */
    private String name;
    /** tabs band renderer specific for this position */
    private TabBandRenderer renderer;
    /** dock layout constant that can be compared to the position */
    private LayoutPosition layoutPosition;

    /**
     * Creates an instance of this class and initializes internal fields.
     *
     * @param name           is a position name.
     * @param renderer       is a tabs band renderer to be used for this position.
     * @param layoutPosition is a dock layout position (to be used by the tabs panel).
     */
    public TabPosition(String name, TabBandRenderer renderer, LayoutPosition layoutPosition) {
        this.name = name;
        this.renderer = renderer;
        this.layoutPosition = layoutPosition;
    }

    /**
     * Gets a name of the position.
     *
     * @return a name.
     */
    public String getName() {
        return name;
    }

    /**
     * Gets a specific renderer to be applied for this position.
     *
     * @return a tabs band renderer.
     */
    public TabBandRenderer getRenderer() {
        return renderer;
    }

    /**
     * Gets a dock layout constant that is related to the position.
     *
     * @return a dock layout constant.
     */
    public LayoutPosition getLayoutPosition() {
        return layoutPosition;
    }

    /**
     * Always gets a name.
     *
     * @return a name.
     */
    public String toString() {
        return String.valueOf(getName());
    }
}