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

Interface MPartDescriptor

All Superinterfaces:

MApplicationElement, MBindings, MHandlerContainer, MLocalizable, MUILabel

public interface MPartDescriptor
extends MApplicationElement, MUILabel, MHandlerContainer, MBindings

A representation of the model object 'Part Descriptor'.

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'...

Since:

1.0

Restriction:

This interface is not intended to be implemented by clients.

The following features are supported:

• Allow Multiple
• Category
• Menus
• Toolbar
• Closeable
• Dirtyable
• Contribution URI
• Description
• Localized Description
• Variables
• Properties
• Trim Bars

Method Summary

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

Methods inherited from interface org.eclipse.e4.ui.model.application.MApplicationElement

getContributorURI, getElementId, getPersistedState, getTags, getTransientData, setContributorURI, setElementId

Methods inherited from interface org.eclipse.e4.ui.model.application.ui.MUILabel

getIconURI, getLabel, getLocalizedLabel, getLocalizedTooltip, getTooltip, setIconURI, setLabel, setTooltip

Methods inherited from interface org.eclipse.e4.ui.model.application.ui.MLocalizable

updateLocalization

Methods inherited from interface org.eclipse.e4.ui.model.application.commands.MHandlerContainer

getHandlers

Methods inherited from interface org.eclipse.e4.ui.model.application.commands.MBindings

getBindingContexts

Method Detail

isAllowMultiple

boolean isAllowMultiple()

Returns the value of the 'Allow Multiple' attribute.

Determines whether or not the part represented by this descriptot can have multiple instances with a given window.

Returns:

the value of the 'Allow Multiple' attribute.

See Also:

setAllowMultiple(boolean)

setAllowMultiple

void setAllowMultiple(boolean value)

Sets the value of the 'Allow Multiple' attribute.

Parameters:

value - the new value of the 'Allow Multiple' attribute.

See Also:

isAllowMultiple()

getCategory

String getCategory()

Returns the value of the 'Category' attribute.

The category that the view represented by this descriptor belongs to.

Returns:

the value of the 'Category' attribute.

See Also:

setCategory(String)

setCategory

void setCategory(String value)

Sets the value of the 'Category' attribute.

Parameters:

value - the new value of the 'Category' attribute.

See Also:

getCategory()

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 the part represented by this descriptor. 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 itsefl...

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(MToolBar)

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:

getToolbar()

isCloseable

boolean isCloseable()

Returns the value of the 'Closeable' attribute. The default value is "false".

Defines whether instances of views created from this descriptor are closeable by the User.

Returns:

the value of the 'Closeable' attribute.

See Also:

setCloseable(boolean)

setCloseable

void setCloseable(boolean value)

Sets the value of the 'Closeable' attribute.

Parameters:

value - the new value of the 'Closeable' attribute.

See Also:

isCloseable()

isDirtyable

@Deprecated
boolean isDirtyable()

Deprecated. dirtyable is managed by part

Returns the value of the 'Dirtyable' attribute.

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.

Returns:

the value of the 'Dirtyable' attribute.

See Also:

setDirtyable(boolean), Bug 530887

Restriction:

This method is not intented to be referenced by clients.

setDirtyable

@Deprecated
void setDirtyable(boolean value)

Deprecated. dirtyable is managed by part

Sets the value of the 'Dirtyable' attribute.

Parameters:

value - the new value of the 'Dirtyable' attribute.

See Also:

isDirtyable(), Bug 530887

Restriction:

This method is not intented to be referenced by clients.

getContributionURI

String getContributionURI()

Returns the value of the 'Contribution URI' attribute.

The fully qualified path to the class implementing the behavior of the Part.

Returns:

the value of the 'Contribution URI' attribute.

See Also:

setContributionURI(String)

setContributionURI

void setContributionURI(String value)

Sets the value of the 'Contribution URI' attribute.

Parameters:

value - the new value of the 'Contribution URI' attribute.

See Also:

getContributionURI()

getDescription

String getDescription()

Returns the value of the 'Description' attribute.

The description of this Part.

Returns:

the value of the 'Description' attribute.

See Also:

setDescription(String)

setDescription

void setDescription(String value)

Sets the value of the 'Description' attribute.

Parameters:

value - the new value of the 'Description' attribute.

See Also:

getDescription()

getLocalizedDescription

String getLocalizedDescription()

Returns the value of the 'Localized Description' attribute.

Returns:

the value of the 'Localized Description' attribute.

getVariables

List<String> getVariables()

Returns the value of the 'Variables' attribute list. The list contents are 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.

Returns:

the value of the 'Variables' attribute list.

Since:

1.2

getProperties

Map<String,String> getProperties()

Returns the value of the 'Properties' map. The key is of type 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.

Returns:

the value of the 'Properties' map.

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 the part represented by this descriptor.

Returns:

the value of the 'Trim Bars' containment reference list.

Since:

1.3