pt.digitalis.dif.presentation.views.jsp.taglibs.interfaces
Interface IFormComponent

All Superinterfaces:

IFootnoteContainer

All Known Implementing Classes:

AbstractFormComponent, Form, FormCRUD, FormManager, Wizard

public interface IFormComponent
extends IFootnoteContainer

Defines the expected behavior for a dif component that incorporates or represents an HTML form with inner input fields.

Author:

Pedro Viegas pviegas@digitalis.pt

Created on:

Jan 23, 2009

Method Summary

void	addFieldToForm(AbstractFormInput input) Adds a new inner field to the form
java.lang.String	getButtonsSection()
java.lang.String	getCancelStageID() Inspector for the 'cancelStageID' attribute.
java.lang.Boolean	getConfirmation() Inspector for the 'confirmation' attribute.
java.lang.String	getConfirmationMessage() Inspector for the 'confirmationMessage' attribute.
java.lang.String	getDestinationStageID() The stage to submit the form data to
java.util.List<java.lang.String>	getFieldNames() Get the input field names
java.util.Map<java.lang.String,AbstractFormInput>	getFields() Get the input fields
AbstractGridTag	getGrid() Get the grid to apply filters.
java.lang.String	getHelpCategory() Help Category form context help build
boolean	getIndentation() Gets current indentation mode for all sequent inputs
java.lang.Integer	getLabelWidth() The width for the form labels
java.lang.String	getLayout() The form layout for rendering it's fields
java.lang.String	getMethod() The form submit method
java.lang.String	getMultiColumCellEnd() Returns the finalizer HTML for multicolumn layouts.
java.lang.String	getMultiColumCellFullRowInit() Returns the initializer HTML for a single cell row for multicolumn layouts.
java.lang.String	getMultiColumCellInit() Returns the initializer HTML for multicolumn layouts.
java.lang.String	getName() The form name
java.lang.String	getTitle()
int	getTotalFields()
boolean	hasPendingRow()
boolean	isAutoComplete() Inspector for the 'autoComplete' attribute.
boolean	isBorder()
boolean	isHasFieldSets()
boolean	isMandatoryMessage() If the mandatory fields message should be rendered (if mandatory fields exist)
boolean	isMultiPartContent() Inspector for the 'hasMultiPartContent' attribute.
boolean	isNoActions()
boolean	isNoRequiredIndicator() Inspector for the 'isNoRequiredIndicator' attribute.
boolean	isReadonly() Inspector for the 'readonly' attribute.
boolean	isRenderFootnotes() If the form should render it's footnotes or pass them on to it's container
boolean	isSaveAction() Inspector for the 'saveAction' attribute.
boolean	isSubmitAction() Inspector for the 'submitAction' attribute.
void	reinitializeMultiColumnCounter() Reinitializes the multi-column control counter for new fieldSets/set of fields
void	setAutoComplete(boolean autoComplete) Modifier for the 'autoComplete' attribute.
void	setButtonsSection(java.lang.String buttonsSection) Modifier for the 'buttonsSection' attribute.
void	setGrid(AbstractGridTag grid) Set the grid to apply filters
void	setHasFieldSets(boolean hasFieldSets) Indicates that this form has inner fieldsets
void	setIndentation(boolean state) Changes indentation mode for all sequent inputs
void	setMandatoryMessage(boolean mandatoryMessage) Modifier for the 'mandatoryMessage' attribute.
void	setMultiPartContent(boolean hasMultiPartContent) Modifier for the 'hasMultiPartContent' attribute.
void	setNoActions(boolean noActions) Modifier for the 'noActions' attribute.
void	setNoRequiredIndicator(boolean noRequiredIndicator) Modifier for the 'noRequiredIndicator' attribute.

Methods inherited from interface pt.digitalis.dif.presentation.views.jsp.taglibs.interfaces.IFootnoteContainer

addFootnote, addFootnotes, clearAllFootnotes, containsFootnote, getFootnote, getFootnoteSequenceNumber, getFootnotesList, hasFootnotes

Method Detail

addFieldToForm

void addFieldToForm(AbstractFormInput input)

Adds a new inner field to the form

Parameters:

input -

getButtonsSection

java.lang.String getButtonsSection()

Returns:

T if the form contains a button section

getCancelStageID

java.lang.String getCancelStageID()

Inspector for the 'cancelStageID' attribute.

Returns:

the cancelStageID value

getConfirmation

java.lang.Boolean getConfirmation()

Inspector for the 'confirmation' attribute.

Returns:

the confirmation value

getConfirmationMessage

java.lang.String getConfirmationMessage()

Inspector for the 'confirmationMessage' attribute.

Returns:

the confirmationMessage value

getDestinationStageID

java.lang.String getDestinationStageID()

The stage to submit the form data to

Returns:

the destinationStageID

getFieldNames

java.util.List<java.lang.String> getFieldNames()

Get the input field names

Returns:

the fieldNames

getFields

java.util.Map<java.lang.String,AbstractFormInput> getFields()

Get the input fields

Returns:

the fields

getGrid

AbstractGridTag getGrid()

Get the grid to apply filters.

Returns:

the grid

getHelpCategory

java.lang.String getHelpCategory()

Help Category form context help build

Returns:

the helpCategory value

getIndentation

boolean getIndentation()

Gets current indentation mode for all sequent inputs

Returns:

the current indentation mode state

getLabelWidth

java.lang.Integer getLabelWidth()

The width for the form labels

Returns:

the labelWidth

getLayout

java.lang.String getLayout()

The form layout for rendering it's fields

Returns:

the layout

getMethod

java.lang.String getMethod()

The form submit method

Returns:

the method

getMultiColumCellEnd

java.lang.String getMultiColumCellEnd()

Returns the finalizer HTML for multicolumn layouts. Takes into account the cells already rendered.

Returns:

the HTML end string

getMultiColumCellFullRowInit

java.lang.String getMultiColumCellFullRowInit()

Returns the initializer HTML for a single cell row for multicolumn layouts. Takes into account the cells already rendered.

Returns:

the HTML init string

getMultiColumCellInit

java.lang.String getMultiColumCellInit()

Returns the initializer HTML for multicolumn layouts. Takes into account the cells already rendered.

Returns:

the HTML init string

getName

java.lang.String getName()

The form name

Returns:

the name

getTitle

java.lang.String getTitle()

Returns:

the title

getTotalFields

int getTotalFields()

Returns:

the number of inner fields this form has

hasPendingRow

boolean hasPendingRow()

Returns:

T if the form uses tables for it's format and has a pending row to close

isAutoComplete

boolean isAutoComplete()

Inspector for the 'autoComplete' attribute.

Returns:

the autoComplete value

isBorder

boolean isBorder()

Returns:

T if the form has a border

isHasFieldSets

boolean isHasFieldSets()

Returns:

T if the form has inner fieldsets

isMandatoryMessage

boolean isMandatoryMessage()

If the mandatory fields message should be rendered (if mandatory fields exist)

Returns:

the mandatoryMessage

isMultiPartContent

boolean isMultiPartContent()

Inspector for the 'hasMultiPartContent' attribute.

Returns:

the hasMultiPartContent value

isNoActions

boolean isNoActions()

Returns:

T if the form should not render the actions (submit) section

isNoRequiredIndicator

boolean isNoRequiredIndicator()

Inspector for the 'isNoRequiredIndicator' attribute.

Returns:

the isNoRequiredIndicator value

isReadonly

boolean isReadonly()

Inspector for the 'readonly' attribute.

Returns:

the readonly value

isRenderFootnotes

boolean isRenderFootnotes()

If the form should render it's footnotes or pass them on to it's container

Returns:

the renderFootnotes value

isSaveAction

boolean isSaveAction()

Inspector for the 'saveAction' attribute.

Returns:

the saveAction value

isSubmitAction

boolean isSubmitAction()

Inspector for the 'submitAction' attribute.

Returns:

the submitAction value

reinitializeMultiColumnCounter

void reinitializeMultiColumnCounter()

Reinitializes the multi-column control counter for new fieldSets/set of fields

setAutoComplete

void setAutoComplete(boolean autoComplete)

Modifier for the 'autoComplete' attribute.

Parameters:

autoComplete - the new autoComplete value to set

setButtonsSection

void setButtonsSection(java.lang.String buttonsSection)

Modifier for the 'buttonsSection' attribute.

Parameters:

buttonsSection - the new buttonsSection value to set

setGrid

void setGrid(AbstractGridTag grid)

Set the grid to apply filters

Parameters:

grid - the grid to apply filters.

setHasFieldSets

void setHasFieldSets(boolean hasFieldSets)

Indicates that this form has inner fieldsets

Parameters:

hasFieldSets - the hasFieldSets to set

setIndentation

void setIndentation(boolean state)

Changes indentation mode for all sequent inputs

Parameters:

state - the new indentation state to set

setMandatoryMessage

void setMandatoryMessage(boolean mandatoryMessage)

Modifier for the 'mandatoryMessage' attribute.

Parameters:

mandatoryMessage - the new mandatoryMessage value to set

setMultiPartContent

void setMultiPartContent(boolean hasMultiPartContent)

Modifier for the 'hasMultiPartContent' attribute.

Parameters:

hasMultiPartContent - the new hasMultiPartContent value to set

setNoActions

void setNoActions(boolean noActions)

Modifier for the 'noActions' attribute.

Parameters:

noActions - the new noActions value to set

setNoRequiredIndicator

void setNoRequiredIndicator(boolean noRequiredIndicator)

Modifier for the 'noRequiredIndicator' attribute.

Parameters:

noRequiredIndicator - the new noRequiredIndicator value to set