nl.gx.webmanager.cms.form
Interface Form

All Superinterfaces:

Presentable, Wrapper

public interface Form
extends Presentable

A Form represents what is called a "step" in the WM user interface.

See Also:

FormElement, FormPart

Method Summary

Rule[]	getDeclaredHandlers() Get the handlers declared on this form.
Rule[]	getEffectiveHandlers() Get the handlers that will be used on this form.
FormPart	getFormPart(java.lang.String identifier) Return formpart with name identifier.
FormPart[]	getFormParts() Return an array with all formparts.
int	getFormStepInstanceId() Return the id of the form step that refers to this form.
java.lang.String	getStyleOptions()
java.lang.String	getSubTitle() Return subtitle.
java.lang.String	getTitle() Return title.
Website	getWebsite() Return the website the form is on.
boolean	isLastStep() Returns if the form is the last step.

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

Method Detail

getTitle

java.lang.String getTitle()

Return title.

Returns:

title.

getSubTitle

java.lang.String getSubTitle()

Return subtitle.

Returns:

subtitle.

getFormParts

FormPart[] getFormParts()

Return an array with all formparts.

Returns:

an array with all formparts.

getFormPart

FormPart getFormPart(java.lang.String identifier)

Return formpart with name identifier.

Parameters:

identifier - name of the formpart.

Returns:

formpart with name identifier.

getStyleOptions

java.lang.String getStyleOptions()

Returns:

any css styleoptions or null.

getWebsite

Website getWebsite()

Return the website the form is on.

Returns:

the website the form is on.

getFormStepInstanceId

int getFormStepInstanceId()

Return the id of the form step that refers to this form. This is always exactly one step.

Returns:

the id of the form step referring to this form

isLastStep

boolean isLastStep()

Returns if the form is the last step.

Returns:

true if the form is the last step.

getDeclaredHandlers

Rule[] getDeclaredHandlers()

Get the handlers declared on this form.

Returns:

the array of declared handlers.

getEffectiveHandlers

Rule[] getEffectiveHandlers()

Get the handlers that will be used on this form.

Returns:

the array of effective handlers.