org.modelio.api.ui.form.fields

Class AbstractField

java.lang.Object

org.modelio.api.ui.form.fields.AbstractField

All Implemented Interfaces:

IField

Direct Known Subclasses:

BooleanField, DateField, ElementField, EnumField, HtmlTextField, MultipleElementField, NoteField, RichTextField, StringField, TextField, TimeField

public abstract class AbstractField
extends java.lang.Object
implements IField

An abstract implementation of IField composed of:

• a Label
• an edition control
• a help button
• a help text

The composite field controls are layouted as follows:

 [--- label ---] [-------- edition control -------- ] [---button --- ]
 [-------------------- help text -------------------]
 

where the help text if folded/unfolded by the help button. The class is in charge of creating the different widgets and of their layout. The creation of the edition control is delegated to concrete sub-classes.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.beans.PropertyChangeSupport	changeSupport

Fields inherited from interface org.modelio.api.ui.form.fields.IField

PROP_VALUE

Constructor Summary

Constructors

Constructor and Description
AbstractField(FormToolkit toolkit, Composite parent)
AbstractField(FormToolkit toolkit, Composite parent, IFormFieldData model)

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a change listener to this field
void	apply() Store the field value in the model.
abstract Control	createControl(FormToolkit tk, Composite p) Create the edition control.
protected void	fireValueChanged(java.lang.Object oldValue, java.lang.Object newValue)
Composite	getComposite() Gets the top most container control of the field which must be a Composite.
Control	getControl() Gets the control in charge of displaying/editing the field value.
protected Label	getHelpText()
Label	getLabel()
IFormFieldData	getModel() Gets the IfieldData model of this field.
java.lang.String	getValidationError() Default implementation that always return null.
boolean	isVertical()
void	layout(Label lbl, Control ctrl, ImageHyperlink button) Layouts the label, edition control and help button in their container (IField.getComposite())
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Remove a change listener
void	setEditable(boolean onoff)
void	setHelpText(java.lang.String s) Set the text to be displayed in the help field of the control.
void	setModel(IFormFieldData data)
void	setVertical(boolean value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.modelio.api.ui.form.fields.IField

refresh

Field Detail

changeSupport

protected final java.beans.PropertyChangeSupport changeSupport

Constructor Detail

AbstractField

public AbstractField(FormToolkit toolkit,
                     Composite parent,
                     IFormFieldData model)

AbstractField

public AbstractField(FormToolkit toolkit,
                     Composite parent)

Method Detail

isVertical

public boolean isVertical()

setVertical

public void setVertical(boolean value)

addPropertyChangeListener

public final void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: IField

Add a change listener to this field

Specified by:

addPropertyChangeListener in interface IField

Parameters:

listener - a listener

See Also:

IField.PROP_VALUE

apply

public void apply()

Description copied from interface: IField

Store the field value in the model.

May throw a runtime exception if the field value is not valid.

Specified by:

apply in interface IField

createControl

public abstract Control createControl(FormToolkit tk,
                                      Composite p)

Create the edition control.

Parameters:

tk - the FormToolkit

p - the parent composite

Returns:

the created control.

getComposite

public final Composite getComposite()

Gets the top most container control of the field which must be a Composite.

Specified by:

getComposite in interface IField

getControl

public Control getControl()

Gets the control in charge of displaying/editing the field value.

Specified by:

getControl in interface IField

getLabel

public final Label getLabel()

getModel

public final IFormFieldData getModel()

Gets the IfieldData model of this field.

Specified by:

getModel in interface IField

getValidationError

public java.lang.String getValidationError()

Default implementation that always return null.

Should be redefined if the implementation widget may contain invalid values.

Specified by:

getValidationError in interface IField

Returns:

null if IField.apply() may be called safely, an error message in other cases.

Since:

Valkyrie 3.8

layout

public void layout(Label lbl,
                   Control ctrl,
                   ImageHyperlink button)

Description copied from interface: IField

Layouts the label, edition control and help button in their container (IField.getComposite())

This method can be redefined by subclasses who need to change the standard layout for label, control and help button.
When it is called default LayoutData have already been applied to the widgets so that this method can typically either modify or replace the existing LayoutData of the widgets.

The container layout is a FormLayout, therefore widget LayoutData must be FormData.

Note the the helpText will always be layouted so that it appears under the control (same width and X position).

Specified by:

layout in interface IField

removePropertyChangeListener

public final void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Description copied from interface: IField

Remove a change listener

Specified by:

removePropertyChangeListener in interface IField

Parameters:

listener - the listener to remove.

setEditable

public void setEditable(boolean onoff)

Specified by:

setEditable in interface IField

setHelpText

public final void setHelpText(java.lang.String s)

Description copied from interface: IField

Set the text to be displayed in the help field of the control.

Specified by:

setHelpText in interface IField

setModel

public void setModel(IFormFieldData data)

Specified by:

setModel in interface IField

fireValueChanged

protected void fireValueChanged(java.lang.Object oldValue,
                                java.lang.Object newValue)

getHelpText

protected Label getHelpText()