Package com.adobe.aemds.guide.common

Class GuidePanel

  • All Implemented Interfaces:
    FDField, StyledFDField, java.io.Serializable, Use
    Direct Known Subclasses:
    GuideTable, GuideTableRow
    public class GuidePanel
extends GuideItemsContainer
implements java.io.Serializable
    GuidePanel class encapsulates basic properties of adaptive forms Panels. Some of the properties that it encapsulates are listed below:
    • Minimum count of the panel
    • Maximum count of the panel
    • Long Description of the panel
    Since:
    AEM 6.0
    See Also:
    Serialized Form

    • Constructor Detail

      • GuidePanel

        public GuidePanel()

    • Method Detail

      • getMinOccur

        public int getMinOccur()
        Returns the current panel's minimum count configured in the authoring dialog
        Returns:
        Integer representing the panel's minimum count

      • getMaxOccur

        public int getMaxOccur()
        Returns the current panel's maximum count configured in the authoring dialog
        Returns:
        Integer representing the panel's maximum count

      • getInitialOccur

        public int getInitialOccur()

      • getFragRefPropertyFromResource

        public java.lang.String getFragRefPropertyFromResource()
        Returns the fragRef property present at the resource.
        Returns:
        String representing the fragRef

      • getFragRef

        public java.lang.String getFragRef()
        Returns the reference to the fragment configured during authoring
        Returns:
        path of the fragment reference configured for the panel component

      • isFragmentAvailable

        public boolean isFragmentAvailable()
        Returns a boolean indicating whether the fragment is available or not.
        Returns:
        Boolean indicating whether the fragment is available or not.

      • getFragmentDetails

        public java.util.Map<java.lang.String,​java.lang.String> getFragmentDetails()
        Returns a map containing details for fragment that has been created from a panel.
        Returns:
        Map containing title of the fragment and details of fields contained in the fragment.

      • getOptimizeRenderPerformance

        public java.lang.String getOptimizeRenderPerformance()

      • getAssetRef

        public java.lang.String getAssetRef()
        Returns:
        asset ref (String)

      • getLayoutFromFragRootPanel

        public java.lang.String getLayoutFromFragRootPanel()

      • getAfFragmentMarker

        public java.lang.String getAfFragmentMarker()
        Checks if the panel has a fragment reference and returns the CSS class of the fragment marker
        Returns:
        CSS class of the af fragment marker

      • isNewResponsiveLayout

        public java.lang.Boolean isNewResponsiveLayout()
        Returns whether panel is of new responsive layout type or not
        Returns:
        Boolean.TRUE if panel is of new responsive layout type

      • getAuthoringConfig

        public java.util.Map<java.lang.String,​java.lang.Object> getAuthoringConfig()
        Description copied from class: GuideNode
        AuthoringConfig is a map populated only for authoring and it contains key value pairs that govern components behaviour. There may be a use case where one wants to access few list of properties of AEM form component during authoring, this API is built for this.
        Overrides:
        getAuthoringConfig in class GuideNode
        Returns:
        Map authoringConfig Map

      • getDoRLayoutType

        public java.lang.String getDoRLayoutType()
        Returns the dorLayoutType property of the layout.
        Returns:
        String

      • getPanelInlineStyles

        public java.lang.String getPanelInlineStyles()
        Returns the string containing the inline style specified for the panel
        Returns:
        inline style of the panel

      • getPanelDescriptionInlineStyles

        public java.lang.String getPanelDescriptionInlineStyles()
        Returns the string containing the inline style specified for the panel description
        Returns:
        inline style of the panel description

      • getIsRepeatable

        public boolean getIsRepeatable()
        Returns whether the current panel is repeatable or not
        Overrides:
        getIsRepeatable in class GuideNode
        Returns:
        boolean indicating if panel is repeatable or not

      • isHasToolbar

        public boolean isHasToolbar()
        Returns if toolbar present for the panel
        Returns:
        true if toolbar is present else false

      • getLongDescription

        public java.lang.String getLongDescription()
        Returns the long description of the panel configured in authoring dialog
        Returns:
        String representing the long description

      • validate

        public boolean validate​(ResourceResolver serviceResourceResolver)
        Description copied from class: GuideNode
        This API is meant to validate the current AF object. It could validate and auto-fix if required
        Overrides:
        validate in class GuideNode
        Parameters:
        serviceResourceResolver - reference to service resource resolver since validate would require access to immutable content
        Returns:
        {Boolean} true, if valid else false