com.adobe.aemds.guide.common

Class GuidePanel

java.lang.Object

com.adobe.cq.sightly.WCMUsePojo

com.adobe.aemds.guide.common.GuideNode

com.adobe.aemds.guide.common.GuideItemsContainer

com.adobe.aemds.guide.common.GuidePanel

All Implemented Interfaces:

FDField, StyledFDField, Serializable, org.apache.sling.scripting.sightly.pojo.Use

Direct Known Subclasses:

GuideTable, GuideTableRow

public class GuidePanel
extends GuideItemsContainer
implements 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

Field Summary

Fields inherited from class com.adobe.aemds.guide.common.GuideNode

baseName, clientLibRef, error, i18n, id, inlineStyles, locale, localeName, logger, resource, resourceProps, slingRequest, xssapi

Constructor Summary

Constructors

Constructor and Description
GuidePanel()

Method Summary

Modifier and Type	Method and Description
String	getAfFragmentMarker() Checks if the panel has a fragment reference and returns the CSS class of the fragment marker
Map<String,String>	getFragmentDetails() Returns a map containing details for fragment that has been created from a panel.
String	getFragRef() Returns the reference to the fragment configured during authoring
String	getFragRefPropertyFromResource() Returns the fragRef property present at the resource.
boolean	getIsRepeatable() Returns whether the current panel is repeatable or not
String	getLongDescription() Returns the long description of the panel configured in authoring dialog
int	getMaxOccur() Returns the current panel's maximum count configured in the authoring dialog
int	getMinOccur() Returns the current panel's minimum count configured in the authoring dialog
String	getPanelDescriptionInlineStyles() Returns the string containing the inline style specified for the panel description
String	getPanelInlineStyles() Returns the string containing the inline style specified for the panel
GuideItemsContainer	getToolbar() Returns the toolbar configured for the panel
boolean	isFragmentAvailable() Returns a boolean indicating whether the fragment is available or not.
boolean	isHasToolbar() Returns if toolbar present for the panel
boolean	validate(org.apache.sling.api.resource.ResourceResolver serviceResourceResolver) This API is meant to validate the current AF object.

Methods inherited from class com.adobe.aemds.guide.common.GuideItemsContainer

getItems

Methods inherited from class com.adobe.aemds.guide.common.GuideNode

activate, externalize, externalize, getAddMessage, getAppearance, getAuthoringConfigJSON, getBindRef, getClientLibRef, getColspan, getCssClassName, getDescription, getEnabled, getEnabledExp, getError, getFieldInlineStyles, getGuideFieldType, getHeight, getId, getInlineCssClass, getInlineStyles, getIsEditMode, getIsTitleRichText, getLayoutPath, getLayoutProperty, getLongDescriptionInlineStyles, getName, getNavTitle, getNodeClass, getPath, getQuestionMarkInlineStyles, getRemoveMessage, getResourceSuperType, getResourceType, getResponsiveClasses, getResponsiveConfiguration, getSlingRequest, getStyles, getTargetVersion, getTitle, getToolbarPosition, getVersion, getVisible, getVisibleExp, getWidth, getXssapi, getXssDescription, isDocumentFragmentGroup, isLayoutNavigable, isMenuRequired, isValid, isValidDorTemplateRef, setClientLibRef, setResource, setSlingRequest, syncNode

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

getFragRefPropertyFromResource

public String getFragRefPropertyFromResource()

Returns the fragRef property present at the resource.

Returns:

String representing the fragRef

getFragRef

public 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 Map<String,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.

getAfFragmentMarker

public 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

getPanelInlineStyles

public String getPanelInlineStyles()

Returns the string containing the inline style specified for the panel

Returns:

inline style of the panel

getPanelDescriptionInlineStyles

public 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 String getLongDescription()

Returns the long description of the panel configured in authoring dialog

Returns:

String representing the long description

getToolbar

public GuideItemsContainer getToolbar()

Returns the toolbar configured for the panel

Returns:

GuideItemsContainer representing the tool bar

validate

public boolean validate(org.apache.sling.api.resource.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