org.opencms.ade.containerpage.shared
Interface I_CmsContainer

public interface I_CmsContainer

Interface representing the container methods to be used by overlay type CmsContainerJso and other types.

Since:

8.0.0

Field Summary

static java.lang.String	JSONKEY_ELEMENTS Key 'elements' used within the JSON representation of a container object.
static java.lang.String	JSONKEY_MAXELEMENTS Key 'maxElements' used within the JSON representation of a container object.
static java.lang.String	JSONKEY_NAME Key 'name' used within the JSON representation of a container object.
static java.lang.String	JSONKEY_TYPE Key 'type' used within the JSON representation of a container object.

Method Summary

java.lang.String[]	getElements() Returns the elements client id's contained in this container.
int	getMaxElements() Returns the maximum number of elements allowed in this container.
java.lang.String	getName() Returns the container name, also used as HTML-id for the container DOM-element.
java.lang.String	getType() Returns the container type.
int	getWidth() Returns the width of the container.
boolean	isDetailView() Returns true if this container is used for the detail view.
void	setElements(java.lang.String[] elements) Sets the elements contained in this container.

Field Detail

JSONKEY_ELEMENTS

static final java.lang.String JSONKEY_ELEMENTS

Key 'elements' used within the JSON representation of a container object.

See Also:

Constant Field Values

JSONKEY_MAXELEMENTS

static final java.lang.String JSONKEY_MAXELEMENTS

Key 'maxElements' used within the JSON representation of a container object.

See Also:

Constant Field Values

JSONKEY_NAME

static final java.lang.String JSONKEY_NAME

Key 'name' used within the JSON representation of a container object.

See Also:

Constant Field Values

JSONKEY_TYPE

static final java.lang.String JSONKEY_TYPE

Key 'type' used within the JSON representation of a container object.

See Also:

Constant Field Values

Method Detail

getElements

java.lang.String[] getElements()

Returns the elements client id's contained in this container.

Returns:

the elements

getMaxElements

int getMaxElements()

Returns the maximum number of elements allowed in this container.

Returns:

the maximum number of elements

getName

java.lang.String getName()

Returns the container name, also used as HTML-id for the container DOM-element. Has to be unique within the template.

Returns:

the container name

getType

java.lang.String getType()

Returns the container type. Used to determine the formatter used to render the contained elements.

Returns:

the container type

getWidth

int getWidth()

Returns the width of the container.

Returns:

the width of the container

isDetailView

boolean isDetailView()

Returns true if this container is used for the detail view.

Returns:

true if this is a detail view container

setElements

void setElements(java.lang.String[] elements)

Sets the elements contained in this container.

Parameters:

elements - the elements