org.eclipse.e4.ui.model.fragment

Interface MStringModelFragment

All Superinterfaces:

MModelFragment

All Known Implementing Classes:

StringModelFragmentImpl

public interface MStringModelFragment
extends MModelFragment

A representation of the model object 'String Model Fragment'.

Developers: Add more detailed documentation by editing this comment in /org.eclipse.e4.ui.model.workbench/model/ModelFragment.ecore. There is a GenModel/documentation node under each type and attribute.

Since:

1.0

The following features are supported:

• Featurename
• Parent Element Id
• Position In List

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFeaturename() Returns the value of the 'Featurename' attribute
java.lang.String	getParentElementId() Returns the value of the 'Parent Element Id' attribute
java.lang.String	getPositionInList() Returns the value of the 'Position In List' attribute
void	setFeaturename(java.lang.String value) Sets the value of the 'Featurename' attribute
void	setParentElementId(java.lang.String value) Sets the value of the 'Parent Element Id' attribute
void	setPositionInList(java.lang.String value) Sets the value of the 'Position In List' attribute

Methods inherited from interface org.eclipse.e4.ui.model.fragment.MModelFragment

getElements, merge

Method Detail

getFeaturename

java.lang.String getFeaturename()

Returns the value of the 'Featurename' attribute.

Developers: Add more detailed documentation by editing this comment in /org.eclipse.e4.ui.model.workbench/model/ModelFragment.ecore. There is a GenModel/documentation node under each type and attribute.

Returns:

the value of the 'Featurename' attribute.

See Also:

setFeaturename(String)

setFeaturename

void setFeaturename(java.lang.String value)

Sets the value of the 'Featurename' attribute.

Parameters:

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

See Also:

getFeaturename()

getParentElementId

java.lang.String getParentElementId()

Returns the value of the 'Parent Element Id' attribute.

The parentElementId specifies the targeted parent or parents when a fragment is merged. The ID can be specified in 3 ways:

1. elementId (a single elementId)
2. elementId1,elementId2,elementId3 (a comma delimited list of elementIds)
3. xpath:[xpath goes here] (an xpath expression)

The following is an xpath example targeting 2 destinations in the model:

 xpath://*[@elementId='app.menu.primary' or @elementId='app.menu.secondary']
 

The parentElementId expression must not be null, but may be an empty string if the fragment did not specify a target.

Developers: Add more detailed documentation by editing this comment in /org.eclipse.e4.ui.model.workbench/model/ModelFragment.ecore. There is a GenModel/documentation node under each type and attribute.

Returns:

the value of the 'Parent Element Id' attribute.

See Also:

setParentElementId(String)

setParentElementId

void setParentElementId(java.lang.String value)

Sets the value of the 'Parent Element Id' attribute.

Parameters:

value - the new value of the 'Parent Element Id' attribute.

See Also:

getParentElementId()

getPositionInList

java.lang.String getPositionInList()

Returns the value of the 'Position In List' attribute.

Developers: Add more detailed documentation by editing this comment in /org.eclipse.e4.ui.model.workbench/model/ModelFragment.ecore. There is a GenModel/documentation node under each type and attribute.

Returns:

the value of the 'Position In List' attribute.

See Also:

setPositionInList(String)

setPositionInList

void setPositionInList(java.lang.String value)

Sets the value of the 'Position In List' attribute.

Parameters:

value - the new value of the 'Position In List' attribute.

See Also:

getPositionInList()