IManagedForm

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> ui >> [ forms overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.ui.forms.IManagedForm

SOURCE |

Download org.eclipse.ui.forms.IManagedForm

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.ui.forms
Interface IManagedForm

All Known Implementing Classes:: ManagedForm

public interface IManagedForm

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 no 1/1 mapping between widgets and form parts. A widget like Section can be a part by itself, but a number of widgets can gather around one form part.

Although many Eclipse Forms classes expect IManagedForm interface, implementing it is not required. Instead, ManagedForm should either be used as-is or subclassed.

Since:: 3.0

Method Summary

void addPart(IFormPart part)
          Adds the new part to the form.

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(IFormPart part, org.eclipse.jface.viewers.ISelection selection)
          A part can use this method to notify other parts that implement IPartSelectionListener about selection changes.

java.lang.Object getContainer()
          Returns the container of this form.

org.eclipse.ui.forms.widgets.ScrolledForm getForm()
          Returns the form widget managed by this form.

java.lang.Object getInput()
          Returns the current page input.

IFormPart[] getParts()
          Returns all the parts currently managed by this form.

org.eclipse.ui.forms.widgets.FormToolkit getToolkit()
          Returns the toolkit used by this form.

boolean isDirty()
          Tests if form is dirty.

boolean isStale()
          Tests if form is stale.

void reflow(boolean changed)
          Reflows the form as a result of the layout change.

void refresh()
          Refreshes the form by refreshing every part that is stale.

void removePart(IFormPart part)
          Removes the part from the form.

void setContainer(java.lang.Object container)
          Sets the container that owns this form.

boolean setInput(java.lang.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.

Method Detail

getToolkit

public org.eclipse.ui.forms.widgets.FormToolkit getToolkit()

Returns the toolkit used by this form.

getForm

public org.eclipse.ui.forms.widgets.ScrolledForm getForm()

Returns the form widget managed by this form.

reflow

public void reflow(boolean changed)

Reflows the form as a result of the layout change.

fireSelectionChanged

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

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

getParts

public IFormPart[] getParts()

Returns all the parts currently managed by this form.

addPart

public void addPart(IFormPart part)

Adds the new part to the form.

removePart

public void removePart(IFormPart part)

Removes the part from the form.

setInput

public boolean setInput(java.lang.Object input)

Sets the input of this page to the provided object.

getInput

public java.lang.Object getInput()

Returns the current page input.

isDirty

public boolean isDirty()

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

dirtyStateChanged

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

commit

public void commit(boolean onSave)

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

isStale

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

staleStateChanged

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

refresh

public void refresh()

Refreshes the form by refreshing every part that is stale.

setContainer

public void setContainer(java.lang.Object container)

Sets the container that owns this form. Depending on the context, the container may be wizard, editor page, editor etc.

getContainer

public java.lang.Object getContainer()

Returns the container of this form.