net.enilink.commons.ui.editor

Interface IEditorForm

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

All Known Implementing Classes:

EditorForm

public interface IEditorForm
extends org.eclipse.core.runtime.IAdaptable

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	fireSelectionChanged(IEditorPart part, org.eclipse.jface.viewers.ISelection selection) A part can use this method to notify other parts that implement IPartSelectionListener about selection changes.
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 refreshing every part that is stale.
void	removePart(IEditorPart part) Removes the part from the form.
boolean	removeStateListener(IEditorStateListener stateListener)
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 interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

initialize

void initialize()

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

getWidgetFactory

EditorWidgetFactory getWidgetFactory()

Returns the toolkit used by this form.

Returns:

the toolkit

fireSelectionChanged

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

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

Parameters:

part - the part that broadcasts the selection

selection - the selection in the part

getParts

IEditorPart[] getParts()

Returns all the parts currently managed by this form.

Returns:

the managed parts

addPart

void addPart(IEditorPart part)

Adds the new part to the form.

Parameters:

part - the part to add

removePart

void removePart(IEditorPart part)

Removes the part from the form.

Parameters:

part - the part to remove

setInput

boolean setInput(Object input)

Sets the input of this page to the provided object.

Parameters:

input - the new page input

Returns:

true if the form contains this object, false otherwise.

getInput

Object getInput()

Returns the current page input.

Returns:

page input object or null if not applicable.

isDirty

boolean isDirty()

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

Returns:

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

dirtyStateChanged

void dirtyStateChanged()

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

See Also:

isDirty()

commit

void commit(boolean onSave)

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

Parameters:

onSave -

isStale

boolean isStale()

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.

Returns:

true if the form is stale, false otherwise.

staleStateChanged

void staleStateChanged()

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

refreshStale

void refreshStale()

Refreshes the form by refreshing every part that is stale.

getMessageManager

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

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

Returns:

the message manager instance

getShell

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

getBody

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

addStateListener

boolean addStateListener(IEditorStateListener stateListener)

removeStateListener

boolean removeStateListener(IEditorStateListener stateListener)

reflow

void reflow(boolean changed)