org.modelio.api.ui.form.fields

Interface IField

All Known Implementing Classes:

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

public interface IField

Represents a field in an edition form.
A field is composed of:

• a label - informative
• a control - where edition takes place
• a help button - bound to a configurable help text

Method Summary

Modifier and Type	Method and Description
org.eclipse.swt.widgets.Composite	getComposite() Gets the top most container control of the field which must be a Composite.
org.eclipse.swt.widgets.Control	getControl() Gets the control in charge of displaying/editing the field value.
IFormFieldData	getModel() Gets the IfieldData model of this field.
void	layout(org.eclipse.swt.widgets.Label label, org.eclipse.swt.widgets.Control control, org.eclipse.ui.forms.widgets.ImageHyperlink helpButton) Layouts the label, edition control and help button in their container (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.
void	refresh() Refresh the value displayed by the field.
void	setEditable(boolean onoff)
void	setHelpText(String s) Set the text to be displayed in the help field of the control.
void	setModel(IFormFieldData data)

Method Detail

layout

void layout(org.eclipse.swt.widgets.Label label,
            org.eclipse.swt.widgets.Control control,
            org.eclipse.ui.forms.widgets.ImageHyperlink helpButton)

Layouts the label, edition control and help button in their container (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).

Parameters:

label -

control -

helpButton -

getComposite

org.eclipse.swt.widgets.Composite getComposite()

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

Returns:

getControl

org.eclipse.swt.widgets.Control getControl()

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

Returns:

setHelpText

void setHelpText(String s)

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

Parameters:

s -

refresh

void refresh()

Refresh the value displayed by the field. The field will typically query its IFiledData model and refresh its contents.

setEditable

void setEditable(boolean onoff)

getModel

IFormFieldData getModel()

Gets the IfieldData model of this field.

Returns:

setModel

void setModel(IFormFieldData data)