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 /** 053 * Constructor.<p> 054 * 055 * @param tabName the tab name 056 * @param tabId the tab id 057 * @param startName the start element name 058 * @param collapsed if the labels should be collapsed 059 * @param description the description HTML 060 */ 061 public CmsTabInfo(String tabName, String tabId, String startName, boolean collapsed, String description) { 062 063 m_tabName = tabName; 064 m_tabId = tabId; 065 m_startName = startName; 066 m_collapsed = collapsed; 067 m_description = description; 068 } 069 070 /** 071 * Constructor for serialization only.<p> 072 */ 073 protected CmsTabInfo() { 074 075 // nothing to do 076 } 077 078 /** 079 * Gets the description HTML.<p> 080 * 081 * @return the description HTML 082 */ 083 public String getDescription() { 084 085 return m_description; 086 } 087 088 /** 089 * Returns the startName.<p> 090 * 091 * @return the startName 092 */ 093 public String getStartName() { 094 095 return m_startName; 096 } 097 098 /** 099 * Returns the tabId.<p> 100 * 101 * @return the tabId 102 */ 103 public String getTabId() { 104 105 return m_tabId; 106 } 107 108 /** 109 * Returns the tabName.<p> 110 * 111 * @return the tabName 112 */ 113 public String getTabName() { 114 115 return m_tabName; 116 } 117 118 /** 119 * Returns the collapsed.<p> 120 * 121 * @return the collapsed 122 */ 123 public boolean isCollapsed() { 124 125 return m_collapsed; 126 } 127}