org.opencms.acacia.shared.CmsTabInfo Maven / Gradle / Ivy

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (C) Alkacon Software (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.acacia.shared;

import com.google.gwt.user.client.rpc.IsSerializable;

/**
 * Form tab information bean.
 */
public class CmsTabInfo implements IsSerializable {

    /** Indicates if the first level of left labels should be shown in the editor. */
    private boolean m_collapsed;

    /** The XML element name where this tab starts. */
    private String m_startName;

    /** The name for the tab ID, generated from the start name. */
    private String m_tabId;

    /** The name to display on the tab. */
    private String m_tabName;

    /** The tab description HTML. */
    private String m_description;

    /**
     * Constructor.

     *
     * @param tabName the tab name
     * @param tabId the tab id
     * @param startName the start element name
     * @param collapsed if the labels should be collapsed
     * @param description the description HTML
     */
    public CmsTabInfo(String tabName, String tabId, String startName, boolean collapsed, String description) {

        m_tabName = tabName;
        m_tabId = tabId;
        m_startName = startName;
        m_collapsed = collapsed;
        m_description = description;
    }

    /**
     * Constructor for serialization only.

     */
    protected CmsTabInfo() {

        // nothing to do
    }

    /**
     * Gets the description HTML.

     *
     * @return the description HTML
     */
    public String getDescription() {

        return m_description;
    }

    /**
     * Returns the startName.

     *
     * @return the startName
     */
    public String getStartName() {

        return m_startName;
    }

    /**
     * Returns the tabId.

     *
     * @return the tabId
     */
    public String getTabId() {

        return m_tabId;
    }

    /**
     * Returns the tabName.

     *
     * @return the tabName
     */
    public String getTabName() {

        return m_tabName;
    }

    /**
     * Returns the collapsed.
     *
     * @return the collapsed
     */
    public boolean isCollapsed() {

        return m_collapsed;
    }
}