Package org.eclipse.ui.intro
Interface IIntroManager
- All Known Implementing Classes:
WorkbenchIntroManager
public interface IIntroManager
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.
- Since:
- 3.0
- See Also:
- Restriction:
- This interface is not intended to be implemented by clients.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
closeIntro
(IIntroPart part) Closes the given intro part.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.boolean
Returnstrue
if there is an intro content detector and it reports that new intro content is available.void
setIntroStandby
(IIntroPart part, boolean standby) Sets the standby state of the given intro part.showIntro
(IWorkbenchWindow preferredWindow, boolean standby) Shows the intro part in the given workbench window.
-
Method Details
-
closeIntro
Closes the given intro part.- Parameters:
part
- the intro part- Returns:
true
if the intro part was closed, andfalse
otherwise.false
is returned if part isnull
or it is not the intro part returned bygetIntro()
.
-
getIntro
IIntroPart getIntro()Returns the intro part. Returnsnull
if there is no intro part, if it has been previously closed viacloseIntro(IIntroPart)
or if there is an intro part butshowIntro(IWorkbenchWindow, boolean)
has not yet been called to create it.- Returns:
- the intro part, or
null
if none is available
-
hasIntro
boolean hasIntro()Return whether an intro is available. Note that this checks whether there is an applicable intro part that could be instantiated and shown to the user. UsegetIntro()
to discover whether an intro part has already been created.- Returns:
true
if there is an intro that could be shown, andfalse
if there is no intro
-
isIntroStandby
Return the standby state of the given intro part.- Parameters:
part
- the intro part- Returns:
true
if the part in its partially visible standy mode, andfalse
if in its fully visible state.false
is returned if part isnull
or it is not the intro part returned bygetIntro()
.
-
setIntroStandby
Sets the standby state of the given intro part. Intro part usually should render themselves differently in the full and standby modes. In standby mode, the part should be partially visible to the user but otherwise allow them to work. In full mode, the part should be fully visible and be the center of the user's attention.This method does nothing if the part is
null
or is not the intro part returned bygetIntro()
.- Parameters:
part
- the intro part, ornull
standby
-true
to put the part in its partially visible standy mode, andfalse
to make it fully visible.
-
showIntro
Shows the intro part in the given workbench window. If the intro part has not been created yet, one will be created. If the intro part is currently being shown in some workbench window, that other window is made active.- Parameters:
preferredWindow
- the preferred workbench window, ornull
to indicate the currently active workbench windowstandby
-true
to put the intro part in its partially visible standy mode, andfalse
to make it fully visible- Returns:
- the newly-created or existing intro part, or
null
if no intro part is available or ifpreferredWindow
isnull
and there is no currently active workbench window
-
isNewContentAvailable
boolean isNewContentAvailable()Returnstrue
if there is an intro content detector and it reports that new intro content is available.- Returns:
true
if new intro content is available- Since:
- 3.3
-