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

Class FormComponent

java.lang.Object

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

com.adobe.acs.commons.mcp.form.AbstractContainerComponent

com.adobe.acs.commons.mcp.form.FormComponent

@ProviderType
public final class FormComponent
extends AbstractContainerComponent

Represent a form

Nested Class Summary

Nested classes/interfaces inherited from class com.adobe.acs.commons.mcp.form.FieldComponent

FieldComponent.ClientLibraryType

Constructor Summary

Constructors

Constructor	Description
FormComponent()

Method Summary

Modifier and Type	Method	Description
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.
String	getAction()
String	getAutocomplete()
String	getDataPath()
String	getEnctype()
String	getMethod()
String	getNameNotFoundMode()
String	getStyle()
String	getTarget()
String	getUi()
boolean	hasCategories(Collection<FieldComponent> values)
void	init()
boolean	isAsync()
boolean	isAutosubmitForm()
boolean	isFoundationForm()
boolean	isLoadingMask()
boolean	isMargin()
boolean	isMaximized()
boolean	isNovalidate()
boolean	isSuccessresponse()
void	setAction(String action)
void	setAsync(boolean async)
void	setAutocomplete(String autocomplete)
void	setAutosubmitForm(boolean autosubmitForm)
void	setDataPath(String dataPath)
void	setEnctype(String enctype)
void	setFoundationForm(boolean foundationForm)
void	setLoadingMask(boolean loadingMask)
void	setMargin(boolean margin)
void	setMaximized(boolean maximized)
void	setMethod(String method)
void	setNameNotFoundMode(String nameNotFoundMode)
void	setNovalidate(boolean novalidate)
void	setStyle(String style)
void	setSuccessresponse(boolean successresponse)
void	setTarget(String target)
void	setUi(String ui)

Methods inherited from class com.adobe.acs.commons.mcp.form.AbstractContainerComponent

addComponent, applyDialogProviderSettings, generateDefaultChildComponent, generateItemsResource, getDialogStyle, getFieldComponents, getGroupingContainer, getPropertiesTabName, isComposite, isForceDotSlashPrefix, setComposite, setDefaultChildComponent, setDialogStyle, setForceDotSlashPrefix, setGroupingContainer, setPropertiesTabName

Methods inherited from class com.adobe.acs.commons.mcp.form.FieldComponent

addClientLibraries, addClientLibraries, addClientLibraries, addClientLibrary, getAccessibleObject, getBooleanOption, getCategory, getClientLibraryCategories, getComponentMetadata, getField, getFieldDefinition, getHelper, getHtml, getName, getOption, getOptionNames, getPath, getResourceSuperType, getResourceType, hasOption, purgeEmptyMetadata, setCategory, setHelper, setPath, setResourceSuperType, setResourceType, setup

Methods inherited from class java.lang.Object

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

Constructor Detail

FormComponent

public FormComponent()

Method Detail

init

public void init()

Overrides:

init in class AbstractContainerComponent

buildComponentResource

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

Description copied from class: FieldComponent

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

Overrides:

buildComponentResource in class FieldComponent

Returns:

hasCategories

public boolean hasCategories(Collection<FieldComponent> values)

Overrides:

hasCategories in class AbstractContainerComponent

getMethod

public String getMethod()

Returns:

the method

setMethod

public final void setMethod(String method)

Parameters:

method - the method to set

getAction

public String getAction()

Returns:

the action

setAction

public final void setAction(String action)

Parameters:

action - the action to set

getEnctype

public String getEnctype()

Returns:

the enctype

setEnctype

public final void setEnctype(String enctype)

Parameters:

enctype - the enctype to set

getTarget

public String getTarget()

Returns:

the target

setTarget

public final void setTarget(String target)

Parameters:

target - the target to set

getAutocomplete

public String getAutocomplete()

Returns:

the autocomplete

setAutocomplete

public final void setAutocomplete(String autocomplete)

Parameters:

autocomplete - the autocomplete to set

isNovalidate

public boolean isNovalidate()

Returns:

the novalidate

setNovalidate

public final void setNovalidate(boolean novalidate)

Parameters:

novalidate - the novalidate to set

getDataPath

public String getDataPath()

Returns:

the dataPath

setDataPath

public final void setDataPath(String dataPath)

Parameters:

dataPath - the dataPath to set

getNameNotFoundMode

public String getNameNotFoundMode()

Returns:

the nameNotFoundMode

setNameNotFoundMode

public final void setNameNotFoundMode(String nameNotFoundMode)

Parameters:

nameNotFoundMode - the nameNotFoundMode to set

isAutosubmitForm

public boolean isAutosubmitForm()

Returns:

the autosubmitForm

setAutosubmitForm

public final void setAutosubmitForm(boolean autosubmitForm)

Parameters:

autosubmitForm - the autosubmitForm to set

isMargin

public boolean isMargin()

Returns:

the margin

setMargin

public final void setMargin(boolean margin)

Parameters:

margin - the margin to set

isMaximized

public boolean isMaximized()

Returns:

the maximized

setMaximized

public final void setMaximized(boolean maximized)

Parameters:

maximized - the maximized to set

isFoundationForm

public boolean isFoundationForm()

Returns:

the foundationForm

setFoundationForm

public final void setFoundationForm(boolean foundationForm)

Parameters:

foundationForm - the foundationForm to set

isAsync

public boolean isAsync()

Returns:

the async

setAsync

public final void setAsync(boolean async)

Parameters:

async - the async to set

isLoadingMask

public boolean isLoadingMask()

Returns:

the loadingMask

setLoadingMask

public final void setLoadingMask(boolean loadingMask)

Parameters:

loadingMask - the loadingMask to set

getUi

public String getUi()

Returns:

the ui

setUi

public final void setUi(String ui)

Parameters:

ui - the ui to set

isSuccessresponse

public boolean isSuccessresponse()

Returns:

the successresponse

setSuccessresponse

public final void setSuccessresponse(boolean successresponse)

Parameters:

successresponse - the successresponse to set

getStyle

public String getStyle()

Returns:

the style

setStyle

public void setStyle(String style)

Parameters:

style - the style to set