Attributes |
Name | Required | Request-time | Type | Description |
name | true | true | java.lang.String | A unique name for the container that is used to identify it in a container page. |
settings | false | true | java.lang.String | A map containing setting presets for elements in this container. If settings are passed in this map, they will not be user-editable on elements in the container. |
type | false | true | java.lang.String | A type assigned to the container, e.g. "content" or "top-wide" or "left". The type can be used to select the formatter that is used to render a content in the container. |
param | false | true | java.lang.String | An optional container parameter. This is useful for a dynamically generated nested container, to pass information to the formatter used inside that container. |
maxElements | false | true | java.lang.String | The maximal number of elements that can be placed in the container. Default: 100. |
width | false | true | java.lang.String | A virtual width of the container. The given width does not have to match the actual width of the container, but its good practice to choose the actual width in pixels. The value can be used to select the formatter for elements dropped into the container, or even to adjust a formatters behavior. Default: -1 |
tag | false | true | java.lang.String | This attribute defines the tag that the <cms:container> -tag is translated to. Values should have the the form: {tag-name} -
tag-name is a name of a valid HTML tag. Default: div |
tagClass | false | true | java.lang.String | A space separated list of CSS-class names that are inserted as value of the "class"-attribute in the tag to which the <cms:container> -tag is translated to. Default: Empty list |
detailview | false | true | java.lang.String | This attribute defines if on a detail page the detail content should be shown in the container. The following values are supported: - false (default)
- Detail contents are never shown in the container.
- true
- If a suitable formatter exists, the detail content is shown in the container.
|
detailonly | false | true | java.lang.String | This attribute defines if the container is visible only on detail pages and if so, if the shown elements are specific to the actual detail content. The following values are supported: - false (default)
- The container is shown on every page.
- true
- The container is visible only on detail pages.
|
editableby | false | true | java.lang.String | A comma separated list of OpenCms principals that are allowed to edit the container content. If empty it defaults to ROLE.ELEMENT_AUTHOR. |
nameprefix | false | true | java.lang.String | The container name prefix to use for nested container names. If empty the element instance id of the parent element will be used. |
cacheable | false | true | java.lang.String | Flag to indicate if the used formatters should be included in 'cacheable' mode (see the cms:include tag). If this parameter is false, the formatters will be never included in cacheable mode, otherwise they will only included in cacheable mode in the Online project. |