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.
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:
| Property | Description |
|---|---|
| attributes: Object | Returns the configured attributes of the wrapper element as set by setAttributes(Object). |
| defaultComponentRenderSettings: ComponentRenderSettings | Returns the default component render settings. |
| tagName: String | Returns the tag name of the region wrapper element. |
| Constructor | Description |
|---|---|
| RegionRenderSettings() | Creates region render settings which can then be configured further. |
| Method | Description |
|---|---|
| getAttributes() | Returns the configured attributes of the wrapper element as set by setAttributes(Object). |
| getComponentRenderSettings(Component) | Returns the component render settings for the given component. |
| getDefaultComponentRenderSettings() | Returns the default component render settings. |
| getTagName() | Returns the tag name of the region wrapper element. |
| setAttributes(Object) | Sets the to be configured <String,String> attributes of the wrapper element. |
| setComponentRenderSettings(Component, ComponentRenderSettings) | Sets the component render settings for the given component. |
| setDefaultComponentRenderSettings(ComponentRenderSettings) | Sets the default component render settings. |
| setTagName(String) | Sets the tag name of the region wrapper element. |
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
Returns the configured attributes of the wrapper element as set by setAttributes(Object).
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 tag name of the region wrapper element. Defaults to 'div'.
Creates region render settings which can then be configured further. They are to be used for PageMgr.renderRegion(Region, RegionRenderSettings) calls.
See Also:
Returns the configured attributes of the wrapper element as set by setAttributes(Object).
Returns:
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:
Returns:
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:
Returns the tag name of the region wrapper element. Defaults to 'div'.
Returns:
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:
Returns:
Sets the component render settings for the given component.
Parameters:
Returns:
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:
Returns:
Sets the tag name of the region wrapper element. Must not be empty.
Parameters:
Returns:
j
