GuideNode (AEM Forms API)

java.lang.Object
- com.adobe.cq.sightly.WCMUsePojo
- - com.adobe.aemds.guide.common.GuideNode

All Implemented Interfaces:

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

Direct Known Subclasses:

ESign, GuideContainer, GuideField, GuideItemsContainer, Summary, Verify
```
@Model
public class GuideNode
extends com.adobe.cq.sightly.WCMUsePojo
implements Serializable, StyledFDField
```
GuideNode is base class which every AEM form component inherits from. It abstracts the basic properties of each component(panel/field).Few are listed below:
- Sling HTTP Servlet Request
- Resource
- Properties of the resource
This provides basic getter's and setter's required to create/initialize and AEM Form Component.
Since:

AEM 6.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`baseName`
`protected String`	`clientLibRef`
`protected String`	`error`
`protected com.day.cq.i18n.I18n`	`i18n`
`protected String`	`id`
`protected Map<String,String>`	`inlineStyles`
`protected Locale`	`locale`
`protected String`	`localeName`
`protected org.slf4j.Logger`	`logger`
`protected org.apache.sling.api.resource.Resource`	`resource`
`protected org.apache.sling.api.resource.ValueMap`	`resourceProps`
`protected org.apache.sling.api.SlingHttpServletRequest`	`slingRequest`
`protected com.adobe.granite.xss.XSSAPI`	`xssapi`

Constructor Summary

Constructors
Constructor and Description

GuideNode()

Constructors
Constructor and Description
`GuideNode()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activate()`
`String`	`externalize(String key)` Deprecated.
`String`	`externalize(String value, String key)`
`String`	`getAddMessage()`
`String`	`getAppearance()` Returns the appearance of the widget configured during authoring.
`Map<String,Object>`	`getAuthoringConfig()` AuthoringConfig is a map populated only for authoring and it contains key value pairs that govern components behaviour.
`String`	`getAuthoringConfigJSON()` Return the JSON string containing property map of an AEM form component which is to be used during author time.
`String`	`getBindRef()`
`String`	`getClientLibRef()`
`Integer`	`getColspan()` Returns the colspan of an AEM form component configured during authoring.
`String`	`getCssClassName()` Returns the name of the CSS class configured during authoring.
`String`	`getDescription()`
`String`	`getEnabled()`
`String`	`getEnabledExp()`
`String`	`getError()`
`String`	`getFieldInlineStyles()`
`String`	`getGuideFieldType()` Returns the field type of the AEM Forms Component
`String`	`getHeight()` Returns the height of AEM Form component configured in the authoring dialog.
`String`	`getId()`
`String`	`getInlineCssClass()` Returns the inline CSS class applied to the component during style authoring.
`String`	`getInlineStyles(String name)`
`Boolean`	`getIsEditMode()` Utility to check if the AEM Form Component is rendered during edit/design mode of AEM.
`boolean`	`getIsRepeatable()` Utility to check if the given AEM Form Component is repeatable or not
`Boolean`	`getIsTitleRichText()`
`List<GuideNode>`	`getItems()` Returns the list of items present inside an AEM Forms container
`String`	`getLayoutPath()` Returns the path of the layout configured in an AEM Form Panel
`protected Object`	`getLayoutProperty(String property)`
`String`	`getLongDescriptionInlineStyles()`
`String`	`getName()`
`String`	`getNavTitle()`
`String`	`getNodeClass()` Returns the node class associated with the of the AEM form component.
`String`	`getPath()` Returns the path representing the current AEM Form Component.
`String`	`getQuestionMarkInlineStyles()`
`String`	`getRemoveMessage()`
`String`	`getResourceSuperType()` Returns the sling resource super type of the current resource set.
`String`	`getResourceType()` Returns the sling resource type of the current resource set.
`String`	`getResponsiveClasses()` Returns CSS classes to be applied on field/panel, for honoring its responsive configurtion.
`com.adobe.aemds.guide.model.ResponsiveConfiguration`	`getResponsiveConfiguration()` Returns Responsive Configuration (cq:responsive) of AEM Forms Component.
`org.apache.sling.api.SlingHttpServletRequest`	`getSlingRequest()` Returns the Interface to provide client request information to a servlet.
`String`	`getStyles()` Returns the string containing the width and height property represented as an inline CSS rule.
`String`	`getTargetVersion()` Returns the target specification version of Adaptive Form Component.
`String`	`getTitle()` Returns the title of the AEM Form component.
`String`	`getToolbarPosition()`
`String`	`getVersion()` Returns the specification version of Adaptive Form Component Version of an adaptive form component specifies the node structure changes.
`String`	`getVisible()`
`String`	`getVisibleExp()`
`String`	`getWidth()` Returns the width of AEM Form Component configured in the authoring dialog.
`com.adobe.granite.xss.XSSAPI`	`getXssapi()`
`String`	`getXssDescription()`
`boolean`	`isDocumentFragmentGroup()` Deprecated.
`boolean`	`isLayoutNavigable()` Checks if the layout configured in the AEM Forms Panel component is navigable.
`boolean`	`isMenuRequired()` Returns true for guide node type or super type being rootPanel / panel / guideAdModule / guideAdModuleGroup
`boolean`	`isValid()`
`boolean`	`isValidDorTemplateRef()`
`void`	`setClientLibRef(String clientLibRef)`
`void`	`setResource(org.apache.sling.api.resource.Resource resource)` Deprecated. use the init API
`void`	`setSlingRequest(org.apache.sling.api.SlingHttpServletRequest slingRequest)` Set's the sling resource for the given AEM Form Component.
`void`	`syncNode()`
`boolean`	`validate(org.apache.sling.api.resource.ResourceResolver serviceResourceResolver)` This API is meant to validate the current AF object.

- Field Detail
  - slingRequest
```
protected org.apache.sling.api.SlingHttpServletRequest slingRequest
```
  - resource
```
protected org.apache.sling.api.resource.Resource resource
```
  - resourceProps
```
protected org.apache.sling.api.resource.ValueMap resourceProps
```
  - id
```
protected String id
```
  - clientLibRef
```
protected String clientLibRef
```
  - baseName
```
protected String baseName
```
  - localeName
```
protected String localeName
```
  - i18n
```
protected com.day.cq.i18n.I18n i18n
```
  - locale
```
protected Locale locale
```
  - xssapi
```
protected com.adobe.granite.xss.XSSAPI xssapi
```
  - error
```
protected String error
```
  - inlineStyles
```
protected Map<String,String> inlineStyles
```
  - logger
```
protected org.slf4j.Logger logger
```
- Constructor Detail
  - GuideNode
```
public GuideNode()
```
- Method Detail
  - activate
```
public void activate()
              throws Exception
```
    Specified by:
    
    activate in class com.adobe.cq.sightly.WCMUsePojo
    
    Throws:
    
    Exception
  - getResponsiveConfiguration
```
public com.adobe.aemds.guide.model.ResponsiveConfiguration getResponsiveConfiguration()
```
    Returns Responsive Configuration (cq:responsive) of AEM Forms Component.
    
    Returns:
    
    ResponsiveConfiguration representing cq:responsive of field / panel
  - getResponsiveClasses
```
public String getResponsiveClasses()
```
    Returns CSS classes to be applied on field/panel, for honoring its responsive configurtion.
    
    Returns:
    
    String representing CSS responsive classes
  - getGuideFieldType
```
public String getGuideFieldType()
```
    Returns the field type of the AEM Forms Component
    
    Specified by:
    
    getGuideFieldType in interface FDField
    
    Returns:
    
    String representing guide field type
  - getAuthoringConfigJSON
```
public String getAuthoringConfigJSON()
```
    Return the JSON string containing property map of an AEM form component which is to be used during author time. Say, a custom component, wants to provides its own author config JSON, its has to override this.
    
    Specified by:
    
    getAuthoringConfigJSON in interface FDField
    
    Returns:
    
    String authoringConfig JSON string
  - getAuthoringConfig
```
public Map<String,Object> getAuthoringConfig()
```
    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.
    
    Returns:
    
    Map authoringConfig Map
  - getAppearance
```
public String getAppearance()
```
    Returns the appearance of the widget configured during authoring.
    
    Returns:
    
    String representing path of appearance
  - getStyles
```
public String getStyles()
```
    Returns the string containing the width and height property represented as an inline CSS rule.
    
    Returns:
    
    string containing width and height as inline CSS styl
  - getInlineStyles
```
public String getInlineStyles(String name)
```
  - getFieldInlineStyles
```
public String getFieldInlineStyles()
```
  - getQuestionMarkInlineStyles
```
public String getQuestionMarkInlineStyles()
```
  - getLongDescriptionInlineStyles
```
public String getLongDescriptionInlineStyles()
```
  - getColspan
```
public Integer getColspan()
```
    Returns the colspan of an AEM form component configured during authoring. This holds valid only in case of AEM form field's whose parent has a grid fluid layout configured. Col Span indicates the number of columns an AEM Form component should span across
    
    Returns:
    
    integer representing the colspan
  - getInlineCssClass
```
public String getInlineCssClass()
```
    Returns the inline CSS class applied to the component during style authoring.
    
    Returns:
    
    String representing the CSS class name
  - getHeight
```
public String getHeight()
```
    Returns the height of AEM Form component configured in the authoring dialog. The value returned has pixel as its unit.
    
    Specified by:
    
    getHeight in interface StyledFDField
    
    Returns:
    
    String representing the height
  - getWidth
```
public String getWidth()
```
    Returns the width of AEM Form Component configured in the authoring dialog. The value returned has percentage as its unit
    
    Specified by:
    
    getWidth in interface StyledFDField
    
    Returns:
    
    width of the form component
  - getVersion
```
public String getVersion()
```
    Returns the specification version of Adaptive Form Component Version of an adaptive form component specifies the node structure changes.
    
    Returns:
    
    String representing the adaptive form component's specification version
  - getTargetVersion
```
public String getTargetVersion()
```
    Returns the target specification version of Adaptive Form Component. Target version of an Adaptive form component specifies the behaviour/rendition of the component.
    
    Returns:
    
    String representing the adaptive form component's target specification version
  - setResource
```
public void setResource(org.apache.sling.api.resource.Resource resource)
```
    Deprecated. use the init API
    
    Set's the sling resource for the given AEM Form Component.
    
    Parameters:
    
    resource - Represents the resource to be used
    
    See Also:
    
    Resource
  - setSlingRequest
```
public void setSlingRequest(org.apache.sling.api.SlingHttpServletRequest slingRequest)
```
    Set's the sling resource for the given AEM Form Component.
    
    Parameters:
    
    slingRequest - Represents the http sling request
    
    See Also:
    
    SlingHttpServletRequest
  - getEnabledExp
```
public String getEnabledExp()
```
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface FDField
    
    Returns:
    
    Returns the name of the component
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface FDField
    
    Returns:
    
    Returns the description of the component
  - getXssDescription
```
public String getXssDescription()
```
  - getId
```
public String getId()
             throws javax.jcr.RepositoryException
```
    Specified by:
    
    getId in interface FDField
    
    Returns:
    
    Returns the id of the component.
    
    Throws:
    
    javax.jcr.RepositoryException
  - getIsEditMode
```
public Boolean getIsEditMode()
```
    Utility to check if the AEM Form Component is rendered during edit/design mode of AEM.
    
    Returns:
    
    boolean representing if the given mode is edit/design or not
  - getIsRepeatable
```
public boolean getIsRepeatable()
```
    Utility to check if the given AEM Form Component is repeatable or not
    
    Returns:
    
    boolean represent if repeatable or not
  - getItems
```
public List<GuideNode> getItems()
```
    Returns the list of items present inside an AEM Forms container
    
    Returns:
    
    List of GuideNode present inside the container
  - getPath
```
public String getPath()
```
    Returns the path representing the current AEM Form Component. This path is the JCR Path of the current resource.
    
    Specified by:
    
    getPath in interface FDField
    
    Returns:
    
    string representing the path
  - getResourceType
```
public String getResourceType()
```
    Returns the sling resource type of the current resource set.
    
    Returns:
    
    string representing the resource type
  - getResourceSuperType
```
public String getResourceSuperType()
```
    Returns the sling resource super type of the current resource set.
    
    Returns:
    
    string representing the resource super type
  - getLayoutPath
```
public String getLayoutPath()
                     throws org.apache.sling.api.resource.PersistenceException
```
    Returns the path of the layout configured in an AEM Form Panel
    
    Returns:
    
    String representing path of the layout
    
    Throws:
    
    org.apache.sling.api.resource.PersistenceException
  - isLayoutNavigable
```
public boolean isLayoutNavigable()
                          throws org.apache.sling.api.resource.PersistenceException
```
    Checks if the layout configured in the AEM Forms Panel component is navigable.
    
    Returns:
    
    boolean indicating if layout is navigable
    
    Throws:
    
    org.apache.sling.api.resource.PersistenceException
  - isMenuRequired
```
public boolean isMenuRequired()
```
    Returns true for guide node type or super type being rootPanel / panel / guideAdModule / guideAdModuleGroup
    
    Returns:
    
    true, if menu required for the component else false
  - isDocumentFragmentGroup
```
public boolean isDocumentFragmentGroup()
```
    Deprecated.
    
    Returns true for guide node type or super type is guideAdModuleGroup
    
    Returns:
    
    true if component is part of document fragment group else false
  - getLayoutProperty
```
protected Object getLayoutProperty(String property)
                            throws org.apache.sling.api.resource.PersistenceException
```
    Throws:
    
    org.apache.sling.api.resource.PersistenceException
  - getToolbarPosition
```
public String getToolbarPosition()
                          throws org.apache.sling.api.resource.PersistenceException
```
    Throws:
    
    org.apache.sling.api.resource.PersistenceException
  - getAddMessage
```
public String getAddMessage()
```
  - getRemoveMessage
```
public String getRemoveMessage()
```
  - getNavTitle
```
public String getNavTitle()
```
  - getIsTitleRichText
```
public Boolean getIsTitleRichText()
```
  - getTitle
```
public String getTitle()
```
    Returns the title of the AEM Form component.
    
    Specified by:
    
    getTitle in interface FDField
    
    Returns:
    
    String representing the title
  - getSlingRequest
```
public org.apache.sling.api.SlingHttpServletRequest getSlingRequest()
```
    Returns the Interface to provide client request information to a servlet.
    
    Returns:
    
    sling http request
  - getNodeClass
```
public String getNodeClass()
```
    Returns the node class associated with the of the AEM form component. This node class is used to instantiate client model
    
    Returns:
    
    String representing the node class
  - getVisibleExp
```
public String getVisibleExp()
```
  - getXssapi
```
public com.adobe.granite.xss.XSSAPI getXssapi()
```
  - getCssClassName
```
public String getCssClassName()
```
    Returns the name of the CSS class configured during authoring.
    
    Specified by:
    
    getCssClassName in interface StyledFDField
    
    Returns:
    
    String representing the CSS class name
  - externalize
```
public String externalize(String value,
                          String key)
```
    Parameters:
    
    value -
    
    key -
    
    Returns:
    
    Translation of the passed value if found else the same value.
  - externalize
```
@Deprecated
public String externalize(String key)
```
    Deprecated.
    
    This API is deprecated Use the externalize method instead.
  - getError
```
public String getError()
```
  - getBindRef
```
public String getBindRef()
```
  - isValid
```
public boolean isValid()
```
  - syncNode
```
public void syncNode()
              throws GuideException
```
    Throws:
    
    GuideException
  - validate
```
public boolean validate(org.apache.sling.api.resource.ResourceResolver serviceResourceResolver)
```
    This API is meant to validate the current AF object. It could validate and auto-fix if required
    
    Parameters:
    
    serviceResourceResolver - reference to service resource resolver since validate would require access to immutable content
    
    Returns:
    
    {Boolean} true, if valid else false
  - isValidDorTemplateRef
```
public boolean isValidDorTemplateRef()
```
  - getClientLibRef
```
public String getClientLibRef()
```
  - setClientLibRef
```
public void setClientLibRef(String clientLibRef)
```
  - getEnabled
```
public String getEnabled()
```
    Returns:
    
    Returns the value of "enabled" property of field.
  - getVisible
```
public String getVisible()
```
    Returns:
    
    Returns the value of "visible" property of field.

Class GuideNode

Field Summary

Constructor Summary

Method Summary

Field Detail

slingRequest

resource

resourceProps

id

clientLibRef

baseName

localeName

i18n

locale

xssapi

error

inlineStyles

logger

Constructor Detail

GuideNode

Method Detail

activate

getResponsiveConfiguration

getResponsiveClasses

getGuideFieldType

getAuthoringConfigJSON

getAuthoringConfig

getAppearance

getStyles

getInlineStyles

getFieldInlineStyles

getQuestionMarkInlineStyles

getLongDescriptionInlineStyles

getColspan

getInlineCssClass

getHeight

getWidth

getVersion

getTargetVersion

setResource

setSlingRequest

getEnabledExp

getName

getDescription

getXssDescription

getId

getIsEditMode

getIsRepeatable

getItems

getPath

getResourceType

getResourceSuperType

getLayoutPath

isLayoutNavigable

isMenuRequired

isDocumentFragmentGroup

getLayoutProperty

getToolbarPosition

getAddMessage

getRemoveMessage

getNavTitle

getIsTitleRichText

getTitle

getSlingRequest

getNodeClass

getVisibleExp

getXssapi

getCssClassName

externalize

externalize

getError

getBindRef

isValid

syncNode

validate

isValidDorTemplateRef

getClientLibRef

setClientLibRef

getEnabled

getVisible