nl.gx.webmanager.cms.form
Interface FormPart

All Superinterfaces:

Presentable, Wrapper

All Known Subinterfaces:

FormPartButton, FormPartFile, FormPartList, FormPartSpecific, FormPartStaticContent, FormPartSubForm, FormPartText

public interface FormPart
extends Presentable

Meta information associated with formparts.

See Also:

Personalization, Form

Method Summary

java.lang.String	getAlias() Return the alias for the formpart, for example "e-mail".
Form	getConnectedForm() Return the form of the formpart earlier in the flow that is connected to this one for prefilling.
FormPart	getConnectedFormPart() Return the formpart earlier in the flow that is connected to this one for prefilling.
java.lang.String	getContent() Return HTML representation for the formpart except the description.
java.lang.String	getDescription() Return description.
java.lang.String	getExtraText() Return extra text.
java.lang.String[]	getExtraValidationDescriptions() Return extra validation descriptions.
Form	getForm() Return the form this formpart is a part of.
java.lang.String	getHelpText() Return helptext that should be provided to the user for the formpart.
java.lang.String	getIdentifier() Return the identifier for the formpart whcih is constructed as the letter f (to prevent javascript problems) and a unique id.
Personalization	getPersonalization() Return Personalization object with begin and end tags for the personalization transformation in the frontend.
java.lang.String	getStyleOptions() Return css style for the formpart.
Rule[]	getValidators() Return the list of validators for this form part.
boolean	isPrefilled() Return true if prefilling is enabled on this formpart.

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

getDescription

java.lang.String getDescription()

Return description.

Returns:

description.

getHelpText

java.lang.String getHelpText()

Return helptext that should be provided to the user for the formpart.

Returns:

helptext that should be provided to the user for the formpart.

getExtraText

java.lang.String getExtraText()

Return extra text. This text can be used for several purposes and is just another input field for the formpart.

Returns:

extra text.

getStyleOptions

java.lang.String getStyleOptions()

Return css style for the formpart.

Returns:

css style for the formpart.

getIdentifier

java.lang.String getIdentifier()

Return the identifier for the formpart whcih is constructed as the letter f (to prevent javascript problems) and a unique id.

Returns:

identifier.

getAlias

java.lang.String getAlias()

Return the alias for the formpart, for example "e-mail". This alias can be used in the XSL of the formhandlers, to indetify a formpart.

Returns:

alias.

getPersonalization

Personalization getPersonalization()

Return Personalization object with begin and end tags for the personalization transformation in the frontend.

Returns:

Personalization object.

getForm

Form getForm()

Return the form this formpart is a part of.

Returns:

the form this formpart is a part of.

isPrefilled

boolean isPrefilled()

Return true if prefilling is enabled on this formpart.

Returns:

true if prefilling is enabled on this formpart.

getConnectedFormPart

FormPart getConnectedFormPart()

Return the formpart earlier in the flow that is connected to this one for prefilling.

Returns:

the formpart earlier in the flow that is connected to this one for prefilling.

getConnectedForm

Form getConnectedForm()

Return the form of the formpart earlier in the flow that is connected to this one for prefilling.

Returns:

the form of the formpart earlier in the flow that is connected to this one for prefilling.

getContent

java.lang.String getContent()

Return HTML representation for the formpart except the description.

Returns:

HTML representation for the formpart except the description.

getExtraValidationDescriptions

java.lang.String[] getExtraValidationDescriptions()

Return extra validation descriptions.

Returns:

extra validation descriptions.

getValidators

Rule[] getValidators()

Return the list of validators for this form part.

Returns:

array of validators.