Package com.adobe.cq.wcm.core.components.models

Interface ClientLibraries

  • @ConsumerType
public interface ClientLibraries
    Defines the ClientLibraries Sling Model used to collect and include client libraries.
    Since:
    com.adobe.cq.wcm.core.components.models 12.14.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String OPTION_ASYNC
      Name of the HTL option to inject the async attribute into the javascript script tag.
      static String OPTION_CATEGORIES
      Name of the HTL option used to inject the clientlib categories.
      static String OPTION_CROSSORIGIN
      Name of the HTL option to inject the crossorigin attribute into the javascript script tag.
      static String OPTION_DEFER
      Name of the HTL option to inject the defer attribute into the javascript script tag.
      static String OPTION_FILTER_REGEX
      Name of the option used to specify the regular expression that needs to be matched by client library categories to be collected.
      static String OPTION_INHERITED
      Name of the option used to specify if client libraries should be searched up the inheritance chain (using Sling resource supertype).
      static boolean OPTION_INHERITED_DEFAULT
      Default value for OPTION_INHERITED.
      static String OPTION_MEDIA
      Name of the HTL option to inject the media attribute into the stylesheet link tag.
      static String OPTION_ONLOAD
      Name of the HTL option to inject the onload attribute into the javascript script tag.
      static String OPTION_RESOURCE_TYPES
      Name of the option used to specify the Collection of resource types.

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default String getCssIncludes()
      Returns a concatenation of all the HTML CSS link tags defined for the requested resource.
      default String getCssInline()
      Returns a concatenation of all the CSS libraries defined for the requested resource.
      default String getJsAndCssIncludes()
      Returns a concatenation of all the HTML JS script and CSS link tags defined for the requested resource.
      default String getJsIncludes()
      Returns a concatenation of all the HTML JS script tags defined for the requested resource.
      default String getJsInline()
      Returns a concatenation of all the JS libraries defined for the requested resource.

    • Field Detail

      • OPTION_RESOURCE_TYPES

        static final String OPTION_RESOURCE_TYPES
        Name of the option used to specify the Collection of resource types.
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0
        See Also:
        Constant Field Values

      • OPTION_FILTER_REGEX

        static final String OPTION_FILTER_REGEX
        Name of the option used to specify the regular expression that needs to be matched by client library categories to be collected.
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0
        See Also:
        Constant Field Values

      • OPTION_INHERITED

        static final String OPTION_INHERITED
        Name of the option used to specify if client libraries should be searched up the inheritance chain (using Sling resource supertype).
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0
        See Also:
        Constant Field Values

      • OPTION_INHERITED_DEFAULT

        static final boolean OPTION_INHERITED_DEFAULT
        Default value for OPTION_INHERITED.
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0
        See Also:
        Constant Field Values

      • OPTION_CATEGORIES

        static final String OPTION_CATEGORIES
        Name of the HTL option used to inject the clientlib categories.
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0
        See Also:
        Constant Field Values

      • OPTION_ASYNC

        static final String OPTION_ASYNC
        Name of the HTL option to inject the async attribute into the javascript script tag.
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0
        See Also:
        Constant Field Values

      • OPTION_DEFER

        static final String OPTION_DEFER
        Name of the HTL option to inject the defer attribute into the javascript script tag.
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0
        See Also:
        Constant Field Values

      • OPTION_CROSSORIGIN

        static final String OPTION_CROSSORIGIN
        Name of the HTL option to inject the crossorigin attribute into the javascript script tag.
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0
        See Also:
        Constant Field Values

      • OPTION_ONLOAD

        static final String OPTION_ONLOAD
        Name of the HTL option to inject the onload attribute into the javascript script tag.
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0
        See Also:
        Constant Field Values

      • OPTION_MEDIA

        static final String OPTION_MEDIA
        Name of the HTL option to inject the media attribute into the stylesheet link tag.
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0
        See Also:
        Constant Field Values

    • Method Detail

      • getJsInline

        default String getJsInline()
        Returns a concatenation of all the JS libraries defined for the requested resource.
        Returns:
        the inlined JS libraries
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0

      • getCssInline

        default String getCssInline()
        Returns a concatenation of all the CSS libraries defined for the requested resource.
        Returns:
        the inlined CSS libraries
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0

      • getJsIncludes

        default String getJsIncludes()
        Returns a concatenation of all the HTML JS script tags defined for the requested resource.
        Returns:
        the HTML JS script tags
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0

      • getCssIncludes

        default String getCssIncludes()
        Returns a concatenation of all the HTML CSS link tags defined for the requested resource.
        Returns:
        the HTML CSS link tags
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0

      • getJsAndCssIncludes

        default String getJsAndCssIncludes()
        Returns a concatenation of all the HTML JS script and CSS link tags defined for the requested resource.
        Returns:
        the HTML JS script and CSS link tags
        Since:
        com.adobe.cq.wcm.core.components.models 12.14.0