Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
I
L
M
N
O
P
R
S
T
U
V
A
AbstractEMailFormProcessor
- Class in
info.magnolia.module.form.processors
Base implementation for FormProcessors that send mail.
AbstractEMailFormProcessor()
- Constructor for class info.magnolia.module.form.processors.
AbstractEMailFormProcessor
AbstractFormEngine
- Class in
info.magnolia.module.form.templates.components
Implements common functionality used by both the first step and subsequent steps.
AbstractFormEngine(Node, FormParagraph, RenderingContext)
- Constructor for class info.magnolia.module.form.templates.components.
AbstractFormEngine
AbstractFormModel
<
RD
extends info.magnolia.rendering.template.RenderableDefinition> - Class in
info.magnolia.module.form.templates.components
Implements typical behavior in extensions points for classes that use FormEngine.
AbstractFormModel(Node, RD, RenderingModel<?>, TemplatingFunctions)
- Constructor for class info.magnolia.module.form.templates.components.
AbstractFormModel
AbstractFormProcessor
- Class in
info.magnolia.module.form.processors
Abstract base class for FormProcessors that want support for enabling/disabling.
AbstractFormProcessor()
- Constructor for class info.magnolia.module.form.processors.
AbstractFormProcessor
add(FormField)
- Method in class info.magnolia.module.form.engine.
FormStepState
addFormProcessor(FormProcessor)
- Method in class info.magnolia.module.form.templates.components.
FormParagraph
addStep(FormStepState)
- Method in class info.magnolia.module.form.engine.
FormState
addValidators(Validator)
- Method in class info.magnolia.module.form.
FormModule
advanceIteratorTilAfter(Iterator<Node>, Node)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
B
bindAndValidate(Node)
- Method in interface info.magnolia.module.form.engine.
FormDataBinder
bindAndValidate(Node)
- Method in class info.magnolia.module.form.templates.components.
DefaultFormDataBinder
bindAndValidateFields(Iterator<Node>, FormStepState)
- Method in class info.magnolia.module.form.templates.components.
DefaultFormDataBinder
C
ConditionControl
- Class in
info.magnolia.module.form.controls
Multi control for specifying feeds and optional titles.
ConditionControl()
- Constructor for class info.magnolia.module.form.controls.
ConditionControl
context
- Variable in class info.magnolia.module.form.engine.
FormEngine
createAndSetFormState()
- Method in class info.magnolia.module.form.engine.
FormEngine
createAndSetFormState()
- Static method in class info.magnolia.module.form.engine.
FormStateUtil
createFormEngine()
- Method in class info.magnolia.module.form.templates.components.
AbstractFormModel
createFormEngine()
- Method in class info.magnolia.module.form.templates.components.
FormModel
createFormEngine()
- Method in class info.magnolia.module.form.templates.components.
SubStepFormModel
createFormSummaryBean(FormStepState)
- Method in class info.magnolia.module.form.templates.components.
FormSummaryModel
CriteriaControl
- Class in
info.magnolia.module.form.controls
Deprecated.
since 1.3.1 use ConditionControl instead.
CriteriaControl()
- Constructor for class info.magnolia.module.form.controls.
CriteriaControl
Deprecated.
D
DefaultFormDataBinder
- Class in
info.magnolia.module.form.templates.components
Default
FormDataBinder
that performs binding and validation for the built-in fields.
DefaultFormDataBinder()
- Constructor for class info.magnolia.module.form.templates.components.
DefaultFormDataBinder
destroyFormState()
- Method in class info.magnolia.module.form.engine.
FormEngine
destroyFormState(FormState)
- Static method in class info.magnolia.module.form.engine.
FormStateUtil
DialogRadioSwitch
- Class in
info.magnolia.module.form.dialogs
This dialog will switch between edit or fckEdit control depending on the mail contenttype selected.
DialogRadioSwitch()
- Constructor for class info.magnolia.module.form.dialogs.
DialogRadioSwitch
DialogStaticWithFormParams
- Class in
info.magnolia.module.form.dialogs
static field that will display all form params that can be used as freemarker params.
DialogStaticWithFormParams()
- Constructor for class info.magnolia.module.form.dialogs.
DialogStaticWithFormParams
drawHtml(Writer)
- Method in class info.magnolia.module.form.controls.
MultiControl
drawHtml(Writer)
- Method in class info.magnolia.module.form.dialogs.
DialogStaticWithFormParams
drawHtmlPreSubs(Writer)
- Method in class info.magnolia.module.form.dialogs.
DialogRadioSwitch
drawRadio(Writer)
- Method in class info.magnolia.module.form.dialogs.
DialogRadioSwitch
drawSubs(Writer)
- Method in class info.magnolia.module.form.dialogs.
DialogRadioSwitch
E
EndView
- Interface in
info.magnolia.module.form.engine
View interface implemented by views returned on submission that leaves the form.
ErrorView
- Class in
info.magnolia.module.form.templates.components
Common error view used when something unexpected happens.
ErrorView(String)
- Constructor for class info.magnolia.module.form.templates.components.
ErrorView
evaluateCondition(Node, Map<String, Object>, boolean)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
evaluateCondition(String, String, String, boolean)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
evaluateCriteria(Node, Map<String, Object>, boolean)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
Deprecated.
use evaluateCondition instead.
execute()
- Method in class info.magnolia.module.form.engine.
RedirectView
execute()
- Method in class info.magnolia.module.form.engine.
RedirectWithTokenAndParametersView
execute()
- Method in class info.magnolia.module.form.engine.
RedirectWithTokenView
execute()
- Method in interface info.magnolia.module.form.engine.
View
execute(InstallContext)
- Method in class info.magnolia.module.form.setup.
UpdateConfirmHtmlTypeToCodeTask
execute()
- Method in class info.magnolia.module.form.templates.components.
AbstractFormModel
execute()
- Method in class info.magnolia.module.form.templates.components.
ErrorView
execute()
- Method in class info.magnolia.module.form.templates.components.
FormFieldModel
execute()
- Method in class info.magnolia.module.form.templates.components.
FormView
execute()
- Method in class info.magnolia.module.form.templates.components.multistep.
GoToFirstPageView
execute()
- Method in class info.magnolia.module.form.templates.components.
SessionExpiredView
execute()
- Method in class info.magnolia.module.form.templates.components.
SuccessView
executeExtraMigrationTask(InstallContext)
- Method in class info.magnolia.module.form.setup.
FormMigrationTask
executeProcessors(Map<String, Object>)
- Method in class info.magnolia.module.form.engine.
FormEngine
executeProcessors(Map<String, Object>)
- Method in class info.magnolia.module.form.templates.components.
AbstractFormEngine
executeRenameAndChangeId(InstallContext)
- Method in class info.magnolia.module.form.setup.
FormMigrationTask
expression
- Variable in class info.magnolia.module.form.validators.
ValidateExpression
F
findAllFormControlNames(Node)
- Method in class info.magnolia.module.form.dialogs.
DialogStaticWithFormParams
findAndSetComplexControlLabels(Content, Map<String, Object>, Map<String, Object>, String)
- Method in class info.magnolia.module.form.templates.components.
FormSummaryModel
Controls like checkbox, select dont have title, need to find the label of the option/s selected.
findAndSetTemplateParameters(Content, Map<String, Object>, String, Map<String, Object>)
- Method in class info.magnolia.module.form.templates.components.
FormSummaryModel
findContentParagraphFields(Content)
- Method in class info.magnolia.module.form.templates.components.
FormSummaryModel
findFirstPageWithParagraphOfType(Iterator<Node>, Class<?>)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
findFormState()
- Method in class info.magnolia.module.form.templates.components.
FormSummaryModel
findNextPageBasedOnCondition(Iterator<Node>, Map<String, Object>)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
findNextPageBasedOnCriteria(Iterator<Node>, Map<String, Object>)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
Deprecated.
use findNextPageBasedOnCondition instead.
findParagraphOfType(Node, Class<?>)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
findParagraphParentPage(Node)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
FORM_TOKEN_PARAMETER_NAME
- Static variable in class info.magnolia.module.form.engine.
FormStateUtil
FormDataBinder
- Interface in
info.magnolia.module.form.engine
Performs binding and validation of submitted values.
FormEngine
- Class in
info.magnolia.module.form.engine
Implements a rendering and form submission algorithm that keeps state in session for multiple pages.
FormEngine(RenderingContext)
- Constructor for class info.magnolia.module.form.engine.
FormEngine
FormField
- Class in
info.magnolia.module.form.engine
Binding and validation result for a field.
FormField()
- Constructor for class info.magnolia.module.form.engine.
FormField
FormFieldModel
<
RD
extends info.magnolia.rendering.template.RenderableDefinition> - Class in
info.magnolia.module.form.templates.components
RenderingModel for form items.
FormFieldModel(Node, RD, RenderingModel<?>, TemplatingFunctions)
- Constructor for class info.magnolia.module.form.templates.components.
FormFieldModel
FormMigrationTask
- Class in
info.magnolia.module.form.setup
Custom Form Migration Task.
FormMigrationTask(String, String, String, boolean, List<String>)
- Constructor for class info.magnolia.module.form.setup.
FormMigrationTask
FormModel
- Class in
info.magnolia.module.form.templates.components
RenderingModel for a single page form.
FormModel(Node, RenderableDefinition, RenderingModel<?>, TemplatingFunctions)
- Constructor for class info.magnolia.module.form.templates.components.
FormModel
FormModule
- Class in
info.magnolia.module.form
Module class for the form module.
FormModule()
- Constructor for class info.magnolia.module.form.
FormModule
FormModuleVersionHandler
- Class in
info.magnolia.module.form.setup
VersionHandler for the form module.
FormModuleVersionHandler()
- Constructor for class info.magnolia.module.form.setup.
FormModuleVersionHandler
FormParagraph
- Class in
info.magnolia.module.form.templates.components
Paragraph customization for the form paragraph, enables configuration of FormProcessors and sub paragraphs.
FormParagraph()
- Constructor for class info.magnolia.module.form.templates.components.
FormParagraph
FormProcessor
- Interface in
info.magnolia.module.form.processors
Processes a submitted form.
FormProcessorFailedException
- Exception in
info.magnolia.module.form.processors
Exception thrown by FormProcessors when they encounter an error.
FormProcessorFailedException(String)
- Constructor for exception info.magnolia.module.form.processors.
FormProcessorFailedException
FormState
- Class in
info.magnolia.module.form.engine
State of an ongoing form execution.
FormState()
- Constructor for class info.magnolia.module.form.engine.
FormState
formState
- Variable in class info.magnolia.module.form.templates.components.
FormSummaryModel
FormStateTokenMissingException
- Exception in
info.magnolia.module.form.engine
Thrown when there's no form state token available in the request.
FormStateTokenMissingException()
- Constructor for exception info.magnolia.module.form.engine.
FormStateTokenMissingException
FormStateUtil
- Class in
info.magnolia.module.form.engine
Utility class for storing FormState in session and getting the form state token from a request.
FormStateUtil()
- Constructor for class info.magnolia.module.form.engine.
FormStateUtil
FormStepParagraph
- Class in
info.magnolia.module.form.templates.components
Paragraph for additional steps in a form.
FormStepParagraph()
- Constructor for class info.magnolia.module.form.templates.components.
FormStepParagraph
FormStepState
- Class in
info.magnolia.module.form.engine
Binding and validation state for a step.
FormStepState()
- Constructor for class info.magnolia.module.form.engine.
FormStepState
FormSummaryBean
- Class in
info.magnolia.module.form.templates.components
Bean used to display the parameters sent by the form.
FormSummaryBean()
- Constructor for class info.magnolia.module.form.templates.components.
FormSummaryBean
FormSummaryModel
<
RD
extends info.magnolia.rendering.template.RenderableDefinition> - Class in
info.magnolia.module.form.templates.components
Model for summary paragraph, displays a list of parameters submitted by the form.
FormSummaryModel(Node, RD, RenderingModel<?>, TemplatingFunctions, RenderingContext)
- Constructor for class info.magnolia.module.form.templates.components.
FormSummaryModel
FormView
- Class in
info.magnolia.module.form.templates.components
View for rendering the form.
FormView()
- Constructor for class info.magnolia.module.form.templates.components.
FormView
functions
- Variable in class info.magnolia.module.form.templates.components.
AbstractFormModel
functions
- Variable in class info.magnolia.module.form.templates.components.
FormFieldModel
functions
- Variable in class info.magnolia.module.form.templates.components.
FormSummaryModel
G
get(String)
- Method in class info.magnolia.module.form.engine.
FormStepState
getAddButton()
- Method in class info.magnolia.module.form.controls.
MultiControl
The button to add a new row.
getConditions()
- Method in class info.magnolia.module.form.controls.
ConditionControl
getConditions()
- Method in class info.magnolia.module.form.controls.
CriteriaControl
Deprecated.
getConfigurationNode()
- Method in class info.magnolia.module.form.templates.components.
AbstractFormEngine
getConfigurationParagraph()
- Method in class info.magnolia.module.form.templates.components.
AbstractFormEngine
getCurrentlyExecutingStep()
- Method in class info.magnolia.module.form.engine.
FormState
getDefaultPath()
- Static method in class info.magnolia.module.form.templates.components.
DefaultFormDataBinder
getDeleteButton()
- Method in class info.magnolia.module.form.controls.
MultiControl
Button for deleting a row.
getDisplayNavigation()
- Method in class info.magnolia.module.form.templates.components.
SubStepFormModel
getEmpty()
- Method in class info.magnolia.module.form.controls.
ConditionControl
getEmpty()
- Method in class info.magnolia.module.form.controls.
CriteriaControl
Deprecated.
getEmpty()
- Method in class info.magnolia.module.form.controls.
MultiControl
getErrorMessage()
- Method in class info.magnolia.module.form.engine.
FormField
getErrorMessage(String, Node)
- Method in class info.magnolia.module.form.templates.components.
DefaultFormDataBinder
getErrorMessage()
- Method in class info.magnolia.module.form.templates.components.
ErrorView
getErrorMessage()
- Method in class info.magnolia.module.form.validators.
ValidationResult
getErrorTitle()
- Method in class info.magnolia.module.form.templates.components.
FormView
getExpression()
- Method in class info.magnolia.module.form.validators.
ValidateExpression
getFields()
- Method in class info.magnolia.module.form.engine.
FormStepState
getFirstPage()
- Method in class info.magnolia.module.form.templates.components.multistep.
GoToFirstPageView
getFirstPage()
- Method in class info.magnolia.module.form.templates.components.
SessionExpiredView
getFormDataBinder()
- Method in class info.magnolia.module.form.engine.
FormEngine
getFormDataBinder()
- Method in class info.magnolia.module.form.templates.components.
AbstractFormEngine
getFormField(String)
- Method in class info.magnolia.module.form.templates.components.
AbstractFormModel
getFormProcessors()
- Method in class info.magnolia.module.form.templates.components.
FormParagraph
getFormState(String)
- Method in class info.magnolia.module.form.engine.
FormEngine
getFormState()
- Method in class info.magnolia.module.form.engine.
FormEngine
getFormState(String)
- Static method in class info.magnolia.module.form.engine.
FormStateUtil
getFormState()
- Method in class info.magnolia.module.form.templates.components.
AbstractFormModel
getFormStateToken()
- Method in class info.magnolia.module.form.engine.
FormEngine
getFormStateToken()
- Static method in class info.magnolia.module.form.engine.
FormStateUtil
getFormStateToken()
- Method in class info.magnolia.module.form.templates.components.multistep.
StartStepFormEngine
Finds the token from a requests parameter, or since this is the first step creates a new form state if the form is being submitted.
getFormSummaryBeanList()
- Method in class info.magnolia.module.form.templates.components.
FormSummaryModel
getFormView(FormStepState)
- Method in class info.magnolia.module.form.engine.
FormEngine
Called when the form is to be rendered.
getFormView(FormStepState)
- Method in class info.magnolia.module.form.templates.components.
AbstractFormEngine
getGetObjectFunction()
- Method in class info.magnolia.module.form.controls.
ConditionControl
JS function used to create an object out of the input fields.
getGetObjectFunction()
- Method in class info.magnolia.module.form.controls.
CriteriaControl
Deprecated.
JS function used to create an object out of the input fields.
getGetObjectFunction()
- Method in class info.magnolia.module.form.controls.
MultiControl
JS function used to create an object out of the input fields.
getHiddenFieldName()
- Method in class info.magnolia.module.form.controls.
MultiControl
If the values are saved using the valueType multiple, we can not use the same name for the hidden field we use for persisting the data.
getHref()
- Method in interface info.magnolia.module.form.stepnavigation.
Link
getHref()
- Method in class info.magnolia.module.form.stepnavigation.
LinkImpl
getI18nBasename()
- Method in class info.magnolia.module.form.validators.
Validator
getInnerHtml()
- Method in class info.magnolia.module.form.controls.
ConditionControl
Called by the template.
getInnerHtml()
- Method in class info.magnolia.module.form.controls.
CriteriaControl
Deprecated.
Called by the template.
getInstance()
- Static method in class info.magnolia.module.form.
FormModule
getJSON()
- Method in class info.magnolia.module.form.controls.
MultiControl
Create the object to initialize the table.
getLoggerName()
- Method in class info.magnolia.module.form.processors.
TrackEmailProcessor
getName()
- Method in class info.magnolia.module.form.engine.
FormField
getName()
- Method in class info.magnolia.module.form.processors.
AbstractFormProcessor
getName()
- Method in class info.magnolia.module.form.templates.components.
FormSummaryBean
getName()
- Method in class info.magnolia.module.form.templates.components.
ParagraphConfig
getName()
- Method in class info.magnolia.module.form.validators.
Validator
getNavigationTitle()
- Method in interface info.magnolia.module.form.stepnavigation.
Link
getNavigationTitle()
- Method in class info.magnolia.module.form.stepnavigation.
LinkImpl
getNewObjectFunction()
- Method in class info.magnolia.module.form.controls.
ConditionControl
JS function used to create a new empty object.
getNewObjectFunction()
- Method in class info.magnolia.module.form.controls.
CriteriaControl
Deprecated.
JS function used to create a new empty object.
getNewObjectFunction()
- Method in class info.magnolia.module.form.controls.
MultiControl
JS function used to create a new empty object.
getNextPage()
- Method in class info.magnolia.module.form.engine.
FormEngine
Returns the UUID of the page to redirect to when validation succeeds or null to proceed to executing processors.
getNextPage()
- Method in class info.magnolia.module.form.templates.components.multistep.
StartStepFormEngine
Returns the UUID of the first child page with a paragraph of type
FormStepParagraph
.
getNextPage()
- Method in class info.magnolia.module.form.templates.components.multistep.
SubStepFormEngine
getNextStepsNavigation()
- Method in class info.magnolia.module.form.templates.components.
SubStepFormModel
getPageParagraphsOfType(Node, String)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
getParagraphUuid()
- Method in class info.magnolia.module.form.engine.
FormStepState
getParameters()
- Method in class info.magnolia.module.form.templates.components.
FormSummaryBean
getPreviousPage()
- Method in class info.magnolia.module.form.engine.
FormEngine
Returns the UUID of the previous page or null if there is no such page (i.e.
getPreviousStepsNavigation()
- Method in class info.magnolia.module.form.templates.components.
SubStepFormModel
getProcessorFailedView(String)
- Method in class info.magnolia.module.form.engine.
FormEngine
Called when a processor failed.
getProcessorFailedView(String)
- Method in class info.magnolia.module.form.templates.components.
AbstractFormEngine
getRequiredSymbol()
- Method in class info.magnolia.module.form.templates.components.
AbstractFormModel
getRequiredSymbol()
- Method in class info.magnolia.module.form.templates.components.
FormFieldModel
getRightText()
- Method in class info.magnolia.module.form.templates.components.
AbstractFormModel
Text for required symbol.
getRightText()
- Method in class info.magnolia.module.form.templates.components.
FormFieldModel
getSameTypeSiblingsAfter(Node)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
getSaveInfo()
- Method in class info.magnolia.module.form.controls.
MultiControl
getStep(String)
- Method in class info.magnolia.module.form.engine.
FormState
getSteps()
- Method in class info.magnolia.module.form.engine.
FormState
getSteps()
- Method in class info.magnolia.module.form.templates.components.
FormSummaryModel
getStyle()
- Method in class info.magnolia.module.form.templates.components.
FormFieldModel
getSuccessMessage()
- Method in class info.magnolia.module.form.templates.components.
SuccessView
getSuccessTitle()
- Method in class info.magnolia.module.form.templates.components.
SuccessView
getSuccessView()
- Method in class info.magnolia.module.form.engine.
FormEngine
Called when validation was successful and all processors executed successfully.
getSuccessView()
- Method in class info.magnolia.module.form.templates.components.
AbstractFormEngine
getTitle()
- Method in interface info.magnolia.module.form.stepnavigation.
Link
getTitle()
- Method in class info.magnolia.module.form.stepnavigation.
LinkImpl
getTitle()
- Method in class info.magnolia.module.form.templates.components.
FormSummaryBean
getToken()
- Method in class info.magnolia.module.form.engine.
FormState
getToken()
- Method in exception info.magnolia.module.form.engine.
NoSuchFormStateException
getValidationErrors()
- Method in class info.magnolia.module.form.engine.
FormStepState
getValidationErrors()
- Method in class info.magnolia.module.form.templates.components.
FormView
getValidationFailedView(FormStepState)
- Method in class info.magnolia.module.form.engine.
FormEngine
Called when validation fails.
getValidationSuccessfulView(FormState)
- Method in class info.magnolia.module.form.engine.
FormEngine
Called when validation has been performed and there were no validation errors.
getValidatorByName(String)
- Method in class info.magnolia.module.form.
FormModule
getValidators()
- Method in class info.magnolia.module.form.
FormModule
getValue()
- Method in class info.magnolia.module.form.controls.
OptionConfiguration
getValue()
- Method in class info.magnolia.module.form.engine.
FormField
getValue()
- Method in class info.magnolia.module.form.templates.components.
FormFieldModel
getValues()
- Method in class info.magnolia.module.form.engine.
FormState
getValues()
- Method in class info.magnolia.module.form.engine.
FormStepState
getView()
- Method in class info.magnolia.module.form.engine.
FormState
getView()
- Method in class info.magnolia.module.form.templates.components.
AbstractFormModel
GoToFirstPageView
- Class in
info.magnolia.module.form.templates.components.multistep
Used when a sub page is accessed without a form state token.
GoToFirstPageView(String)
- Constructor for class info.magnolia.module.form.templates.components.multistep.
GoToFirstPageView
H
handleNoSuchFormState(String)
- Method in class info.magnolia.module.form.engine.
FormEngine
Called when the form was to be rendered for a supplied form token but there is no state in the session.
handleNoSuchFormState(String)
- Method in class info.magnolia.module.form.templates.components.
AbstractFormEngine
handleNoSuchFormState(String)
- Method in class info.magnolia.module.form.templates.components.multistep.
SubStepFormEngine
handleNoSuchFormStateOnSubmit(String)
- Method in class info.magnolia.module.form.engine.
FormEngine
Called when a submission occurs with a form state token but there is no formState in session.
handleNoSuchFormStateOnSubmit(String)
- Method in class info.magnolia.module.form.templates.components.multistep.
SubStepFormEngine
handleRequest(Node)
- Method in class info.magnolia.module.form.engine.
FormEngine
handleStyle()
- Method in class info.magnolia.module.form.templates.components.
FormFieldModel
handleTokenMissing()
- Method in class info.magnolia.module.form.engine.
FormEngine
Called when the form is to be rendered and there's no token provided.
handleTokenMissing()
- Method in class info.magnolia.module.form.templates.components.multistep.
SubStepFormEngine
handleValue()
- Method in class info.magnolia.module.form.templates.components.
FormFieldModel
I
info.magnolia.module.form
- package info.magnolia.module.form
info.magnolia.module.form.controls
- package info.magnolia.module.form.controls
info.magnolia.module.form.dialogs
- package info.magnolia.module.form.dialogs
info.magnolia.module.form.engine
- package info.magnolia.module.form.engine
info.magnolia.module.form.processors
- package info.magnolia.module.form.processors
info.magnolia.module.form.setup
- package info.magnolia.module.form.setup
info.magnolia.module.form.stepnavigation
- package info.magnolia.module.form.stepnavigation
info.magnolia.module.form.templates.components
- package info.magnolia.module.form.templates.components
info.magnolia.module.form.templates.components.multistep
- package info.magnolia.module.form.templates.components.multistep
info.magnolia.module.form.validators
- package info.magnolia.module.form.validators
init(HttpServletRequest, HttpServletResponse, Content, Content)
- Method in class info.magnolia.module.form.controls.
ConditionControl
init(HttpServletRequest, HttpServletResponse, Content, Content)
- Method in class info.magnolia.module.form.controls.
CriteriaControl
Deprecated.
init(HttpServletRequest, HttpServletResponse, Content, Content)
- Method in class info.magnolia.module.form.dialogs.
DialogRadioSwitch
internalProcess(Node, Map<String, Object>)
- Method in class info.magnolia.module.form.processors.
AbstractFormProcessor
internalProcess(Node, Map<String, Object>)
- Method in class info.magnolia.module.form.processors.
SendConfirmationEMailProcessor
internalProcess(Node, Map<String, Object>)
- Method in class info.magnolia.module.form.processors.
SendContactEMailProcessor
internalProcess(Node, Map<String, Object>)
- Method in class info.magnolia.module.form.processors.
TrackEmailProcessor
isBackButton()
- Method in class info.magnolia.module.form.engine.
FormEngine
isDisplayOnlyLastStep()
- Method in class info.magnolia.module.form.templates.components.
FormSummaryModel
isEnabled()
- Method in class info.magnolia.module.form.processors.
AbstractFormProcessor
isEnded()
- Method in class info.magnolia.module.form.engine.
FormState
isFormSubmission()
- Method in class info.magnolia.module.form.engine.
FormEngine
isMandatory(Node)
- Method in class info.magnolia.module.form.templates.components.
DefaultFormDataBinder
isParagraphOfType(Node, Class<?>)
- Static method in class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
isRedirectWithParams()
- Method in class info.magnolia.module.form.engine.
FormEngine
isRedirectWithParams()
- Method in class info.magnolia.module.form.templates.components.
FormParagraph
isSuccess()
- Method in class info.magnolia.module.form.validators.
ValidationResult
isValid()
- Method in class info.magnolia.module.form.engine.
FormField
isValid()
- Method in class info.magnolia.module.form.engine.
FormStepState
isValid()
- Method in class info.magnolia.module.form.templates.components.
FormFieldModel
L
Link
- Interface in
info.magnolia.module.form.stepnavigation
Manages Form breadcrumb links.
LinkImpl
- Class in
info.magnolia.module.form.stepnavigation
Link Implementation.
LinkImpl(Node)
- Constructor for class info.magnolia.module.form.stepnavigation.
LinkImpl
M
MultiControl
- Class in
info.magnolia.module.form.controls
Common class for creating combined multi controls.
MultiControl()
- Constructor for class info.magnolia.module.form.controls.
MultiControl
MultiControlSaveHandler
- Class in
info.magnolia.module.form.controls
Save handler taking care of saving controls implementing MultiValueControl interface.
MultiControlSaveHandler()
- Constructor for class info.magnolia.module.form.controls.
MultiControlSaveHandler
MultiValueControl
- Interface in
info.magnolia.module.form.controls
Marker interface for processing of multi value controls used by from condition paragraph.
N
NavigationUtils
- Class in
info.magnolia.module.form.templates.components.multistep
Utilities for finding pages with certain paragraphs.
NavigationUtils()
- Constructor for class info.magnolia.module.form.templates.components.multistep.
NavigationUtils
newFormState()
- Static method in class info.magnolia.module.form.engine.
FormStateUtil
NoHTMLValidator
- Class in
info.magnolia.module.form.validators
Validates that a field does not contain html.
NoHTMLValidator()
- Constructor for class info.magnolia.module.form.validators.
NoHTMLValidator
NoSuchFormStateException
- Exception in
info.magnolia.module.form.engine
Thrown when an attempt is made to get form state from session that does not exist.
NoSuchFormStateException(String)
- Constructor for exception info.magnolia.module.form.engine.
NoSuchFormStateException
O
OptionConfiguration
- Class in
info.magnolia.module.form.controls
Simple value option configuration.
OptionConfiguration()
- Constructor for class info.magnolia.module.form.controls.
OptionConfiguration
P
ParagraphConfig
- Class in
info.magnolia.module.form.templates.components
Configuration bean used to configure what sub paragraphs are available for a form paragraph.
ParagraphConfig()
- Constructor for class info.magnolia.module.form.templates.components.
ParagraphConfig
PasswordValidator
- Class in
info.magnolia.module.form.validators
Validates that a submitted password matches a confirmation field.
PasswordValidator()
- Constructor for class info.magnolia.module.form.validators.
PasswordValidator
process(Node, Map<String, Object>)
- Method in class info.magnolia.module.form.processors.
AbstractFormProcessor
process(Node, Map<String, Object>)
- Method in interface info.magnolia.module.form.processors.
FormProcessor
Performs an action when a form is submitted and validates successfully.
processString(Content, String, int, int, String[], String)
- Method in class info.magnolia.module.form.controls.
MultiControlSaveHandler
R
readValues()
- Method in class info.magnolia.module.form.controls.
MultiControl
RedirectView
- Class in
info.magnolia.module.form.engine
Simple redirect view.
RedirectView(Node)
- Constructor for class info.magnolia.module.form.engine.
RedirectView
RedirectView(String)
- Constructor for class info.magnolia.module.form.engine.
RedirectView
redirectWithParams
- Variable in class info.magnolia.module.form.engine.
FormEngine
RedirectWithTokenAndParametersView
- Class in
info.magnolia.module.form.engine
Used to redirect to a page with the form state token and all url parameters, effectively continuing the form on another page.
RedirectWithTokenAndParametersView(Node, String)
- Constructor for class info.magnolia.module.form.engine.
RedirectWithTokenAndParametersView
RedirectWithTokenAndParametersView(String, String)
- Constructor for class info.magnolia.module.form.engine.
RedirectWithTokenAndParametersView
RedirectWithTokenView
- Class in
info.magnolia.module.form.engine
Used to redirect to a page with the form state token, effectively continuing the form on another page.
RedirectWithTokenView(Node, String)
- Constructor for class info.magnolia.module.form.engine.
RedirectWithTokenView
RedirectWithTokenView(String, String)
- Constructor for class info.magnolia.module.form.engine.
RedirectWithTokenView
S
SendConfirmationEMailProcessor
- Class in
info.magnolia.module.form.processors
Sends a confirmation mail, any files submitted are sent as attachments.
SendConfirmationEMailProcessor()
- Constructor for class info.magnolia.module.form.processors.
SendConfirmationEMailProcessor
SendContactEMailProcessor
- Class in
info.magnolia.module.form.processors
Sends a contact mail, any files submitted are sent as attachments.
SendContactEMailProcessor()
- Constructor for class info.magnolia.module.form.processors.
SendContactEMailProcessor
sendMail(String, String, String, String, String, Map<String, Object>)
- Method in class info.magnolia.module.form.processors.
AbstractEMailFormProcessor
sendRedirect(String)
- Static method in class info.magnolia.module.form.engine.
FormStateUtil
sendRedirectWithToken(String, String)
- Static method in class info.magnolia.module.form.engine.
FormStateUtil
sendRedirectWithTokenAndParameters(String, String, Map<String, String>)
- Static method in class info.magnolia.module.form.engine.
FormStateUtil
SessionExpiredView
- Class in
info.magnolia.module.form.templates.components
Used when a sub page is requested with a form execution token that there is no formState in session for.
SessionExpiredView(String)
- Constructor for class info.magnolia.module.form.templates.components.
SessionExpiredView
setConditions(List<OptionConfiguration>)
- Method in class info.magnolia.module.form.controls.
ConditionControl
setConditions(List<OptionConfiguration>)
- Method in class info.magnolia.module.form.controls.
CriteriaControl
Deprecated.
setCurrentlyExecutingStep(int)
- Method in class info.magnolia.module.form.engine.
FormState
setEnabled(boolean)
- Method in class info.magnolia.module.form.processors.
AbstractFormProcessor
setEnded(boolean)
- Method in class info.magnolia.module.form.engine.
FormState
setErrorMessage(String)
- Method in class info.magnolia.module.form.engine.
FormField
setErrorMessage(String)
- Method in class info.magnolia.module.form.templates.components.
ErrorView
setErrorMessage(String)
- Method in class info.magnolia.module.form.validators.
ValidationResult
setErrorTitle(String)
- Method in class info.magnolia.module.form.templates.components.
FormView
setExpression(String)
- Method in class info.magnolia.module.form.validators.
ValidateExpression
setFirstPage(String)
- Method in class info.magnolia.module.form.templates.components.multistep.
GoToFirstPageView
setFirstPage(String)
- Method in class info.magnolia.module.form.templates.components.
SessionExpiredView
setFormProcessors(FormProcessor[])
- Method in class info.magnolia.module.form.templates.components.
FormParagraph
setFormState(FormState)
- Method in class info.magnolia.module.form.engine.
FormEngine
setI18nBasename(String)
- Method in class info.magnolia.module.form.templates.components.
DefaultFormDataBinder
setI18nBasename(String)
- Method in class info.magnolia.module.form.validators.
Validator
setLoggerName(String)
- Method in class info.magnolia.module.form.processors.
TrackEmailProcessor
setName(String)
- Method in class info.magnolia.module.form.dialogs.
DialogRadioSwitch
setName(String)
- Method in class info.magnolia.module.form.engine.
FormField
setName(String)
- Method in class info.magnolia.module.form.processors.
AbstractFormProcessor
setName(String)
- Method in class info.magnolia.module.form.templates.components.
FormSummaryBean
setName(String)
- Method in class info.magnolia.module.form.templates.components.
ParagraphConfig
setName(String)
- Method in class info.magnolia.module.form.validators.
Validator
setParagraphUuid(String)
- Method in class info.magnolia.module.form.engine.
FormStepState
setParameters(Map<String, Object>)
- Method in class info.magnolia.module.form.templates.components.
FormSummaryBean
setRedirectWithParams(boolean)
- Method in class info.magnolia.module.form.templates.components.
FormParagraph
setStartPage(Node)
- Method in class info.magnolia.module.form.templates.components.multistep.
SubStepFormEngine
setSuccess(boolean)
- Method in class info.magnolia.module.form.validators.
ValidationResult
setSuccessMessage(String)
- Method in class info.magnolia.module.form.templates.components.
SuccessView
setSuccessTitle(String)
- Method in class info.magnolia.module.form.templates.components.
SuccessView
setTitle(String)
- Method in class info.magnolia.module.form.templates.components.
FormSummaryBean
setToken(String)
- Method in class info.magnolia.module.form.engine.
FormState
setValidationErrors(Map<String, String>)
- Method in class info.magnolia.module.form.templates.components.
FormView
setValidators(List)
- Method in class info.magnolia.module.form.
FormModule
setValue(String)
- Method in class info.magnolia.module.form.controls.
OptionConfiguration
setValue(Object)
- Method in class info.magnolia.module.form.engine.
FormField
setView(View)
- Method in class info.magnolia.module.form.engine.
FormState
StartStepFormEngine
- Class in
info.magnolia.module.form.templates.components.multistep
FormEngine implementation for the first step of a multi step form, or a single step form.
StartStepFormEngine(Node, FormParagraph, RenderingContext)
- Constructor for class info.magnolia.module.form.templates.components.multistep.
StartStepFormEngine
SubStepFormEngine
- Class in
info.magnolia.module.form.templates.components.multistep
FormEngine implementation for step 2+ of multi step forms.
SubStepFormEngine(Node, FormParagraph, Node, RenderingContext)
- Constructor for class info.magnolia.module.form.templates.components.multistep.
SubStepFormEngine
SubStepFormModel
- Class in
info.magnolia.module.form.templates.components
Implements behaviour for sub pages in multi step forms.
SubStepFormModel(Node, RenderableDefinition, RenderingModel<?>, TemplatingFunctions)
- Constructor for class info.magnolia.module.form.templates.components.
SubStepFormModel
SuccessView
- Class in
info.magnolia.module.form.templates.components
Used when form processing completes and all processors have executed successfully.
SuccessView()
- Constructor for class info.magnolia.module.form.templates.components.
SuccessView
T
toString()
- Method in class info.magnolia.module.form.templates.components.
ParagraphConfig
TrackEmailProcessor
- Class in
info.magnolia.module.form.processors
Uses the mail module to log that a form was submitted.
TrackEmailProcessor()
- Constructor for class info.magnolia.module.form.processors.
TrackEmailProcessor
U
UpdateConfirmHtmlTypeToCodeTask
- Class in
info.magnolia.module.form.setup
Switch html type of confirm mail to code.
UpdateConfirmHtmlTypeToCodeTask(String, String)
- Constructor for class info.magnolia.module.form.setup.
UpdateConfirmHtmlTypeToCodeTask
V
validate(String)
- Method in class info.magnolia.module.form.validators.
NoHTMLValidator
validate(String)
- Method in class info.magnolia.module.form.validators.
PasswordValidator
validate(String)
- Method in class info.magnolia.module.form.validators.
ValidateExpression
validate(String)
- Method in class info.magnolia.module.form.validators.
Validator
ValidateExpression
- Class in
info.magnolia.module.form.validators
Regular expression validator.
ValidateExpression()
- Constructor for class info.magnolia.module.form.validators.
ValidateExpression
validateWithResult(String)
- Method in class info.magnolia.module.form.validators.
Validator
ValidationResult
- Class in
info.magnolia.module.form.validators
Represents the result of a validation operation.
ValidationResult(boolean)
- Constructor for class info.magnolia.module.form.validators.
ValidationResult
ValidationResult(boolean, String)
- Constructor for class info.magnolia.module.form.validators.
ValidationResult
Validator
- Class in
info.magnolia.module.form.validators
Base class for validators.
Validator()
- Constructor for class info.magnolia.module.form.validators.
Validator
valueOf(boolean)
- Static method in class info.magnolia.module.form.validators.
ValidationResult
View
- Interface in
info.magnolia.module.form.engine
A view as returned from FormEngine.
A
B
C
D
E
F
G
H
I
L
M
N
O
P
R
S
T
U
V
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
Copyright © 2013
Magnolia International Ltd.
. All Rights Reserved.