Declare the Decorator

In order for a pool decorator to be actually used, you must declare it by adding a ui:decorator element to your publication's layout-group resource. For example:

<group name="xyz" root="true">
  ...
  <ui:decorator name="myDecorator"/>
  ...
</group>

The ui:decorator element must be added as the child of a top-level group element (that is, one that is a direct child of the resource file's root groups element).

Once you have done this, the decorator automatically takes effect for all pools within the top-level group and its children. You can add the decorator to as many top-level group elements as you want.

You can add more than one decorator to a group. For example:

<group name="xyz" root="true">
  ...
  <ui:decorator name="myDecorator/>
  <ui:decorator name="myRequestDecorator/>
  ...
</layout>

Note the following:

  • The decorator element belongs to the interface-hints namespace, which means that its name will usually be preceded by a prefix (ui in the examples above) declared at the start of the layout-group resource file. For full descriptions of the layout-group and decorator elements, see the CUE Content Store Resource Reference.

  • Multiple decorators are executed in the order they appear in the group definition. This may sometimes be significant. Request decorators, however, are always executed last.