001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (C) Alkacon Software (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.acacia.shared;
029
030import com.google.gwt.user.client.rpc.IsSerializable;
031
032/**
033 * Form tab information bean.<p>
034 */
035public class CmsTabInfo implements IsSerializable {
036
037    /** Indicates if the first level of left labels should be shown in the editor. */
038    private boolean m_collapsed;
039
040    /** The XML element name where this tab starts. */
041    private String m_startName;
042
043    /** The name for the tab ID, generated from the start name. */
044    private String m_tabId;
045
046    /** The name to display on the tab. */
047    private String m_tabName;
048
049    /** The tab description HTML. */
050    private String m_description;
051
052    /** The tab localization key. */
053    private String m_tabKey;
054
055    /** Localization key for the description. */
056    private String m_descriptionKey;
057
058    /**
059     * Constructor.<p>
060     *
061     * @param tabName the tab name
062     * @param tabKey the tab localization key
063     * @param tabId the tab id
064     * @param startName the start element name
065     * @param collapsed if the labels should be collapsed
066     * @param description the description HTML
067     * @param descriptionKey the description key
068     */
069    public CmsTabInfo(String tabName, String tabKey,  String tabId, String startName, boolean collapsed, String description, String descriptionKey) {
070
071        m_tabName = tabName;
072        m_tabKey  = tabKey;
073        m_tabId = tabId;
074        m_startName = startName;
075        m_collapsed = collapsed;
076        m_description = description;
077        m_descriptionKey = descriptionKey;
078    }
079
080    /**
081     * Constructor for serialization only.<p>
082     */
083    protected CmsTabInfo() {
084
085        // nothing to do
086    }
087
088    /**
089     * Gets the description HTML.<p>
090     *
091     * @return the description HTML
092     */
093    public String getDescription() {
094
095        return m_description;
096    }
097
098    /**
099     * Gets the localization key for the description.
100     *
101     * @return the localization key for the description
102     */
103    public String getDescriptionKey() {
104        return m_descriptionKey;
105    }
106
107    /**
108     * Returns the startName.<p>
109     *
110     * @return the startName
111     */
112    public String getStartName() {
113
114        return m_startName;
115    }
116
117    /**
118     * Returns the tabId.<p>
119     *
120     * @return the tabId
121     */
122    public String getTabId() {
123
124        return m_tabId;
125    }
126
127    /**
128     * Returns the tabName.<p>
129     *
130     * @return the tabName
131     */
132    public String getTabName() {
133
134        return m_tabName;
135    }
136    /**
137     * Gets the localization key for the tab name.
138     *
139     * @return the tab name localization key
140     */
141    public String getTabNameKey() {
142        return m_tabKey;
143    }
144
145    /**
146     * Returns the collapsed.<p>
147     *
148     * @return the collapsed
149     */
150    public boolean isCollapsed() {
151
152        return m_collapsed;
153    }
154}