|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Manages the intro part that introduces the product to new users. The intro part is typically shown the first time a product is started up.
The initial behavior of the intro part is controlled by the application
from via the WorkbenchWindowAdvisor.openIntro()
method.
See IIntroPart
for details on where intro parts
come from.
This interface is not intended to be extended or implemented by clients.
IWorkbench.getIntroManager()
Method Summary | |
---|---|
boolean |
closeIntro(IIntroPart part)
Closes the given intro part. |
IIntroPart |
getIntro()
Returns the intro part. |
boolean |
hasIntro()
Return whether an intro is available. |
boolean |
isIntroStandby(IIntroPart part)
Return the standby state of the given intro part. |
void |
setIntroStandby(IIntroPart part,
boolean standby)
Sets the standby state of the given intro part. |
IIntroPart |
showIntro(IWorkbenchWindow preferredWindow,
boolean standby)
Shows the intro part in the given workbench window. |
Method Detail |
public boolean closeIntro(IIntroPart part)
part
- the intro part
true
if the intro part was closed, and
false
otherwise. false
is returned
if part is null
or it is not the intro part returned
by getIntro()
.public IIntroPart getIntro()
null
if there is no intro
part, if it has been previously closed via closeIntro(IIntroPart)
or if there is an intro part but showIntro(IWorkbenchWindow, boolean)
has not yet been called to create it.
null
if none is availablepublic boolean hasIntro()
getIntro()
to discover whether an intro part has already
been created.
true
if there is an intro that could be shown, and
false
if there is no intropublic boolean isIntroStandby(IIntroPart part)
part
- the intro part
true
if the part in its partially
visible standy mode, and false
if in its fully visible state.
false
is returned if part is null
or it is not
the intro part returned by getIntro()
.public void setIntroStandby(IIntroPart part, boolean standby)
This method does nothing if the part is null
or is not
the intro part returned by getIntro()
.
part
- the intro part, or null
standby
- true
to put the part in its partially
visible standy mode, and false
to make it fully visible.public IIntroPart showIntro(IWorkbenchWindow preferredWindow, boolean standby)
preferredWindow
- the preferred workbench window, or
null
to indicate the currently active workbench windowstandby
- true
to put the intro part in its partially
visible standy mode, and false
to make it fully visible
null
if no intro part is available or if preferredWindow
is
null
and there is no currently active workbench window
|
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.