org.modelio.api.ui.form.fields

Class ElementField

java.lang.Object

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

org.modelio.api.ui.form.fields.ElementField

All Implemented Interfaces:

IField

public class ElementField
extends AbstractField

An AbstractField sub-classes specialized to display/edit Element values. Uses a TextWrapperForIElement.

Field Summary

Fields inherited from class org.modelio.api.ui.form.fields.AbstractField

changeSupport

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

PROP_VALUE

Constructor Summary

Constructors

Constructor and Description
ElementField(FormToolkit toolkit, Composite parent, IFormFieldData model)
ElementField(FormToolkit toolkit, Composite parent, IFormFieldData model, java.util.List<java.lang.Class<? extends MObject>> allowedMetaclasses)

Method Summary

Modifier and Type	Method and Description
void	apply() Store the field value in the model.
Control	createControl(FormToolkit toolkit, Composite parent) Create the edition control.
java.lang.String	getValidationError() Default implementation that always return null.
void	refresh() Refresh the value displayed by the field.

Methods inherited from class org.modelio.api.ui.form.fields.AbstractField

addPropertyChangeListener, fireValueChanged, getComposite, getControl, getHelpText, getLabel, getModel, isVertical, layout, removePropertyChangeListener, setEditable, setHelpText, setModel, setVertical

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementField

public ElementField(FormToolkit toolkit,
                    Composite parent,
                    IFormFieldData model,
                    java.util.List<java.lang.Class<? extends MObject>> allowedMetaclasses)

ElementField

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

Method Detail

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

Overrides:

apply in class AbstractField

createControl

public Control createControl(FormToolkit toolkit,
                             Composite parent)

Create the edition control.

Specified by:

createControl in class AbstractField

Parameters:

toolkit - the FormToolkit

parent - the parent composite

Returns:

the created control.

getValidationError

public java.lang.String getValidationError()

Description copied from class: AbstractField

Default implementation that always return null.

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

Specified by:

getValidationError in interface IField

Overrides:

getValidationError in class AbstractField

Returns:

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

refresh

public void refresh()

Refresh the value displayed by the field.

The field will typically query its IFormFieldData model and refresh its contents.