|
Eclipse Platform Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFormPage
Interface that all GUI pages need to implement in order to be added to FormEditor part. The interface makes several assumptions:
true
from isEditor()
method).Existing editors can be wrapped by implementing
this interface. In this case, 'isEditor' should return true
.
A common editor to wrap in TextEditor
that is
often added to show the raw source code of the file open into
the multi-page editor.
Field Summary |
---|
Fields inherited from interface org.eclipse.ui.IEditorPart |
---|
PROP_DIRTY, PROP_INPUT |
Fields inherited from interface org.eclipse.ui.IWorkbenchPart |
---|
PROP_TITLE |
Method Summary | |
---|---|
boolean |
canLeaveThePage()
Tests if the content of the page is in a state that allows the editor to flip to another page. |
FormEditor |
getEditor()
Returns the editor this page belongs to. |
java.lang.String |
getId()
Page must have a unique id that can be used to show it without knowing its relative position in the editor. |
int |
getIndex()
Returns the position of the page in the editor. |
IManagedForm |
getManagedForm()
Returns the managed form of this page, unless this is a source page. |
Control |
getPartControl()
Returns the control associated with this page. |
void |
initialize(FormEditor editor)
|
boolean |
isActive()
Returns true if page is currently active, false if not. |
boolean |
isEditor()
Tests whether this page wraps a complete editor that can be registered on its own, or represents a page that cannot exist outside the multi-page editor context. |
boolean |
selectReveal(java.lang.Object object)
A hint to bring the provided object into focus. |
void |
setActive(boolean active)
Indicates whether the page has become the active in the editor. |
void |
setIndex(int index)
Sets the position of the page in the editor. |
Methods inherited from interface org.eclipse.ui.IEditorPart |
---|
getEditorInput, getEditorSite, init |
Methods inherited from interface org.eclipse.ui.IWorkbenchPart |
---|
addPropertyListener, createPartControl, dispose, getSite, getTitle, getTitleImage, getTitleToolTip, removePropertyListener, setFocus |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Methods inherited from interface org.eclipse.ui.ISaveablePart |
---|
doSave, doSaveAs, isDirty, isSaveAsAllowed, isSaveOnCloseNeeded |
Method Detail |
---|
void initialize(FormEditor editor)
editor
- the form editor that this page belongs toFormEditor getEditor()
IManagedForm getManagedForm()
void setActive(boolean active)
false
) or lazily create and/or populate the content on
true
.
active
- true
if page should be visible, false
otherwise.boolean isActive()
boolean canLeaveThePage()
true
if the editor can flip to another page,
false
otherwise.Control getPartControl()
java.lang.String getId()
int getIndex()
void setIndex(int index)
index
- the zero-based index of the page in the editor.boolean isEditor()
boolean selectReveal(java.lang.Object object)
false
should be returned to allow another
page to try.
object
- object to select and reveal
true
if the request was successful, false
otherwise.
|
Eclipse Platform Release 3.2 |
|||||||||
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, 2006. All rights reserved.