Class RegionRenderSettings
dw.experience
Class RegionRenderSettings
Object
dw.experience.RegionRenderSettings
A config that drives how the region 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").

If no attributes are provided for the region render settings then the system default ones will apply. Also if no tag name is provided then the system default one will apply.

  • tag_name : div
  • attributes : {"class":"experience-region experience-[REGION_ID]"}
Furthermore the render settings for components in this region can be specified - in case nothing is set per component then the default component render setting will be applied during rendering. If also no default component render setting is provided then the system default one will apply (see ComponentRenderSettings).

See Also:
PageMgr.renderRegion(Region)
PageMgr.renderRegion(Region, RegionRenderSettings)
Properties
attributes  :  Object
The configured attributes of the wrapper element as set by setAttributes(Object).
defaultComponentRenderSettings  :  ComponentRenderSettings
The default component render settings. These will be used during rendering of the components contained in the region in case no dedicated component render settings were provided per component. If also no default is supplied then the system default will be used during rendering.
tagName  :  String
The tag name of the region wrapper element. Defaults to 'div'.
Constructor Summary
RegionRenderSettings()
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).
getComponentRenderSettings(component : Component) : ComponentRenderSettings
Returns the component render settings for the given component.
getDefaultComponentRenderSettings() : ComponentRenderSettings
Returns the default component render settings.
getTagName() : String
Returns the tag name of the region wrapper element.
setAttributes(attributes : Object) : RegionRenderSettings
Sets the to be configured <String,String> attributes of the wrapper element.
setComponentRenderSettings(component : Component, componentRenderSettings : ComponentRenderSettings) : RegionRenderSettings
Sets the component render settings for the given component.
setDefaultComponentRenderSettings(defaultComponentRenderSettings : ComponentRenderSettings) : RegionRenderSettings
Sets the default component render settings.
setTagName(tagName : String) : RegionRenderSettings
Sets the tag name of the region 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
RegionRenderSettings
public RegionRenderSettings()
Creates region render settings which can then be configured further. They are to be used for PageMgr.renderRegion(Region, RegionRenderSettings) calls.
See Also:
ComponentRenderSettings
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
getComponentRenderSettings
getComponentRenderSettings(component : Component) : ComponentRenderSettings
Returns the component render settings for the given component. In case no explicitly specified settings are found for this component then the default one will be provided.
Parameters:
component - the component to retrieve the render settings for
Returns:
the component render settings or default component render settings if none were found for the given component
getDefaultComponentRenderSettings
getDefaultComponentRenderSettings() : ComponentRenderSettings
Returns the default component render settings. These will be used during rendering of the components contained in the region in case no dedicated component render settings were provided per component. If also no default is supplied then the system default will be used during rendering.
Returns:
the default component render settings
getTagName
getTagName() : String
Returns the tag name of the region wrapper element. Defaults to 'div'.
Returns:
the tag name of the region wrapper element
setAttributes
setAttributes(attributes : Object) : RegionRenderSettings
Sets the to be configured <String,String> attributes of the wrapper element. Set 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
setComponentRenderSettings
setComponentRenderSettings(component : Component, componentRenderSettings : ComponentRenderSettings) : RegionRenderSettings
Sets the component render settings for the given component.
Parameters:
component - the component to set the render settings for
componentRenderSettings - the desired render settings
Returns:
this
setDefaultComponentRenderSettings
setDefaultComponentRenderSettings(defaultComponentRenderSettings : ComponentRenderSettings) : RegionRenderSettings
Sets the default component render settings. These will be used during rendering of the components contained in the region in case no dedicated component render settings were provided per component.
Parameters:
defaultComponentRenderSettings - the default component render settings
Returns:
this
setTagName
setTagName(tagName : String) : RegionRenderSettings
Sets the tag name of the region wrapper element. Must not be empty.
Parameters:
tagName - the tag name of the region wrapper element
Returns:
this