Package com.day.cq.wcm.foundation.model

Interface AllowedComponents

@ConsumerType public interface AllowedComponents
Public, Sling Model Interface to be used in HTLs.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCssClass()
    All css classes to be used on the Allowed Components DOM container
    String
    getPlaceholderCssClass()
    All css classes to be used on a single Allowed Component DOM node
    String
    getPlaceholderResourceType()
    The resource path of the Placeholder that should be used to list each of the Allowed Components in the DOM
    Map<String,Resource>
    getResourcesMap()
    Sorted (by Resource's Component Title) Map of all Allowed Components for the given Resource: key - synthetic path to the single Allowed Component value - resource representing single Allowed Component
    String
    getTitle()
    Title of the Component represented by the given Resource, to be used in the Allowed Components DOM container
    boolean
    isApplicable()
    Is the given resource contained by a page, with authored template structure, and is the given resource set as editable (unlocked)

  • Method Details

    • getCssClass

      String getCssClass()
      All css classes to be used on the Allowed Components DOM container
      Returns:
      css classes

    • getPlaceholderCssClass

      String getPlaceholderCssClass()
      All css classes to be used on a single Allowed Component DOM node
      Returns:
      css classes

    • getPlaceholderResourceType

      String getPlaceholderResourceType()
      The resource path of the Placeholder that should be used to list each of the Allowed Components in the DOM
      Returns:
      resource type of Placeholder

    • getResourcesMap

      Map<String,Resource> getResourcesMap()
      Sorted (by Resource's Component Title) Map of all Allowed Components for the given Resource:
      • key - synthetic path to the single Allowed Component
      • value - resource representing single Allowed Component
      Returns:
      Map of Resources with Paths as a keys

    • getTitle

      String getTitle()
      Title of the Component represented by the given Resource, to be used in the Allowed Components DOM container
      Returns:
      title

    • isApplicable

      boolean isApplicable()
      Is the given resource contained by a page, with authored template structure, and is the given resource set as editable (unlocked)
      Returns:
      true if the template has structure support and the resource is editable, false otherwise