com.adobe.aemds.guide.common

Class GuideCheckBox

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.GuideCheckBox

All Implemented Interfaces:

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

Direct Known Subclasses:

GuideRadioButton

public class GuideCheckBox
extends GuideField

GuideCheckBox encapsulates basic properties of the adaptive forms Check Box Component. Few are listed below:

• Options of the check box configured during authoring
• Alignment of the check box 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
GuideCheckBox()

Method Summary

Modifier and Type	Method and Description
String	getAlignment() Returns the alignment of the check box Component configured in authoring dialog
Boolean	getAreOptionsRichText()
String	getGuideFieldType() Returns the field type of the AEM Forms Component
String	getInputType() Returns type of HTML input element to be used
String	getItemClassName() Return the name of class that should be applied to checkbox item if the type of appearance is checkbox
String	getItemsClass() Returns the class based on appearance type that should be applied on the group of check box items
String	getLabelForId() Returns id for field label association, for accessibility
Map	getOptions() Returns the options configured for the check box component during authoring
List	getValues() Returns the values of options present in the checkbox component.

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

getAutocomplete, getAutofillFieldKeyword, getCaptionInlineStyles, getDescriptionVisibility, getErrorSimulatorString, getFieldLayout, getFieldLayoutName, getHelpIndicatorContent, getHideTitle, getIsOldFieldLayout, getIsReadOnly, getIsRequired, 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

GuideCheckBox

public GuideCheckBox()

Method Detail

getLabelForId

public String getLabelForId()
                     throws javax.jcr.RepositoryException

Description copied from class: GuideField

Returns id for field label association, for accessibility

Overrides:

getLabelForId in class GuideField

Returns:

String Id for field label association

Throws:

javax.jcr.RepositoryException

getOptions

public Map getOptions()

Returns the options configured for the check box component during authoring

Returns:

Map whose keys are the option values and the values are the text of corresponding option.

getAreOptionsRichText

public Boolean getAreOptionsRichText()

getValues

public List getValues()

Returns the values of options present in the checkbox component.

Returns:

List representing the values of the options

getGuideFieldType

public String getGuideFieldType()

Returns the field type of the AEM Forms Component

Specified by:

getGuideFieldType in interface FDField

Overrides:

getGuideFieldType in class GuideNode

Returns:

String representing guide field type

getAlignment

public String getAlignment()

Returns the alignment of the check box Component configured in authoring dialog

Returns:

String representing alignment of the check box Component

getInputType

public String getInputType()

Returns type of HTML input element to be used

Returns:

GuideConstants.GUIDE_FIELD_CHECK_INPUT_TYPE

getItemClassName

public String getItemClassName()

Return the name of class that should be applied to checkbox item if the type of appearance is checkbox

Returns:

GuideConstants.GUIDE_FIELD_CHECKBOX_ITEM

getItemsClass

public String getItemsClass()

Returns the class based on appearance type that should be applied on the group of check box items

Returns:

GuideConstants.GUIDE_FIELD_CHECKBOXGROUP_ITEMS