GuideField (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.GuideField

All Implemented Interfaces:

FDField, StyledFDField, java.io.Serializable, Use

Direct Known Subclasses:

GuideButton, GuideCaptcha, GuideChart, GuideCheckBox, GuideDatePicker, GuideDropDownList, GuideFileUpload, GuideImage, GuideNumericBox, GuidePasswordBox, GuideScribble, GuideSeparator, GuideSwitch, GuideTermsAndConditions, GuideTextBox, GuideTextDraw
```
public abstract class GuideField
extends GuideNode
```
GuideField is a base class from which every AEM form field component inherits from. It abstracts the basic properties of a field. Few are:
- Hiding the title of the field
- Short Description of the field
- Long description
This provides basic getter's and setter's required to create/initialize an AEM Form Field Component.
Since:

AEM 6.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

GuideField()

Constructors
Constructor and Description
`GuideField()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,java.lang.Object>`	`getAuthoringConfig()` Gives the authoring configuration of the guide field component
`java.lang.Boolean`	`getAutocomplete()` Returns the value of autocomplete
`java.lang.String`	`getAutofillFieldKeyword()` Returns the value of autofill field keyword
`java.lang.String`	`getCaptionInlineStyles()` Returns the string containing the inline style specified for the caption
`java.lang.Boolean`	`getDescriptionVisibility()` Returns the visibility of the short description as specified in the Authoring Dialog
`java.lang.String`	`getErrorSimulatorString()` Returns the error simulation string to be shown in Authoring for styling purposes
`java.lang.String`	`getFieldLayout()` Returns the field layout configured during authoring.
`java.lang.String`	`getFieldLayoutName()` Returns the name of the field layout
`java.lang.String`	`getHelpIndicatorContent()` Returns the help content for field
`boolean`	`getHideTitle()` Returns if the current field's title is hidden or not
`boolean`	`getIsOldFieldLayout()`
`java.lang.Boolean`	`getIsReadOnly()`
`java.lang.Boolean`	`getIsRequired()`
`java.lang.String`	`getLabelForId()` Returns id for field label association, for accessibility
`java.lang.String`	`getLongDescription()` Returns the long description of the field configured in authoring dialog
`java.lang.String`	`getPlaceholderText()` Returns the placeholder text set in the authoring dialog
`java.lang.String`	`getShortDescription()` Returns the short description of the field configured in the authoring dialog
`java.lang.String`	`getShortDescriptionInlineStyles()` Returns the string containing the inline style specified for the short description
`java.lang.String`	`getValue()` Returns the initial value of the field set in the authoring dialog
`java.lang.String`	`getWidgetInlineStyles()` Returns the string containing the inline style specified for the widget
`boolean`	`isMandatory()` Return if the field is marked as required.
`void`	`setHelpIndicatorContent(java.lang.String helpQuestionMarkContent)` Sets the help indicator content for the field.

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, getIsRepeatable, getItems, 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, setSlingRequest, 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
  - GuideField
```
public GuideField()
```
- Method Detail
  - getIsRequired
```
public java.lang.Boolean getIsRequired()
```
  - getIsReadOnly
```
public java.lang.Boolean getIsReadOnly()
```
  - getLabelForId
```
public java.lang.String getLabelForId()
                               throws RepositoryException
```
    Returns id for field label association, for accessibility
    
    Returns:
    
    String Id for field label association
    
    Throws:
    
    RepositoryException
  - getAutofillFieldKeyword
```
public java.lang.String getAutofillFieldKeyword()
```
    Returns the value of autofill field keyword
    
    Returns:
    
    String representing autofill field keyword value
  - getAutocomplete
```
public java.lang.Boolean getAutocomplete()
```
    Returns the value of autocomplete
    
    Returns:
    
    Boolean representing autocomplete value
  - getIsOldFieldLayout
```
public boolean getIsOldFieldLayout()
```
  - getFieldLayout
```
public java.lang.String getFieldLayout()
```
    Returns the field layout configured during authoring. If field layout is specified at field level, it takes priority, else field layout configured in adaptive form container is honored.
    
    Returns:
    
    path of the field layout
  - getFieldLayoutName
```
public java.lang.String getFieldLayoutName()
```
    Returns the name of the field layout
    
    Returns:
    
    name of the field layout configured
  - getHideTitle
```
public boolean getHideTitle()
```
    Returns if the current field's title is hidden or not
    
    Returns:
    
    boolean indicating if title is hidden or not
  - getShortDescription
```
public java.lang.String getShortDescription()
```
    Returns the short description of the field configured in the authoring dialog
    
    Returns:
    
    string representing the short description of the field
  - getLongDescription
```
public java.lang.String getLongDescription()
```
    Returns the long description of the field configured in authoring dialog
    
    Returns:
    
    String representing the long description
  - getDescriptionVisibility
```
public java.lang.Boolean getDescriptionVisibility()
```
    Returns the visibility of the short description as specified in the Authoring Dialog
    
    Returns:
    
    true if "Always show short Description" is selected otherwise false
  - getValue
```
public java.lang.String getValue()
```
    Returns the initial value of the field set in the authoring dialog
    
    Returns:
    
    String representing the default value
  - getCaptionInlineStyles
```
public java.lang.String getCaptionInlineStyles()
```
    Returns the string containing the inline style specified for the caption
    
    Returns:
    
    inline style of the caption
  - getWidgetInlineStyles
```
public java.lang.String getWidgetInlineStyles()
```
    Returns the string containing the inline style specified for the widget
    
    Returns:
    
    inline style of the widget
  - setHelpIndicatorContent
```
public void setHelpIndicatorContent(java.lang.String helpQuestionMarkContent)
```
    Sets the help indicator content for the field. By default the indicator is represented as a "?", but can be changed through this API.
    
    Parameters:
    
    helpQuestionMarkContent - string representing the help question mark content
  - getHelpIndicatorContent
```
public java.lang.String getHelpIndicatorContent()
```
    Returns the help content for field
    
    Returns:
    
    question mark content of the help
  - getShortDescriptionInlineStyles
```
public java.lang.String getShortDescriptionInlineStyles()
```
    Returns the string containing the inline style specified for the short description
    
    Returns:
    
    inline style of the short description
  - getPlaceholderText
```
public java.lang.String getPlaceholderText()
```
    Returns the placeholder text set in the authoring dialog
    
    Returns:
    
    place holder text set for the field
  - getErrorSimulatorString
```
public java.lang.String getErrorSimulatorString()
```
    Returns the error simulation string to be shown in Authoring for styling purposes
    
    Returns:
    
    error simulation string for a given field
  - isMandatory
```
public boolean isMandatory()
```
    Return if the field is marked as required.
    
    Returns:
    
    true if field is configured as mandatory, false otherwise
  - getAuthoringConfig
```
public java.util.Map<java.lang.String,java.lang.Object> getAuthoringConfig()
```
    Gives the authoring configuration of the guide field component
    
    Overrides:
    
    getAuthoringConfig in class GuideNode
    
    Returns:
    
    authoring config of guide field component

Class GuideField

Constructor Summary

Method Summary

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

GuideField

Method Detail

getIsRequired

getIsReadOnly

getLabelForId

getAutofillFieldKeyword

getAutocomplete

getIsOldFieldLayout

getFieldLayout

getFieldLayoutName

getHideTitle

getShortDescription

getLongDescription

getDescriptionVisibility

getValue

getCaptionInlineStyles

getWidgetInlineStyles

setHelpIndicatorContent

getHelpIndicatorContent

getShortDescriptionInlineStyles

getPlaceholderText

getErrorSimulatorString

isMandatory

getAuthoringConfig