org.modelio.api.ui.form.fields

Class HtmlTextField

java.lang.Object

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

org.modelio.api.ui.form.fields.HtmlTextField

All Implemented Interfaces:

IField

public class HtmlTextField
extends AbstractField

display/edit the content of a html text. Uses a HtmlComposer

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
HtmlTextField(FormToolkit toolkit, Composite parent, IFormFieldData model)
HtmlTextField(FormToolkit toolkit, Composite parent, IFormFieldData model, int heightHint)

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	layout(Label label, Control control, ImageHyperlink helpButton) Layouts the label, edition control and help button in their container (IField.getComposite())
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, 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

HtmlTextField

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

HtmlTextField

public HtmlTextField(FormToolkit toolkit,
                     Composite parent,
                     IFormFieldData model,
                     int heightHint)

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.

layout

public void layout(Label label,
                   Control control,
                   ImageHyperlink helpButton)

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). Specializes the initial layout so that several lines of the text can be displayed.

Specified by:

layout in interface IField

Overrides:

layout in class AbstractField

refresh

public void refresh()

Refresh the value displayed by the field.

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