|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An Intro standby part. It is a UI component that represents some standby content. Standby parts can be contributed to the Eclipse intro using the following extension point:
<extension point="org.eclipse.ui.intro.configExtension"> <standbyPart pluginId="com.x.y.somePluginId" class="com.x.y.someClass" id="com.x.y.someContentPartId"> </standbyPart> </extension>Standby content parts have a life cycle that starts with a call to init, shortly after part construction, followed by a call to createPartControl. During these two calls, the part is responsible for creating its content and using the memento to try to recreate its previous state. SetInput is the last method called when trying to create a standby part.
Method Summary | |
---|---|
void |
createPartControl(Composite parent,
FormToolkit toolkit)
Creates the SWT controls for this standby part. |
void |
dispose()
Disposes of this standby part. |
Control |
getControl()
Returns the primary control associated with this standby part. |
void |
init(IIntroPart introPart,
IMemento memento)
Initializes this intro standby content part with the given intro site. |
void |
saveState(IMemento memento)
Saves the object state within a memento. |
void |
setFocus()
Asks this standby part to take focus. |
void |
setInput(Object input)
Sets the input to show in this standby part. |
Method Detail |
public void createPartControl(Composite parent, FormToolkit toolkit)
Clients should not call this method. The intro framework calls this method when it needs to.
parent
- the parent controltoolkit
- the form toolkit being used by the IIntroPart implementationpublic Control getControl()
null
if this standby part's controls have not yet
been created.public void init(IIntroPart introPart, IMemento memento) throws PartInitException
This method is automatically called by the workbench shortly after part construction. It marks the start of this parts' lifecycle. Clients must not call this method.
introPart
- the intro part hosting this stanndby content part.memento
- this part state or null
if there is no previous
saved state
PartInitException
- if this part was not initialized successfully.public void setInput(Object input)
input
- the input object to be used by this standby part.public void setFocus()
Clients should not call this method (the intro framework calls this method at appropriate times).
public void dispose()
Clients should not call this method. The intro framework calls this method when the Customizable IntroPart is closed.
public void saveState(IMemento memento)
This method is automatically called by the workbench at appropriate times. Clients must not call this method directly.
memento
- a memento to receive the object state
|
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.