public interface MPartDescriptor extends MApplicationElement, MUILabel, MHandlerContainer, MBindings
This element represents a template from which an MPart can be created on demand. The collection of PartDescriptors owned by the Application represents the contributed parts and is used in the e4 version of 'Show View'...
The following features are supported:
Modifier and Type | Method and Description |
---|---|
String |
getCategory()
Returns the value of the 'Category' attribute
|
String |
getContributionURI()
Returns the value of the 'Contribution URI' attribute
|
String |
getDescription()
Returns the value of the 'Description' attribute
|
String |
getLocalizedDescription()
Returns the value of the 'Localized Description' attribute
|
List<MMenu> |
getMenus()
Returns the value of the 'Menus' containment reference list.
|
Map<String,String> |
getProperties()
Returns the value of the 'Properties' map.
|
MToolBar |
getToolbar()
Returns the value of the 'Toolbar' containment reference
|
List<MTrimBar> |
getTrimBars()
Returns the value of the 'Trim Bars' containment reference list.
|
List<String> |
getVariables()
Returns the value of the 'Variables' attribute list.
|
boolean |
isAllowMultiple()
Returns the value of the 'Allow Multiple' attribute
|
boolean |
isCloseable()
Returns the value of the 'Closeable' attribute.
|
boolean |
isDirtyable()
Deprecated.
dirtyable is managed by part
|
void |
setAllowMultiple(boolean value)
Sets the value of the '
Allow Multiple ' attribute |
void |
setCategory(String value)
Sets the value of the '
Category ' attribute |
void |
setCloseable(boolean value)
Sets the value of the '
Closeable ' attribute |
void |
setContributionURI(String value)
Sets the value of the '
Contribution URI ' attribute |
void |
setDescription(String value)
Sets the value of the '
Description ' attribute |
void |
setDirtyable(boolean value)
Deprecated.
dirtyable is managed by part
|
void |
setToolbar(MToolBar value)
Sets the value of the '
Toolbar ' containment reference |
getContributorURI, getElementId, getPersistedState, getTags, getTransientData, setContributorURI, setElementId
getIconURI, getLabel, getLocalizedLabel, getLocalizedTooltip, getTooltip, setIconURI, setLabel, setTooltip
updateLocalization
getHandlers
getBindingContexts
boolean isAllowMultiple()
Determines whether or not the part represented by this descriptot can have multiple instances with a given window.
setAllowMultiple(boolean)
void setAllowMultiple(boolean value)
Allow Multiple
' attribute.
value
- the new value of the 'Allow Multiple' attribute.isAllowMultiple()
String getCategory()
The category that the view represented by this descriptor belongs to.
setCategory(String)
void setCategory(String value)
Category
' attribute.
value
- the new value of the 'Category' attribute.getCategory()
List<MMenu> getMenus()
MMenu
.
This defines the list of the menus associated with the part represented by this descriptor. There are two specific menus that are managed by the core UI;
MToolBar getToolbar()
This is the Toolbar associated with tihs Part (if any).
setToolbar(MToolBar)
void setToolbar(MToolBar value)
Toolbar
' containment reference.
value
- the new value of the 'Toolbar' containment reference.getToolbar()
boolean isCloseable()
"false"
.
Defines whether instances of views created from this descriptor are closeable by the User.
setCloseable(boolean)
void setCloseable(boolean value)
Closeable
' attribute.
value
- the new value of the 'Closeable' attribute.isCloseable()
@Deprecated boolean isDirtyable()
Determines whether Parts generated from this template can participate in the Dirty -> Save cycle. At best this is a hint since all Parts are inherently dirtyable.
setDirtyable(boolean)
,
Bug
530887@Deprecated void setDirtyable(boolean value)
Dirtyable
' attribute. value
- the new value of the 'Dirtyable' attribute.isDirtyable()
,
Bug
530887String getContributionURI()
The fully qualified path to the class implementing the behavior of the Part.
setContributionURI(String)
void setContributionURI(String value)
Contribution URI
' attribute.
value
- the new value of the 'Contribution URI' attribute.getContributionURI()
String getDescription()
The description of this Part.
setDescription(String)
void setDescription(String value)
Description
' attribute.
value
- the new value of the 'Description' attribute.getDescription()
String getLocalizedDescription()
List<String> getVariables()
String
.
Developers: Add more detailed documentation by editing this comment in org.eclipse.ui.model.workbench/model/UIElements.ecore. There is a GenModel/documentation node under each type and attribute.
Map<String,String> getProperties()
String
,
and the value is of type String
,
Developers: Add more detailed documentation by editing this comment in org.eclipse.ui.model.workbench/model/UIElements.ecore. There is a GenModel/documentation node under each type and attribute.
List<MTrimBar> getTrimBars()
MTrimBar
.
The collection of TrimBars associated with the part represented by this descriptor.
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.