Package org.eclipse.e4.ui.model.application.ui.basic

Interface MPart

All Superinterfaces:
MApplicationElement, MBindings, MContext, MContribution, MDirtyable, MHandlerContainer, MLocalizable, MPartSashContainerElement, MStackElement, MUIElement, MUILabel, MWindowElement
All Known Subinterfaces:
MCompositePart
public interface MPart extends MPartSashContainerElement, MStackElement, MContribution, MContext, MUILabel, MHandlerContainer, MDirtyable, MBindings, MWindowElement
A representation of the model object 'Part'.

This a concrete class representing the core UI functionality within a Window. It's what used to be a View / Editor in Eclipse 3.

Since:
1.0
Restriction:
This interface is not intended to be implemented by clients.

The following features are supported:

  • Method Details

    • getMenus

      List<MMenu> getMenus()
      Returns the value of the 'Menus' containment reference list. The list contents are of type MMenu.

      This defines the list of the menus associated with this part. There are two specific menus that are managed by the core UI:

      • If the menu is the part's id prefixed with "menu:" then it will appear as the drop down menu available from the view's toolbar.
      • If the menu is the part's id prefixed with "popup:" then it will appear as the ddefault context menu for this view.

      Other menus can be added here but have to be managed by the part itself...

      Returns:
      the value of the 'Menus' containment reference list.

    • getToolbar

      MToolBar getToolbar()
      Returns the value of the 'Toolbar' containment reference.

      This is the Toolbar associated with tihs Part (if any).

      Returns:
      the value of the 'Toolbar' containment reference.
      See Also:

    • setToolbar

      void setToolbar(MToolBar value)
      Sets the value of the 'Toolbar' containment reference.
      Parameters:
      value - the new value of the 'Toolbar' containment reference.
      See Also:

    • isCloseable

      boolean isCloseable()
      Returns the value of the 'Closeable' attribute. The default value is "false".

      Determines whether the user is allowed to close this view.

      Returns:
      the value of the 'Closeable' attribute.
      See Also:

    • setCloseable

      void setCloseable(boolean value)
      Sets the value of the 'Closeable' attribute.
      Parameters:
      value - the new value of the 'Closeable' attribute.
      See Also:

    • getDescription

      String getDescription()
      Returns the value of the 'Description' attribute.

      The description of this Part; used when the Part appears in a list of Parts (i.e. 'Show View').

      Returns:
      the value of the 'Description' attribute.
      See Also:

    • setDescription

      void setDescription(String value)
      Sets the value of the 'Description' attribute.
      Parameters:
      value - the new value of the 'Description' attribute.
      See Also:

    • getLocalizedDescription

      String getLocalizedDescription()
      Returns the value of the 'Localized Description' attribute.
      Returns:
      the value of the 'Localized Description' attribute.

    • getTrimBars

      List<MTrimBar> getTrimBars()
      Returns the value of the 'Trim Bars' containment reference list. The list contents are of type MTrimBar.

      The collection of TrimBars associated with this part.

      Returns:
      the value of the 'Trim Bars' containment reference list.
      Since:
      1.3