Package com.adobe.acs.commons.mcp.form

Class FieldComponent

java.lang.Object

com.adobe.acs.commons.mcp.form.FieldComponent

Direct Known Subclasses:

AbstractContainerComponent, AutocompleteComponent, ButtonComponent, CheckboxComponent, DatePickerComponent, FileUploadComponent, PasswordComponent, PathfieldComponent, RadioComponent, RichTextEditorComponent, SelectComponent, TagPickerComponent, TextfieldComponent

public abstract class FieldComponent
extends Object

Describes a component in a manner which supports auto-generated forms

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldComponent.ClientLibraryType

Constructor Summary

Constructors

Constructor	Description
FieldComponent()

Method Summary

Modifier and Type	Method	Description
void	addClientLibraries(FieldComponent component)
void	addClientLibraries(FieldComponent.ClientLibraryType type, String... categories)
void	addClientLibraries(FieldComponent.ClientLibraryType type, Collection<String> categories)
void	addClientLibrary(String category)
org.apache.sling.api.resource.Resource	buildComponentResource()	If your component needs child nodes then override this method, call the superclass implementation, and then use addChildren to add additional nodes to it.
AccessibleObject	getAccessibleObject()
Optional<Boolean>	getBooleanOption(String option)
String	getCategory()
Map<FieldComponent.ClientLibraryType,Set<String>>	getClientLibraryCategories()
org.apache.sling.api.resource.ResourceMetadata	getComponentMetadata()
Field	getField()	Deprecated. Use getAccessibleObject and AccessibleObjectUtils to handle both Method (getter) or Fields
FormField	getFieldDefinition()
org.apache.sling.api.scripting.SlingScriptHelper	getHelper()
String	getHtml()
String	getName()
Optional<String>	getOption(String option)
Collection<String>	getOptionNames()
String	getPath()
String	getResourceSuperType()
String	getResourceType()
boolean	hasOption(String optionName)
abstract void	init()
void	purgeEmptyMetadata()
void	setCategory(String category)
void	setHelper(org.apache.sling.api.scripting.SlingScriptHelper helper)
void	setPath(String path)
void	setResourceSuperType(String resourceSuperType)
void	setResourceType(String resourceType)
void	setup(String name, AccessibleObject fieldOrMethod, FormField field, org.apache.sling.api.scripting.SlingScriptHelper sling)

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldComponent

public FieldComponent()

Method Detail

setup

public final void setup(String name,
                        AccessibleObject fieldOrMethod,
                        FormField field,
                        org.apache.sling.api.scripting.SlingScriptHelper sling)

init

public abstract void init()

setHelper

public final void setHelper(org.apache.sling.api.scripting.SlingScriptHelper helper)

getHelper

public final org.apache.sling.api.scripting.SlingScriptHelper getHelper()

setPath

public final void setPath(String path)

getPath

public final String getPath()

getField

@Deprecated
public final Field getField()

Deprecated.

Use getAccessibleObject and AccessibleObjectUtils to handle both Method (getter) or Fields

Get form field if possible

Returns:

Form field if a safe cast is possible otherwise null

getAccessibleObject

public final AccessibleObject getAccessibleObject()

getFieldDefinition

public final FormField getFieldDefinition()

getHtml

public final String getHtml()

buildComponentResource

public org.apache.sling.api.resource.Resource buildComponentResource()

If your component needs child nodes then override this method, call the superclass implementation, and then use addChildren to add additional nodes to it.

Returns:

getComponentMetadata

public final org.apache.sling.api.resource.ResourceMetadata getComponentMetadata()

Returns:

the componentMetadata

getClientLibraryCategories

public final Map<FieldComponent.ClientLibraryType,Set<String>> getClientLibraryCategories()

addClientLibrary

public final void addClientLibrary(String category)

addClientLibraries

public final void addClientLibraries(FieldComponent.ClientLibraryType type,
                                     String... categories)

addClientLibraries

public final void addClientLibraries(FieldComponent.ClientLibraryType type,
                                     Collection<String> categories)

addClientLibraries

public final void addClientLibraries(FieldComponent component)

getResourceType

public final String getResourceType()

Returns:

the resourceType

setResourceType

public final void setResourceType(String resourceType)

Parameters:

resourceType - the resourceType to set

getResourceSuperType

public final String getResourceSuperType()

Returns:

the resourceSuperType

setResourceSuperType

public final void setResourceSuperType(String resourceSuperType)

Parameters:

resourceSuperType - the resourceSuperType to set

purgeEmptyMetadata

public final void purgeEmptyMetadata()

getName

public final String getName()

Returns:

the name

getOptionNames

public final Collection<String> getOptionNames()

hasOption

public final boolean hasOption(String optionName)

getOption

public final Optional<String> getOption(String option)

getBooleanOption

public final Optional<Boolean> getBooleanOption(String option)

getCategory

public final String getCategory()

Returns:

the category

setCategory

public final void setCategory(String category)

Parameters:

category - the category to set