de.mguennewig.pobjform
Interface FormElement

All Known Subinterfaces:

ArrayElement, ButtonElement, CheckboxElement, HeadingElement, HtmlFormElement, InputElement, LinkElement, PClassSearchForm.Column, PClassSearchForm.Condition, PClassSearchForm.Restrict, PClassSearchForm.Sort, RadioElement, RecordElement, ReferenceElement, SpacerElement, StringElement, SwingFormElement, TextAreaElement, TextElement, ValueElement

All Known Implementing Classes:

AbstractArrayElement, AbstractButtonElement, AbstractFormElement, AbstractInputElement, AbstractLinkElement, AbstractRecordElement, AbstractSpacerElement, AbstractTextElement, AbstractValueElement, HtmlArrayElement, HtmlButtonElement, HtmlCheckboxElement, HtmlInputElement, HtmlLinkElement, HtmlRadioElement, HtmlRecordElement, HtmlReferenceElement, HtmlSpacerElement, HtmlStringElement, HtmlTextAreaElement, HtmlTextElement, PClassHtmlSearchForm.HtmlColumn, PClassHtmlSearchForm.HtmlCondition, PClassHtmlSearchForm.HtmlRestrict, PClassHtmlSearchForm.HtmlSort, PClassSwingSearchForm.SwingColumn, PClassSwingSearchForm.SwingCondition, PClassSwingSearchForm.SwingRestrict, PClassSwingSearchForm.SwingSort, SwingArrayElement, SwingButtonElement, SwingCheckboxElement, SwingInputElement, SwingRecordElement, SwingReferenceElement, SwingSpacerElement, SwingStringElement, SwingTextAreaElement, SwingTextElement

public interface FormElement

Interface for all form elements.

A form element represents the management for an form entry.

Author:

Michael Günnewig

Method Summary

void	appendToList(java.util.List<FormElement> elements)
Container	getContainer() Returns the database connection.
FormEntry	getEntry() Returns the form entry specification for this element.
PObjForm	getForm() Returns the form to which this element belongs.
java.lang.String	getLabel() Returns the label for this form element.
java.lang.String	getProperty() Returns the property for this form element.
java.lang.String	getPullInPrefix() Returns the pullInPrefix.
boolean	hasChanged() Tests whether the data for this element has been changed.
boolean	isMandatory() Tests whether data for this element must be entered.
boolean	isPulledIn() Tests whether this element will be pulled into previous line.
boolean	isVisible() Tests whether this element will write anything visible.
boolean	omitRowHeader() Tests whether for this element the header row should be omited.
void	setLabel(java.lang.String label) Sets the label of this form element to a new value.
void	setProperty(java.lang.String property) Sets the property to a new value, and propagates the change to all child elements.
void	setPullInPrefix(java.lang.String prefix) Sets the pullInPrefix.
void	setVisible(boolean visible) Sets whether this element will be written visibly.
boolean	startsNewCell() Tests whether this element will start a new cell in the current row.
void	validate() Checks for a valid value in this form element and any possible children.

Method Detail

getForm

PObjForm getForm()

Returns the form to which this element belongs.

getEntry

FormEntry getEntry()

Returns the form entry specification for this element.

getContainer

Container getContainer()

Returns the database connection.

See Also:

PObjForm.getContainer()

getProperty

java.lang.String getProperty()

Returns the property for this form element.

setProperty

void setProperty(java.lang.String property)

Sets the property to a new value, and propagates the change to all child elements.

getLabel

java.lang.String getLabel()

Returns the label for this form element.

setLabel

void setLabel(java.lang.String label)

Sets the label of this form element to a new value.

isMandatory

boolean isMandatory()

Tests whether data for this element must be entered.

isPulledIn

boolean isPulledIn()

Tests whether this element will be pulled into previous line.

getPullInPrefix

java.lang.String getPullInPrefix()

Returns the pullInPrefix.

See Also:

setPullInPrefix(String)

setPullInPrefix

void setPullInPrefix(java.lang.String prefix)

Sets the pullInPrefix.

If the form element is pulled into a line (and is not the first element of that line), then this text is written in front of the element.

omitRowHeader

boolean omitRowHeader()

Tests whether for this element the header row should be omited.

startsNewCell

boolean startsNewCell()

Tests whether this element will start a new cell in the current row.

isVisible

boolean isVisible()

Tests whether this element will write anything visible.

setVisible

void setVisible(boolean visible)

Sets whether this element will be written visibly.

hasChanged

boolean hasChanged()

Tests whether the data for this element has been changed.

appendToList

void appendToList(java.util.List<FormElement> elements)

validate

void validate()

Checks for a valid value in this form element and any possible children.