Interface PanelContainerItem

All Superinterfaces:
ContainerItem

@ConsumerType public interface PanelContainerItem extends ContainerItem
Interface for a container item that is a panel. In addition to having a resource, a panel container item also includes a title, ID, and data layer object.
Since:
com.adobe.cq.wcm.core.components.models 12.27.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Name of the property that contains the panel item's title.
  • Method Summary

    Modifier and Type
    Method
    Description
    default @Nullable ComponentData
    Gets the data layer object for this panel.
    default @Nullable String
    Gets the ID for this panel.
    default @Nullable String
    Gets the panel item's title.

    Methods inherited from interface com.adobe.cq.wcm.core.components.models.ContainerItem

    getName, getPath, getResource
  • Field Details

    • PN_PANEL_TITLE

      static final String PN_PANEL_TITLE
      Name of the property that contains the panel item's title.
      See Also:
  • Method Details

    • getTitle

      @Nullable default @Nullable String getTitle()
      Gets the panel item's title.
      Returns:
      The title of the panel item.
    • getId

      @Nullable default @Nullable String getId()
      Gets the ID for this panel. Note: this is not the ID of the contained item - this is the ID of the panel its self.
      Returns:
      The ID for this panel.
    • getData

      @Nullable default @Nullable ComponentData getData()
      Gets the data layer object for this panel. Note: this is not the data layer object for the contained item - this is the data layer object for the panel its self.
      Returns:
      The data layer object for this panel.