com.adobe.aemds.guide.common

Class AbstractFDField

java.lang.Object

com.adobe.aemds.guide.common.AbstractFDField

All Implemented Interfaces:

FDField

Direct Known Subclasses:

AbstractStyledFDField

@ConsumerType
public abstract class AbstractFDField
extends Object
implements FDField

Abstract implementation of a forms and document field component

Field Summary

Fields

Modifier and Type	Field and Description
protected com.day.cq.i18n.I18n	i18n
protected org.apache.sling.api.resource.ValueMap	properties
protected org.apache.sling.api.resource.Resource	resource
protected org.apache.sling.api.SlingHttpServletRequest	slingRequest

Constructor Summary

Constructors

Constructor and Description
AbstractFDField()

Method Summary

Modifier and Type	Method and Description
protected String	externalize(String value, String key) Externalizes/Localizes the given key
String	getDescription()
String	getGuideFieldType()
String	getId()
String	getName()
String	getPath()
String	getTitle()

Methods inherited from interface com.adobe.aemds.guide.common.FDField

getAuthoringConfigJSON

Field Detail

slingRequest

protected org.apache.sling.api.SlingHttpServletRequest slingRequest

resource

protected org.apache.sling.api.resource.Resource resource

properties

protected org.apache.sling.api.resource.ValueMap properties

i18n

protected com.day.cq.i18n.I18n i18n

Constructor Detail

AbstractFDField

public AbstractFDField()

Method Detail

getTitle

@Nonnull
public String getTitle()

Specified by:

getTitle in interface FDField

Returns:

Returns the title of the component.

getPath

@Nonnull
public String getPath()

Specified by:

getPath in interface FDField

Returns:

Returns the path of the component.

getName

@Nonnull
public String getName()

Specified by:

getName in interface FDField

Returns:

Returns the name of the component

getDescription

@Nullable
public String getDescription()

Specified by:

getDescription in interface FDField

Returns:

Returns the description of the component

getId

@Nonnull
public String getId()

Specified by:

getId in interface FDField

Returns:

Returns the id of the component.

getGuideFieldType

@Nonnull
public String getGuideFieldType()

Specified by:

getGuideFieldType in interface FDField

Returns:

Returns the type of the forms and documents component

externalize

@Nullable
protected String externalize(@Nonnull
                                       String value,
                                       String key)

Externalizes/Localizes the given key

Parameters:

key - key to externalized

Returns:

externalized string