| org.eclipse.ui.intro.IIntroManager
All known Subclasses: org.eclipse.ui.internal.WorkbenchIntroManager,
Method Summary | |
public boolean | closeIntro(IIntroPart part) Closes the given intro part.
Parameters: part - the intro part true if the intro part was closed, and false otherwise. | public IIntroPart | getIntro() Returns the intro part. | public boolean | hasIntro() Return whether an intro is available. | boolean | isIntroStandby(IIntroPart part) Return the standby state of the given intro part.
Parameters: part - the intro part true if the part in its partiallyvisible 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 IIntroManager.getIntro(). | public boolean | isNewContentAvailable() Returns true if there is an intro content detector and it
reports that new intro content is available. | public void | setIntroStandby(IIntroPart part, boolean standby) Sets the standby state of the given intro part. | public IIntroPart | showIntro(IWorkbenchWindow preferredWindow, boolean standby) Shows the intro part in the given workbench window. |
closeIntro | public boolean closeIntro(IIntroPart part)(Code) | | Closes the given intro part.
Parameters: 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 returnedby IIntroManager.getIntro(). |
hasIntro | public boolean hasIntro()(Code) | | 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.
Use
IIntroManager.getIntro() to discover whether an intro part has already
been created.
true if there is an intro that could be shown, andfalse if there is no intro |
isIntroStandby | boolean isIntroStandby(IIntroPart part)(Code) | | Return the standby state of the given intro part.
Parameters: part - the intro part true if the part in its partiallyvisible 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 IIntroManager.getIntro(). |
isNewContentAvailable | public boolean isNewContentAvailable()(Code) | | Returns true if there is an intro content detector and it
reports that new intro content is available.
true if new intro content is available since: 3.3 |
setIntroStandby | public void setIntroStandby(IIntroPart part, boolean standby)(Code) | | 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 by
IIntroManager.getIntro() .
Parameters: part - the intro part, or null Parameters: standby - true to put the part in its partiallyvisible standy mode, and false to make it fully visible. |
showIntro | public IIntroPart showIntro(IWorkbenchWindow preferredWindow, boolean standby)(Code) | | 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, or null to indicate the currently active workbench window Parameters: standby - true to put the intro part in its partiallyvisible standy mode, and false to make it fully visible the newly-created or existing intro part, or null if no intro part is available or if preferredWindow isnull and there is no currently active workbench window |
|
|