Package com.adobe.cq.forms.core.components.util

Class AbstractFormComponentImpl

java.lang.Object

com.adobe.cq.forms.core.components.util.AbstractComponentImpl

com.adobe.cq.forms.core.components.util.AbstractFormComponentImpl

All Implemented Interfaces:

com.adobe.cq.export.json.ComponentExporter, FormComponent, Component

Direct Known Subclasses:

AbstractBaseImpl

public class AbstractFormComponentImpl
extends AbstractComponentImpl
implements FormComponent

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CUSTOM_DOR_PROPERTY_WRAPPER
static java.lang.String	CUSTOM_JCR_PATH_PROPERTY_WRAPPER
static java.lang.String	CUSTOM_RULE_PROPERTY_WRAPPER

Fields inherited from interface com.adobe.cq.wcm.core.components.models.Component

PN_ID

Fields inherited from interface com.adobe.cq.forms.core.components.models.form.FormComponent

CUSTOM_PROPERTY_WRAPPER

Constructor Summary

Constructors

Constructor	Description
AbstractFormComponentImpl()

Method Summary

Modifier and Type	Method	Description
@NotNull java.util.Map<java.lang.String,java.lang.Object>	getCustomLayoutProperties()
@Nullable FormComponentData	getData()	See Component.getData()
@Nullable java.lang.String	getDataRef()	Returns the reference to the data model
java.lang.String	getDescription()
java.util.Map<java.lang.String,java.lang.Object>	getDorProperties()	Custom DOR Properties
@NotNull java.util.Map<java.lang.String,java.lang.String[]>	getEvents()	Returns the events defined for the component after filtering out invalid rules
java.lang.String	getFieldType()	Returns the view type
Label	getLabel()
java.lang.String	getLinkUrl()
java.lang.String	getName()	Returns the name of the form field
java.lang.String	getPath()	Returns getPath of the form field
@NotNull java.util.Map<java.lang.String,java.lang.Object>	getProperties()	Custom Properties
@NotNull java.util.Map<java.lang.String,java.lang.String>	getRules()	Returns the rules defined for the component after filtering out invalid rules If no rules are defined, returns an empty map
java.lang.String	getText()
java.lang.String	getTitle()
BaseConstraint.Type	getType()
java.lang.Boolean	getVisibleIfPresent()
@Nullable java.lang.Boolean	isVisible()	Returns true if form field should be visible, otherwise false.
void	setI18n(com.day.cq.i18n.I18n i18n)	Sets i18n object

Methods inherited from class com.adobe.cq.forms.core.components.util.AbstractComponentImpl

getAppliedCssClasses, getExportedType, getId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adobe.cq.wcm.core.components.models.Component

getAppliedCssClasses, getExportedType, getId

Field Detail

CUSTOM_DOR_PROPERTY_WRAPPER

public static final java.lang.String CUSTOM_DOR_PROPERTY_WRAPPER

See Also:

Constant Field Values

CUSTOM_JCR_PATH_PROPERTY_WRAPPER

public static final java.lang.String CUSTOM_JCR_PATH_PROPERTY_WRAPPER

See Also:

Constant Field Values

CUSTOM_RULE_PROPERTY_WRAPPER

public static final java.lang.String CUSTOM_RULE_PROPERTY_WRAPPER

See Also:

Constant Field Values

Constructor Detail

AbstractFormComponentImpl

public AbstractFormComponentImpl()

Method Detail

setI18n

public void setI18n(@Nonnull
                    com.day.cq.i18n.I18n i18n)

Description copied from interface: FormComponent

Sets i18n object

Specified by:

setI18n in interface FormComponent

Parameters:

i18n - reference to the I18n object

getType

public BaseConstraint.Type getType()

getLabel

public Label getLabel()

getDescription

public java.lang.String getDescription()

getLinkUrl

public java.lang.String getLinkUrl()

getTitle

public java.lang.String getTitle()

getText

public java.lang.String getText()

getName

public java.lang.String getName()

Returns the name of the form field

Specified by:

getName in interface FormComponent

Returns:

name of the form field

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

getFieldType

public java.lang.String getFieldType()

Returns the view type

Specified by:

getFieldType in interface FormComponent

Returns:

the view type

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

isVisible

@Nullable
public @Nullable java.lang.Boolean isVisible()

Returns true if form field should be visible, otherwise false.

Specified by:

isVisible in interface FormComponent

Returns:

true if form field should be visible, otherwise false

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

getVisibleIfPresent

public java.lang.Boolean getVisibleIfPresent()

getCustomLayoutProperties

@NotNull
public @NotNull java.util.Map<java.lang.String,java.lang.Object> getCustomLayoutProperties()

getProperties

@NotNull
public @NotNull java.util.Map<java.lang.String,java.lang.Object> getProperties()

Description copied from interface: FormComponent

Custom Properties

Specified by:

getProperties in interface FormComponent

getRules

@NotNull
public @NotNull java.util.Map<java.lang.String,java.lang.String> getRules()

Description copied from interface: FormComponent

Returns the rules defined for the component after filtering out invalid rules If no rules are defined, returns an empty map

Specified by:

getRules in interface FormComponent

Returns:

map containing the rules and their expressions

getEvents

@NotNull
public @NotNull java.util.Map<java.lang.String,java.lang.String[]> getEvents()

Description copied from interface: FormComponent

Returns the events defined for the component after filtering out invalid rules

Specified by:

getEvents in interface FormComponent

Returns:

map containing the events and their expressions If no rules are defined, returns an empty map

getDataRef

@Nullable
public @Nullable java.lang.String getDataRef()

Returns the reference to the data model

Specified by:

getDataRef in interface FormComponent

Returns:

reference to the data model

Since:

com.adobe.cq.forms.core.components.models.form 0.0.1

getPath

public java.lang.String getPath()

Returns getPath of the form field

Specified by:

getPath in interface FormComponent

Returns:

getPath of the field

Since:

com.adobe.cq.forms.core.components.util 3.1.0

getData

@Nullable
public @Nullable FormComponentData getData()

See Component.getData()

Specified by:

getData in interface Component

Overrides:

getData in class AbstractComponentImpl

Returns:

The component data

getDorProperties

public java.util.Map<java.lang.String,java.lang.Object> getDorProperties()

Description copied from interface: FormComponent

Custom DOR Properties

Specified by:

getDorProperties in interface FormComponent