Package 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
,java.io.Serializable
,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
-
-
Constructor Summary
Constructors Constructor Description GuideDropDownList()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getGuideFieldType()
Returns the field type of the Adaptive Forms Componentboolean
getIsFirstOptGroup()
Returns if the optgroup is First optgroup of the dropdown list or not.java.lang.Boolean
getIsMultiSelect()
Returns whether the dropdown allows multiple selection or notjava.util.Map
getOptions()
Returns the options configured for the dropdown list component during authoringjava.util.List
getValues()
Returns the values of options present in the dropdown component.static boolean
isKeyAnOptGroup(java.lang.String key)
Returns if the key is identified as an OptGroup or just option.-
Methods inherited from class com.adobe.aemds.guide.common.GuideField
getAuthoringConfig, 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, checkIfPathIsAbsolute, externalize, getAddMessage, getAppearance, getAuthoringConfigJSON, getBindRef, getClientLibRef, getColspan, getCssClassName, getDescription, getEnabled, getEnabledExp, getError, getFieldInlineStyles, getHeight, getI18n, getId, getInlineCssClass, getInlineStyles, getIsEditMode, getIsRepeatable, getItems, getLayoutPath, getLayoutTabType, getLongDescriptionInlineStyles, getName, getNavTitle, getNodeClass, getNonNavigableProperty, getPath, getQuestionMarkInlineStyles, getRemoveMessage, getResourceSuperType, getResourceType, getResponsiveClasses, getSlingRequest, getStyles, getTargetVersion, getTitle, getToolbarPosition, getVersion, getVisible, getVisibleExp, getWidth, getXssapi, getXssDescription, isDocumentFragmentGroup, isLayoutNavigable, isMenuRequired, isValid, isValidDorTemplateRef, setClientLibRef, setResource, setSlingRequest, syncNode, validate
-
Methods inherited from class com.adobe.cq.sightly.WCMUsePojo
get, getComponent, getComponentContext, getCurrentDesign, getCurrentPage, getCurrentStyle, getDesigner, getEditContext, getInheritedProperties, getPageManager, getPageProperties, getProperties, getRequest, getResource, getResourceDesign, getResourcePage, getResourceResolver, getResponse, getSlingScriptHelper, getWcmMode, getXSSAPI, init
-
-
-
-
Method Detail
-
getOptions
public java.util.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 java.util.List getValues()
Returns the values of options present in the dropdown component.- Returns:
- List representing the values of the options
-
getIsMultiSelect
public java.lang.Boolean getIsMultiSelect()
Returns whether the dropdown allows multiple selection or not- Returns:
- boolean indicating if multiple selection is allowed or not
-
getGuideFieldType
public java.lang.String getGuideFieldType()
Returns the field type of the Adaptive Forms Component- Specified by:
getGuideFieldType
in interfaceFDField
- Overrides:
getGuideFieldType
in classGuideNode
- 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(java.lang.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
-
-