Package org.opencms.ade.containerpage.inherited

Class CmsContainerConfiguration

java.lang.Object

org.opencms.ade.containerpage.inherited.CmsContainerConfiguration

public class CmsContainerConfiguration
extends Object

A bean representing a single configuration entry for the inherited container configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	N_CONFIGURATION	Node name.
static final String	N_ELEMENT	Node name.
static final String	N_HIDDEN	Node name.
static final String	N_KEY	Node name.
static final String	N_NAME	Node name.
static final String	N_NEWELEMENT	Node name.
static final String	N_ORDERKEY	Node name.
static final String	N_URI	Node name.
static final String	N_VISIBLE	Node name.

Constructor Summary

Constructors

Constructor	Description
CmsContainerConfiguration(List<String> ordering, Map<String,Boolean> visibility, Map<String,CmsContainerElementBean> newElements)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
static CmsContainerConfiguration	emptyConfiguration()	Generates an empty configuration object.
Map<String,CmsContainerElementBean>	getNewElements()	Gets the map of new elements.
LinkedHashMap<String,CmsContainerElementBean>	getNewElementsInOrder()	Gets the new elements in the order in which they appear in the 'ordering' list.
List<String>	getOrdering()	Gets the ordering list.
String	getPath()	Gets the path from which this configuration was read.
Map<String,Boolean>	getVisibility()	Gets the visibility map for this configuration.
void	setPath(String path)	Sets the path for this configuration.

Methods inherited from class java.lang.Object

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

Field Details

N_CONFIGURATION

public static final String N_CONFIGURATION

Node name.

See Also:

• Constant Field Values

N_ELEMENT

public static final String N_ELEMENT

Node name.

See Also:

• Constant Field Values

N_HIDDEN

public static final String N_HIDDEN

Node name.

See Also:

• Constant Field Values

N_KEY

public static final String N_KEY

Node name.

See Also:

• Constant Field Values

N_NAME

public static final String N_NAME

Node name.

See Also:

• Constant Field Values

N_NEWELEMENT

public static final String N_NEWELEMENT

Node name.

See Also:

• Constant Field Values

N_ORDERKEY

public static final String N_ORDERKEY

Node name.

See Also:

• Constant Field Values

N_URI

public static final String N_URI

Node name.

See Also:

• Constant Field Values

N_VISIBLE

public static final String N_VISIBLE

Node name.

See Also:

• Constant Field Values

Constructor Details

CmsContainerConfiguration

public CmsContainerConfiguration(List<String> ordering,
 Map<String,Boolean> visibility,
 Map<String,CmsContainerElementBean> newElements)

Creates a new instance.

Parameters:

ordering - the new ordering list

visibility - the visibility map

newElements - the new elements

Method Details

emptyConfiguration

public static CmsContainerConfiguration emptyConfiguration()

Generates an empty configuration object.

Returns:

an empty configuration object

getNewElements

public Map<String,CmsContainerElementBean> getNewElements()

Gets the map of new elements.

Returns:

the map of new elements

getNewElementsInOrder

public LinkedHashMap<String,CmsContainerElementBean> getNewElementsInOrder()

Gets the new elements in the order in which they appear in the 'ordering' list.

Returns:

an ordered map containing the new elements in the correct order

getOrdering

public List<String> getOrdering()

Gets the ordering list.

Returns:

the ordering list

getPath

public String getPath()

Gets the path from which this configuration was read.

Returns:

the path from which this configuration was read

getVisibility

public Map<String,Boolean> getVisibility()

Gets the visibility map for this configuration.

Returns:

the visibility map

setPath

public void setPath(String path)

Sets the path for this configuration.

Parameters:

path - the new path value