nl.gx.webmanager.cms.form
Interface FormElement

All Superinterfaces:

DelegatedControllerAware, Element, Presentable, Wrapper

All Known Subinterfaces:

EcardElement

public interface FormElement
extends Element

FormElement. A form element is used on a page to display one or more steps of a form.

Method Summary

Step[]	getAllSteps() Return all steps which this element can display.
java.lang.String	getClientSideValidations() Return javascript for clientside validations.
Step	getCurrentStep() Return the step which this form element should display.
Rule[]	getDecentralParameters() Retrieves the parameters which are defined as decentral.
int	getFlowId() Return flowid this form is a part of.
Form	getForm() Return the form object.
java.lang.String	getFormName() Return name of the form.
int	getFormStepIdentifier() If the form flow consists of more than one step, the step identifier for this form is returned.
java.lang.String	getSeeEvent() Deprecated.

Methods inherited from interface nl.gx.webmanager.cms.element.Element

cleanup, copy, getEditElementHeader, getElementHolder, getHeader, getIcon, getMediaItemVersion, getPageModel, getPageModelElement, getPageVersion, getPersonalization, getWebsite, isAuthorized, setAuthorized, setDefaultPresentation, setEditElementHeader, setHeader, setIcon, setPersonalization

Methods inherited from interface nl.gx.webmanager.cms.core.Presentable

getPresentation, render, render, setPresentation

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Methods inherited from interface nl.gx.webmanager.springmvc.DelegatedControllerAware

getDelegatedController, setDelegatedController

Method Detail

getForm

Form getForm()

Return the form object.

Returns:

the form object.

getFormName

java.lang.String getFormName()

Return name of the form. The name looks like: (fformidf).

Returns:

name of the form.

getFlowId

int getFlowId()

Return flowid this form is a part of.

Returns:

flowid this form is a part of.

getSeeEvent

@Deprecated
java.lang.String getSeeEvent()

Deprecated.

Return seeEvent.

Returns:

seeEvent.

getClientSideValidations

java.lang.String getClientSideValidations()

Return javascript for clientside validations.

Returns:

javascript for clientside validations.

getFormStepIdentifier

int getFormStepIdentifier()

If the form flow consists of more than one step, the step identifier for this form is returned.

Returns:

the step identifier or 0.

getCurrentStep

Step getCurrentStep()

Return the step which this form element should display. This method returns the step that should be rendered for the current HTTP request. A form element can be rendered multiple times via JSP, each time showing a different step in a form. This method only works if during a HTTP request via JSP.

Returns:

the current step object which this form element has been requested to display, or null if there is no request.

getAllSteps

Step[] getAllSteps()

Return all steps which this element can display. A form element can be configured to display one or more steps of a form. This method returns the complete list of steps which the editor has configured this element to display.

Returns:

array of step objects.

getDecentralParameters

Rule[] getDecentralParameters()

Retrieves the parameters which are defined as decentral. This can be defined in a parameter setting in the form module.

Returns:

Rule[] of decentral parameters.