Package org.opencms.jsp.util

Class CmsSchemaInfo.Tab

java.lang.Object

org.opencms.jsp.util.CmsSchemaInfo.Tab

All Implemented Interfaces:

I_CmsInfoWrapper

Enclosing class:

CmsSchemaInfo

public class CmsSchemaInfo.Tab
extends Object
implements I_CmsInfoWrapper

Represents the a single editor tab and its fields.

Constructor Summary

Constructors

Constructor	Description
Tab()	Default constructor - doesn't initialize anything.
Tab(Locale defaultLocale, int tabIndex, Function<Locale,List<CmsTabInfo>> tabInfoProvider)	Constructor for tab that is actually configured in the schema.

Method Summary

Modifier and Type	Method	Description
void	add(CmsSchemaInfo.Field field)	Adds a field.
String	getDescription()	Gets the description.
String	getDescription(Locale locale)	Gets the localized description.
String	getDescriptionKey()	Gets the description key.
String	getDescriptionRaw()	Gets the raw description string.
String	getDisplayName()	Gets the display name.
String	getDisplayNameKey()	Gets the display name key.
String	getDisplayNameRaw()	Gets the raw display name string.
List<CmsSchemaInfo.Field>	getFields()	Gets the fields.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.jsp.util.I_CmsInfoWrapper

getDescription

Constructor Details

Tab

public Tab()

Default constructor - doesn't initialize anything.

Used for 'dummy' tab that is generated when no actual tabs are configured.

Tab

public Tab(Locale defaultLocale,
 int tabIndex,
 Function<Locale,List<CmsTabInfo>> tabInfoProvider)

Constructor for tab that is actually configured in the schema.

Parameters:

defaultLocale - the default locale

tabIndex - the current tab index

tabInfoProvider - the function that provides the list of localized tab info objects

Method Details

add

public void add(CmsSchemaInfo.Field field)

Adds a field.

Parameters:

field - the field to add

getDescription

public String getDescription()

Gets the description.

Specified by:

getDescription in interface I_CmsInfoWrapper

Returns:

the description

getDescription

public String getDescription(Locale locale)

Gets the localized description.

Specified by:

getDescription in interface I_CmsInfoWrapper

Parameters:

locale - the locale

Returns:

the description for the locale

getDescriptionKey

public String getDescriptionKey()

Gets the description key.

Specified by:

getDescriptionKey in interface I_CmsInfoWrapper

Returns:

the description key

getDescriptionRaw

public String getDescriptionRaw()

Gets the raw description string.

Specified by:

getDescriptionRaw in interface I_CmsInfoWrapper

Returns:

the raw description

getDisplayName

public String getDisplayName()

Gets the display name.

Returns:

the display name

getDisplayNameKey

public String getDisplayNameKey()

Gets the display name key.

Returns:

the display name key

getDisplayNameRaw

public String getDisplayNameRaw()

Gets the raw display name string.

Returns:

the raw display name string

getFields

public List<CmsSchemaInfo.Field> getFields()

Gets the fields.

Returns:

the fields