GuidePanel (The Adobe AEM Quickstart and Web Application.)

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, 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 Summary

Constructors
Constructor and Description

GuidePanel()

Constructors
Constructor and Description
`GuidePanel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAfFragmentMarker()` Checks if the panel has a fragment reference and returns the CSS class of the fragment marker
`java.lang.String`	`getAssetRef()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getAuthoringConfig()` AuthoringConfig is a map populated only for authoring and it contains key value pairs that govern components behaviour.
`java.lang.String`	`getDoRLayoutType()` Returns the dorLayoutType property of the layout.
`java.util.Map<java.lang.String,java.lang.String>`	`getFragmentDetails()` Returns a map containing details for fragment that has been created from a panel.
`java.lang.String`	`getFragRef()` Returns the reference to the fragment configured during authoring
`java.lang.String`	`getFragRefPropertyFromResource()` Returns the fragRef property present at the resource.
`int`	`getInitialOccur()`
`boolean`	`getIsRepeatable()` Returns whether the current panel is repeatable or not
`java.lang.String`	`getLayoutFromFragRootPanel()`
`java.lang.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
`java.lang.String`	`getOptimizeRenderPerformance()`
`java.lang.String`	`getPanelDescriptionInlineStyles()` Returns the string containing the inline style specified for the panel description
`java.lang.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
`java.lang.Boolean`	`isNewResponsiveLayout()` Returns whether panel is of new responsive layout type or not
`void`	`setSlingRequest(SlingHttpServletRequest slingRequest)` Set's the sling resource for the given AEM Form Component.
`void`	`updateCompletionAndSummary(Resource layoutNode)`

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

Methods inherited from class com.adobe.aemds.guide.common.GuideNode
activate, checkIfPathIsAbsolute, externalize, getAddMessage, getAppearance, getAuthoringConfigJSON, getBindRef, getClientLibRef, getColspan, getCssClassName, getDescription, getEnabledExp, getError, getFieldInlineStyles, getGuideFieldType, getHeight, getId, getInlineCssClass, getInlineStyles, getIsEditMode, getLayoutPath, getLayoutTabType, getLongDescriptionInlineStyles, getName, getNavTitle, getNodeClass, getNonNavigableProperty, getPath, getQuestionMarkInlineStyles, getRemoveMessage, getResourceSuperType, getResourceType, getResponsiveClasses, getResponsiveConfiguration, getSlingRequest, getStyles, getTargetVersion, getTitle, getToolbarPosition, getVersion, getVisibleExp, getWidth, getXssapi, getXssDescription, isDocumentFragmentGroup, isLayoutNavigable, isMenuRequired, isValid, isValidDorTemplateRef, setClientLibRef, setResource, syncNode

Methods inherited from class com.adobe.cq.sightly.WCMUsePojo
get, getComponent, getComponentContext, getCurrentDesign, getCurrentPage, getCurrentStyle, getDesigner, getEditContext, getInheritedPageProperties, getInheritedProperties, getPageManager, getPageProperties, getProperties, getRequest, getResource, getResourceDesign, getResourcePage, getResourceResolver, getResponse, getSlingScriptHelper, getWcmMode, getXSSAPI, init

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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
  - getToolbar
```
public GuideItemsContainer getToolbar()
```
    Returns the toolbar configured for the panel
    
    Returns:
    
    GuideItemsContainer representing the tool bar
  - updateCompletionAndSummary
```
public void updateCompletionAndSummary(Resource layoutNode)
                                throws PersistenceException
```
    Parameters:
    
    layoutNode -
    
    Throws:
    
    PersistenceException
  - setSlingRequest
```
public void setSlingRequest(SlingHttpServletRequest slingRequest)
```
    Description copied from class: GuideNode
    
    Set's the sling resource for the given AEM Form Component.
    
    Overrides:
    
    setSlingRequest in class GuideNode
    
    Parameters:
    
    slingRequest -
    
    See Also:
    
    SlingHttpServletRequest

Class GuidePanel

Constructor Summary

Method Summary

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

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

Methods inherited from class com.adobe.cq.sightly.WCMUsePojo

Methods inherited from class java.lang.Object

Constructor Detail

GuidePanel

Method Detail

getMinOccur

getMaxOccur

getInitialOccur

getFragRefPropertyFromResource

getFragRef

isFragmentAvailable

getFragmentDetails

getOptimizeRenderPerformance

getAssetRef

getLayoutFromFragRootPanel

getAfFragmentMarker

isNewResponsiveLayout

getAuthoringConfig

getDoRLayoutType

getPanelInlineStyles

getPanelDescriptionInlineStyles

getIsRepeatable

isHasToolbar

getLongDescription

getToolbar

updateCompletionAndSummary

setSlingRequest