|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.forms.AbstractFormPart
AbstractFormPart implements IFormPart interface and can be used as a convenient base class for concrete form parts. If a method contains code that must be called, look for instructions to call 'super' when overriding.
Section
Constructor Summary | |
---|---|
AbstractFormPart()
|
Method Summary | |
---|---|
void |
commit(boolean onSave)
Commits the part. |
void |
dispose()
Disposes the part. |
IManagedForm |
getManagedForm()
Returns the form that manages this part. |
void |
initialize(IManagedForm form)
Initializes the part. |
boolean |
isDirty()
Tests whether the part is dirty i.e. its widgets have state that is newer than the data in the model. |
boolean |
isStale()
Tests whether the part is stale i.e. its widgets have state that is older than the data in the model. |
void |
markDirty()
Marks the part dirty. |
void |
markStale()
Marks the part stale. |
void |
refresh()
Refreshes the section after becoming stale (falling behind data in the model). |
void |
setFocus()
Instructs the part to grab keyboard focus. |
boolean |
setFormInput(Object input)
Sets the overall form input. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AbstractFormPart()
Method Detail |
public void initialize(IManagedForm form)
IFormPart
initialize
in interface IFormPart
form
- the managed form that manages the partIFormPart.initialize(org.eclipse.ui.forms.IManagedForm)
public IManagedForm getManagedForm()
public void dispose()
dispose
in interface IFormPart
public void commit(boolean onSave)
commit
in interface IFormPart
onSave
- true
if the request to commit has arrived as a
result of the 'save' action.public boolean setFormInput(Object input)
setFormInput
in interface IFormPart
input
- the form input object
false
public void setFocus()
setFocus
in interface IFormPart
public void refresh()
refresh
in interface IFormPart
public void markDirty()
public boolean isDirty()
isDirty
in interface IFormPart
true
if the part is dirty, false
otherwise.public boolean isStale()
isStale
in interface IFormPart
true
if the part is stale, false
otherwise.public void markStale()
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.