org.opencms.xml.content

Class CmsXmlContentTab

java.lang.Object

org.opencms.xml.content.CmsXmlContentTab

public class CmsXmlContentTab
extends java.lang.Object

Represents a configured tab to be used in the XML content editor for better usability.

Constructor Summary

Constructors

Constructor and Description
CmsXmlContentTab(java.lang.String startName) Constructor with the start element name.
CmsXmlContentTab(java.lang.String startName, boolean collapsed, java.lang.String tabName, java.lang.String description) Constructor with all possible tab parameter settings.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription() Gets the tab description HTML.
java.lang.String	getIdName() Returns the name for the tab ID, generated from the start name.
java.lang.String	getStartName() Returns the XML element name where this tab starts.
java.lang.String	getTabName() Returns the name to display on the tab.
int	hashCode()
boolean	isCollapsed() Indicates if the first level of left labels should be shown in the editor.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CmsXmlContentTab

public CmsXmlContentTab(java.lang.String startName)

Constructor with the start element name.

The tab name is equal to the element name and the first level should not be shown in the editor.

Parameters:

startName - the XML element name where this tab starts

CmsXmlContentTab

public CmsXmlContentTab(java.lang.String startName,
                        boolean collapsed,
                        java.lang.String tabName,
                        java.lang.String description)

Constructor with all possible tab parameter settings.

Parameters:

startName - XML element name where this tab starts

collapsed - indicates if the first level of left labels should be shown in the editor

tabName - the name to display on the tab

description - the tab description HTML

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getDescription

public java.lang.String getDescription()

Gets the tab description HTML.

Returns:

the tab description HTML

getIdName

public java.lang.String getIdName()

Returns the name for the tab ID, generated from the start name.

Returns:

the name for the tab ID, generated from the start name

getStartName

public java.lang.String getStartName()

Returns the XML element name where this tab starts.

Returns:

the XML element name where this tab starts

getTabName

public java.lang.String getTabName()

Returns the name to display on the tab.

Returns:

the name to display on the tab

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

isCollapsed

public boolean isCollapsed()

Indicates if the first level of left labels should be shown in the editor.

Returns:

true if the first level of left labels should NOT be shown in the editor