Class ComponentRenderSettings

• Object
  • dw.experience.ComponentRenderSettings

A config that drives how the component is rendered. One can basically decide which kind of tag is used as wrapper element (e.g. <div>...</div>) and which attributes are to be placed into this wrapper element (e.g. class="foo bar"). In case no attributes are provided then the system default settings will apply. In case no tag name is provided then the system default one will apply.

• tag_name : div
• attributes : {"class":"experience-component experience-[COMPONENT_TYPE_ID]"}

As the [COMPONENT_TYPE_ID] can contain dots due to its package like naming scheme (e.g. assets.image) any occurrences of these dots will be replaced by dashes (e.g. assets-image) so that CSS selectors do not have to be escaped.

See Also:

RegionRenderSettings

Properties

attributes : Object

The configured attributes of the wrapper element as set by setAttributes(Object).

tagName : String

The tag name of the component wrapper element. Defaults to 'div'.

Constructor Summary

ComponentRenderSettings()

Creates region render settings which can then be configured further.

Method Summary

getAttributes() : Object

Returns the configured attributes of the wrapper element as set by setAttributes(Object).

getTagName() : String

Returns the tag name of the component wrapper element.

setAttributes(attributes : Object) : ComponentRenderSettings

Sets the to be configured <String,String> attributes of the wrapper element.

setTagName(tagName : String) : ComponentRenderSettings

Sets the tag name of the component wrapper element.

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constructor Detail

ComponentRenderSettings

publicComponentRenderSettings()

Creates region render settings which can then be configured further. They are to be used for detailed configuration of a RegionRenderSettings which is subsequently used for PageMgr.renderRegion(Region, RegionRenderSettings) calls.

See Also:

RegionRenderSettings

Method Detail

getAttributes

getAttributes() : Object

Returns the configured attributes of the wrapper element as set by setAttributes(Object).

Returns:

the configured attributes of the wrapper element

getTagName

getTagName() : String

Returns the tag name of the component wrapper element. Defaults to 'div'.

Returns:

the tag name of the component wrapper element

setAttributes

setAttributes(attributes : Object) : ComponentRenderSettings

Sets the to be configured <String,String> attributes of the wrapper element. Set it to null in case you want to system defaults to be applied.

Parameters:

attributes - the to be configured attributes of the wrapper element

Returns:

this

setTagName

setTagName(tagName : String) : ComponentRenderSettings

Sets the tag name of the component wrapper element. Must not be empty.

Parameters:

tagName - the tag name of the component wrapper element

Returns:

this