Annotation Type HtmlPageItemsConfig


public @interface HtmlPageItemsConfig
Context-aware configuration holding information on items to be included in pages: - scripts - links - meta This configuration is meant to be used as a context-aware resource. See Context-Aware Resources

The JCR node structure depends on the provided Persistence Strategy. See https://sling.apache.org/documentation/bundles/context-aware-configuration/context-aware-configuration-spi.html#configuration-persistence-strategy-1 Assumed structure (default AEM Setup):

      com.adobe.cq.wcm.core.components.config.HtmlPageItemsConfig
          + jcr:content
              - prefixPath="/some/path"
              + items
                  + item01
                      - element=["link"|"script"|"meta"]
                      - location=["header"|"footer"]
                      + attributes
                          + attribute01
                              - name="attribute01Name"
                              - value="attribute01Value"
                          + attribute02
                              - name="attribute02Name"
                              - value="attribute02Value"
                              ...
                  + item02
                      ...
                  ...
  
The structure of the initial implementation is deprecated but still supported:
      com.adobe.cq.wcm.core.components.config.HtmlPageItemsConfig
          - prefixPath="/some/path"
          + item01
              - element=["link"|"script"|"meta"]
              - location=["header"|"footer"]
              + attributes
                  - attributeName01="attributeValue01"
                  - attributeName02="attributeValue02"
              ...
          + item02
              ...
          ...
  
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Returns the items to render.
    Returns the path that will be prefixed to all href's and src's
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Name of the property that stores the path that will be prefixed to all href's and src's
  • Field Details

    • PN_PREFIX_PATH

      static final String PN_PREFIX_PATH
      Name of the property that stores the path that will be prefixed to all href's and src's
      Since:
      com.adobe.cq.wcm.core.components.config 1.0.0
      See Also:
  • Element Details

    • prefixPath

      String prefixPath
      Returns the path that will be prefixed to all href's and src's
      Returns:
      The prefix path
      Since:
      com.adobe.cq.wcm.core.components.config 1.0.0
      Default:
      ""
    • items

      Returns the items to render.
      Returns:
      The array of items to render
      Since:
      com.adobe.cq.wcm.core.components.config 2.0.0
      Default:
      {}