diff options
Diffstat (limited to 'org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IStandbyContentPart.java')
| -rw-r--r-- | org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IStandbyContentPart.java | 162 |
1 files changed, 81 insertions, 81 deletions
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IStandbyContentPart.java b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IStandbyContentPart.java index df70184f2..5bf08fd54 100644 --- a/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IStandbyContentPart.java +++ b/org.eclipse.ui.intro/src/org/eclipse/ui/intro/config/IStandbyContentPart.java @@ -44,92 +44,92 @@ import org.eclipse.ui.intro.IIntroPart; */ public interface IStandbyContentPart { - /** - * Creates the SWT controls for this standby part. - * <p> - * Clients should not call this method. The intro framework calls this - * method when it needs to. - * - * @param parent - * the parent control - * @param toolkit - * the form toolkit being used by the IIntroPart implementation - */ - public void createPartControl(Composite parent, FormToolkit toolkit); + /** + * Creates the SWT controls for this standby part. + * <p> + * Clients should not call this method. The intro framework calls this + * method when it needs to. + * + * @param parent + * the parent control + * @param toolkit + * the form toolkit being used by the IIntroPart implementation + */ + public void createPartControl(Composite parent, FormToolkit toolkit); - /** - * Returns the primary control associated with this standby part. The - * control is typically set during the createPartControl() call when this - * part is being created. - * - * @return the SWT control which displays this standby part's content, or - * <code>null</code> if this standby part's controls have not yet - * been created. - */ - public Control getControl(); + /** + * Returns the primary control associated with this standby part. The + * control is typically set during the createPartControl() call when this + * part is being created. + * + * @return the SWT control which displays this standby part's content, or + * <code>null</code> if this standby part's controls have not yet + * been created. + */ + public Control getControl(); - /** - * Initializes this intro standby content part with the given intro site. A - * memento is passed to the part which contains a snapshot of the part state - * from a previous session. Where possible, the part should try to recreate - * that state. - * <p> - * 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. - * </p> - * - * @param introPart - * the intro part hosting this stanndby content part. - * @param memento - * this part state or <code>null</code> if there is no previous - * saved state - * @exception PartInitException - * if this part was not initialized successfully. - */ - public void init(IIntroPart introPart, IMemento memento) - throws PartInitException; + /** + * Initializes this intro standby content part with the given intro site. A + * memento is passed to the part which contains a snapshot of the part state + * from a previous session. Where possible, the part should try to recreate + * that state. + * <p> + * 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. + * </p> + * + * @param introPart + * the intro part hosting this stanndby content part. + * @param memento + * this part state or <code>null</code> if there is no previous + * saved state + * @exception PartInitException + * if this part was not initialized successfully. + */ + public void init(IIntroPart introPart, IMemento memento) + throws PartInitException; - /** - * Sets the input to show in this standby part. Note that input can be null, - * such as when the part if created through an Intro URL that does not have - * an input specified, or when this standby part is being recreated from a - * previous workbench session. In this case, the standby part is responsible - * for handling a null input, and recreating itself from a cached IMemento. - * - * @param input - * the input object to be used by this standby part. - */ - public void setInput(Object input); + /** + * Sets the input to show in this standby part. Note that input can be null, + * such as when the part if created through an Intro URL that does not have + * an input specified, or when this standby part is being recreated from a + * previous workbench session. In this case, the standby part is responsible + * for handling a null input, and recreating itself from a cached IMemento. + * + * @param input + * the input object to be used by this standby part. + */ + public void setInput(Object input); - /** - * Asks this standby part to take focus. - * <p> - * Clients should not call this method (the intro framework calls this - * method at appropriate times). - * </p> - */ - public void setFocus(); + /** + * Asks this standby part to take focus. + * <p> + * Clients should not call this method (the intro framework calls this + * method at appropriate times). + * </p> + */ + public void setFocus(); - /** - * Disposes of this standby part. - * <p> - * Clients should not call this method. The intro framework calls this - * method when the Customizable IntroPart is closed. - * </p> - */ - public void dispose(); + /** + * Disposes of this standby part. + * <p> + * Clients should not call this method. The intro framework calls this + * method when the Customizable IntroPart is closed. + * </p> + */ + public void dispose(); - /** - * Saves the object state within a memento. - * <p> - * This method is automatically called by the workbench at appropriate - * times. Clients must not call this method directly. - * </p> - * - * @param memento - * a memento to receive the object state - */ - public void saveState(IMemento memento); + /** + * Saves the object state within a memento. + * <p> + * This method is automatically called by the workbench at appropriate + * times. Clients must not call this method directly. + * </p> + * + * @param memento + * a memento to receive the object state + */ + public void saveState(IMemento memento); } |