org.modelio.api.ui.form.fields

Class NoteField

java.lang.Object

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

org.modelio.api.ui.form.fields.NoteField

All Implemented Interfaces:

IField

public class NoteField
extends AbstractField

Implementation of IField meant to edit Notes.

Works with NoteFieldData as data model.

According to the note's type, displays an HtmlComposer or a simple Text.

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
NoteField(FormToolkit toolkit, Composite parent, NoteFieldData model)

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.
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, getValidationError, 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

NoteField

public NoteField(FormToolkit toolkit,
                 Composite parent,
                 NoteFieldData 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)

Description copied from class: AbstractField

Create the edition control.

Specified by:

createControl in class AbstractField

Parameters:

toolkit - the FormToolkit

parent - the parent composite

Returns:

the created control.

refresh

public void refresh()

Description copied from interface: IField

Refresh the value displayed by the field.

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