net.enilink.commons.ui.editor

Class EditorForm

java.lang.Object

net.enilink.commons.ui.editor.EditorForm

All Implemented Interfaces:

IEditorForm, org.eclipse.core.runtime.IAdaptable

public class EditorForm
extends Object
implements IEditorForm

Managed form wraps a form widget and adds life cycle methods for form parts. A form part is a portion of the form that participates in form life cycle events.

There is requirement for 1/1 mapping between widgets and form parts. A widget like Section can be a part by itself, but a number of widgets can join around one form part.

Note to developers: this class is left public to allow its use beyond the original intention (inside a multi-page editor's page). You should limit the use of this class to make new instances inside a form container (wizard page, dialog etc.). Clients that need access to the class should not do it directly. Instead, they should do it through IManagedForm interface as much as possible.

Constructor Summary

Constructors

Constructor and Description
EditorForm(org.eclipse.swt.widgets.Composite parent) Creates a managed form in the provided parent.
EditorForm(org.eclipse.swt.widgets.Composite parent, EditorWidgetFactory widgetFactory) Creates a managed form that will use the provided widget factory
EditorForm(org.eclipse.swt.widgets.Composite parent, org.eclipse.ui.forms.widgets.FormToolkit formToolkit) Creates a managed form that will use the provided widget factory

Method Summary

Modifier and Type	Method and Description
void	addPart(IEditorPart part) Adds the new part to the form.
boolean	addStateListener(IEditorStateListener stateListener)
void	commit(boolean onSave) Commits the dirty form.
void	dirtyStateChanged() Notifies the form that the dirty state of one of its parts has changed.
void	dispose() Disposes all the parts in this form.
void	fireSelectionChanged(IEditorPart firingPart, org.eclipse.jface.viewers.ISelection selection) A part can use this method to notify other parts that implement IPartSelectionListener about selection changes.
Object	getAdapter(Class adapter)
org.eclipse.swt.widgets.Composite	getBody()
Object	getInput() Returns the current page input.
org.eclipse.ui.forms.IMessageManager	getMessageManager() Returns the message manager that will keep track of messages in this form.
IEditorPart[]	getParts() Returns all the parts currently managed by this form.
org.eclipse.swt.widgets.Shell	getShell()
EditorWidgetFactory	getWidgetFactory() Returns the toolkit used by this form.
void	initialize() Initializes the form by looping through the managed parts and initializing them.
boolean	isDirty() Tests if form is dirty.
boolean	isStale() Tests if form is stale.
void	reflow(boolean changed)
void	refreshStale() Refreshes the form by refreshes all the stale parts.
void	removePart(IEditorPart part) Removes the part from the form.
boolean	removeStateListener(IEditorStateListener stateListener)
void	setFocus() Transfers the focus to the first form part which wants to own it.
boolean	setInput(Object input) Sets the input of this page to the provided object.
void	staleStateChanged() Notifies the form that the stale state of one of its parts has changed.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditorForm

public EditorForm(org.eclipse.swt.widgets.Composite parent)

Creates a managed form in the provided parent. Form toolkit and widget will be created and owned by this object.

Parameters:

parent - the parent widget

EditorForm

public EditorForm(org.eclipse.swt.widgets.Composite parent,
                  EditorWidgetFactory widgetFactory)

Creates a managed form that will use the provided widget factory

Parameters:

widgetFactory -

EditorForm

public EditorForm(org.eclipse.swt.widgets.Composite parent,
                  org.eclipse.ui.forms.widgets.FormToolkit formToolkit)

Creates a managed form that will use the provided widget factory

Parameters:

widgetFactory -

Method Detail

addPart

public void addPart(IEditorPart part)

Description copied from interface: IEditorForm

Adds the new part to the form.

Specified by:

addPart in interface IEditorForm

Parameters:

part - the part to add

removePart

public void removePart(IEditorPart part)

Description copied from interface: IEditorForm

Removes the part from the form.

Specified by:

removePart in interface IEditorForm

Parameters:

part - the part to remove

getParts

public IEditorPart[] getParts()

Description copied from interface: IEditorForm

Returns all the parts currently managed by this form.

Specified by:

getParts in interface IEditorForm

Returns:

the managed parts

getWidgetFactory

public EditorWidgetFactory getWidgetFactory()

Description copied from interface: IEditorForm

Returns the toolkit used by this form.

Specified by:

getWidgetFactory in interface IEditorForm

Returns:

the toolkit

initialize

public void initialize()

Initializes the form by looping through the managed parts and initializing them. Has no effect if already called once.

Specified by:

initialize in interface IEditorForm

dispose

public void dispose()

Disposes all the parts in this form.

refreshStale

public void refreshStale()

Refreshes the form by refreshes all the stale parts. Since 3.1, this method is performed on a UI thread when called from another thread so it is not needed to wrap the call in Display.syncExec or asyncExec.

Specified by:

refreshStale in interface IEditorForm

commit

public void commit(boolean onSave)

Description copied from interface: IEditorForm

Commits the dirty form. All pending changes in the widgets are flushed into the model.

Specified by:

commit in interface IEditorForm

reflow

public void reflow(boolean changed)

Specified by:

reflow in interface IEditorForm

setInput

public boolean setInput(Object input)

Description copied from interface: IEditorForm

Sets the input of this page to the provided object.

Specified by:

setInput in interface IEditorForm

Parameters:

input - the new page input

Returns:

true if the form contains this object, false otherwise.

getInput

public Object getInput()

Description copied from interface: IEditorForm

Returns the current page input.

Specified by:

getInput in interface IEditorForm

Returns:

page input object or null if not applicable.

setFocus

public void setFocus()

Transfers the focus to the first form part which wants to own it.

isDirty

public boolean isDirty()

Description copied from interface: IEditorForm

Tests if form is dirty. A managed form is dirty if at least one managed part is dirty.

Specified by:

isDirty in interface IEditorForm

Returns:

true if at least one managed part is dirty, false otherwise.

isStale

public boolean isStale()

Description copied from interface: IEditorForm

Tests if form is stale. A managed form is stale if at least one managed part is stale. This can happen when the underlying model changes, resulting in the presentation of the part being out of sync with the model and needing refreshing.

Specified by:

isStale in interface IEditorForm

Returns:

true if the form is stale, false otherwise.

dirtyStateChanged

public void dirtyStateChanged()

Description copied from interface: IEditorForm

Notifies the form that the dirty state of one of its parts has changed. The global dirty state of the form can be obtained by calling 'isDirty'.

Specified by:

dirtyStateChanged in interface IEditorForm

See Also:

IEditorForm.isDirty()

staleStateChanged

public void staleStateChanged()

Description copied from interface: IEditorForm

Notifies the form that the stale state of one of its parts has changed. The global stale state of the form can be obtained by calling 'isStale'.

Specified by:

staleStateChanged in interface IEditorForm

getMessageManager

public org.eclipse.ui.forms.IMessageManager getMessageManager()

Description copied from interface: IEditorForm

Returns the message manager that will keep track of messages in this form.

Specified by:

getMessageManager in interface IEditorForm

Returns:

the message manager instance

getShell

public org.eclipse.swt.widgets.Shell getShell()

Specified by:

getShell in interface IEditorForm

fireSelectionChanged

public void fireSelectionChanged(IEditorPart firingPart,
                                 org.eclipse.jface.viewers.ISelection selection)

A part can use this method to notify other parts that implement IPartSelectionListener about selection changes.

Specified by:

fireSelectionChanged in interface IEditorForm

Parameters:

firingPart - the part that broadcasts the selection

selection - the selection in the part

See Also:

IPartSelectionListener

getBody

public org.eclipse.swt.widgets.Composite getBody()

Specified by:

getBody in interface IEditorForm

addStateListener

public boolean addStateListener(IEditorStateListener stateListener)

Specified by:

addStateListener in interface IEditorForm

removeStateListener

public boolean removeStateListener(IEditorStateListener stateListener)

Specified by:

removeStateListener in interface IEditorForm

getAdapter

public Object getAdapter(Class adapter)

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable