Interface IWorkbenchPart

    • Field Detail

      • PROP_TITLE

        static final int PROP_TITLE
        The property id for getTitle, getTitleImage and getTitleToolTip.
        See Also:
        Constant Field Values
    • Method Detail

      • addPropertyListener

        void addPropertyListener​(IPropertyListener listener)
        Adds a listener for changes to properties of this workbench part. Has no effect if an identical listener is already registered.

        The property ids are defined in IWorkbenchPartConstants.

        Parameters:
        listener - a property listener
      • createPartControl

        void createPartControl​(Composite parent)
        Creates the SWT controls for this workbench part.

        Clients should not call this method (the workbench calls this method when it needs to, which may be never).

        For implementors this is a multi-step process:

        1. Create one or more controls within the parent.
        2. Set the parent layout as needed.
        3. Register any global actions with the site's IActionBars.
        4. Register any context menus with the site.
        5. Register a selection provider with the site, to make it available to the workbench's ISelectionService (optional).
        Parameters:
        parent - the parent control
      • dispose

        void dispose()
        Disposes of this workbench part.

        This is the last method called on the IWorkbenchPart. At this point the part controls (if they were ever created) have been disposed as part of an SWT composite. There is no guarantee that createPartControl() has been called, so the part controls may never have been created.

        Within this method a part may release any resources, fonts, images, etc.  held by this part. It is also very important to deregister all listeners from the workbench.

        Clients should not call this method (the workbench calls this method at appropriate times).

      • getSite

        IWorkbenchPartSite getSite()
        Returns the site for this workbench part. The site can be null while the workbench part is being initialized. After the initialization is complete, this value must be non-null for the remainder of the part's life cycle.
        Returns:
        The part site; this value may be null if the part has not yet been initialized
      • getTitle

        String getTitle()
        Returns the title of this workbench part. If this value changes the part must fire a property listener event with PROP_TITLE.

        The title is used to populate the title bar of this part's visual container.

        Returns:
        the workbench part title (not null)
      • getTitleImage

        Image getTitleImage()
        Returns the title image of this workbench part. If this value changes the part must fire a property listener event with PROP_TITLE.

        The title image is usually used to populate the title bar of this part's visual container. Since this image is managed by the part itself, callers must not dispose the returned image.

        Returns:
        the title image
      • getTitleToolTip

        String getTitleToolTip()
        Returns the title tool tip text of this workbench part. An empty string result indicates no tool tip. If this value changes the part must fire a property listener event with PROP_TITLE.

        The tool tip text is used to populate the title bar of this part's visual container.

        Returns:
        the workbench part title tool tip (not null)
      • removePropertyListener

        void removePropertyListener​(IPropertyListener listener)
        Removes the given property listener from this workbench part. Has no effect if an identical listener is not registered.
        Parameters:
        listener - a property listener
      • setFocus

        void setFocus()
        Asks this part to take focus within the workbench. Parts must assign focus to one of the controls contained in the part's parent composite.

        Clients should not call this method (the workbench calls this method at appropriate times). To have the workbench activate a part, use IWorkbenchPage.activate(IWorkbenchPart) instead.