com.adobe.aemds.guide.common

Class GuideDropDownList

java.lang.Object

com.adobe.cq.sightly.WCMUsePojo

com.adobe.aemds.guide.common.GuideNode

com.adobe.aemds.guide.common.GuideField

com.adobe.aemds.guide.common.GuideDropDownList

All Implemented Interfaces:

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

public class GuideDropDownList
extends GuideField

GuideDropDownList encapsulates basic properties of the Adaptive Forms Drop Down Component. Few are listed below:

• Options of the dropdown configured during authoring
• multiple selection checkbox configured during authoring

Since:

6.0

See Also:

Serialized Form

Field Summary

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

helpQuestionMarkContent

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
GuideDropDownList()

Method Summary

Modifier and Type	Method and Description
String	getGuideFieldType() Returns the field type of the Adaptive Forms Component
boolean	getIsFirstOptGroup() Returns if the optgroup is First optgroup of the dropdown list or not.
Boolean	getIsMultiSelect() Returns whether the dropdown allows multiple selection or not
Map	getOptions() Returns the options configured for the dropdown list component during authoring
List	getValues() Returns the values of options present in the dropdown component.
static boolean	isKeyAnOptGroup(String key) Returns if the key is identified as an OptGroup or just option.

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

getAutocomplete, getAutofillFieldKeyword, getCaptionInlineStyles, getDescriptionVisibility, getErrorSimulatorString, getFieldLayout, getFieldLayoutName, getHelpIndicatorContent, getHideTitle, getIsOldFieldLayout, getIsReadOnly, getIsRequired, getLabelForId, getLongDescription, getPlaceholderText, getShortDescription, getShortDescriptionInlineStyles, getValue, getWidgetInlineStyles, isMandatory, setHelpIndicatorContent

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, getHeight, getId, getInlineCssClass, getInlineStyles, getIsEditMode, getIsRepeatable, getIsTitleRichText, getItems, 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, validate

Constructor Detail

GuideDropDownList

public GuideDropDownList()

Method Detail

getOptions

public Map getOptions()

Returns the options configured for the dropdown list component during authoring

Returns:

Map Map where keys are the values of the options in the dropdown list and the values in the map are the text of corresponding option.

getValues

public List getValues()

Returns the values of options present in the dropdown component.

Returns:

List representing the values of the options

getIsMultiSelect

public Boolean getIsMultiSelect()

Returns whether the dropdown allows multiple selection or not

Returns:

boolean indicating if multiple selection is allowed or not

getGuideFieldType

public String getGuideFieldType()

Returns the field type of the Adaptive Forms Component

Specified by:

getGuideFieldType in interface FDField

Overrides:

getGuideFieldType in class GuideNode

Returns:

String representing guide field type

getIsFirstOptGroup

public boolean getIsFirstOptGroup()

Returns if the optgroup is First optgroup of the dropdown list or not.

Returns:

true if opt group is configured in drop down list else false

isKeyAnOptGroup

public static boolean isKeyAnOptGroup(String key)

Returns if the key is identified as an OptGroup or just option.

Parameters:

key -

Returns:

true if key is identified as opt group else false