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

Constructor Summary

Constructors

Constructor and Description
AbstractField(org.eclipse.ui.forms.widgets.FormToolkit toolkit, org.eclipse.swt.widgets.Composite parent)
AbstractField(org.eclipse.ui.forms.widgets.FormToolkit toolkit, org.eclipse.swt.widgets.Composite parent, IFormFieldData model)

Method Summary

Modifier and Type	Method and Description
abstract org.eclipse.swt.widgets.Control	createControl(org.eclipse.ui.forms.widgets.FormToolkit tk, org.eclipse.swt.widgets.Composite p)
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.
protected org.eclipse.swt.widgets.Label	getHelpText()
org.eclipse.swt.widgets.Label	getLabel()
IFormFieldData	getModel() Gets the IfieldData model of this field.
boolean	isVertical()
void	layout(org.eclipse.swt.widgets.Label lbl, org.eclipse.swt.widgets.Control ctrl, org.eclipse.ui.forms.widgets.ImageHyperlink button) 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.
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)
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

Constructor Detail

AbstractField

public AbstractField(org.eclipse.ui.forms.widgets.FormToolkit toolkit,
                     org.eclipse.swt.widgets.Composite parent,
                     IFormFieldData model)

AbstractField

public AbstractField(org.eclipse.ui.forms.widgets.FormToolkit toolkit,
                     org.eclipse.swt.widgets.Composite parent)

Method Detail

isVertical

public boolean isVertical()

setVertical

public void setVertical(boolean value)

createControl

public abstract org.eclipse.swt.widgets.Control createControl(org.eclipse.ui.forms.widgets.FormToolkit tk,
                                                              org.eclipse.swt.widgets.Composite p)

layout

public void layout(org.eclipse.swt.widgets.Label lbl,
                   org.eclipse.swt.widgets.Control ctrl,
                   org.eclipse.ui.forms.widgets.ImageHyperlink button)

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

setHelpText

public final void setHelpText(String s)

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

Warning: you must call getComposite() before using this method.

Specified by:

setHelpText in interface IField

getComposite

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

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

Specified by:

getComposite in interface IField

Returns:

getControl

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

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

Specified by:

getControl in interface IField

Returns:

getModel

public IFormFieldData getModel()

Gets the IfieldData model of this field.

Specified by:

getModel in interface IField

Returns:

getLabel

public final org.eclipse.swt.widgets.Label getLabel()

getHelpText

protected org.eclipse.swt.widgets.Label getHelpText()

setModel

public void setModel(IFormFieldData data)

Specified by:

setModel in interface IField

setEditable

public void setEditable(boolean onoff)

Specified by:

setEditable in interface IField