org.eclipse.gmf.codegen.gmfgen
Interface GenCommonBase

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
GenChildContainer, GenChildLabelNode, GenChildNode, GenChildSideAffixedNode, GenCompartment, GenContainerBase, GenDiagram, GenExternalNodeLabel, GenLabel, GenLink, GenLinkEnd, GenLinkLabel, GenNode, GenNodeLabel, GenTopLevelNode
All Known Implementing Classes:
GenChildContainerImpl, GenChildLabelNodeImpl, GenChildNodeImpl, GenChildSideAffixedNodeImpl, GenCommonBaseImpl, GenCompartmentImpl, GenDiagramImpl, GenExternalNodeLabelImpl, GenLabelImpl, GenLinkImpl, GenLinkLabelImpl, GenNodeImpl, GenNodeLabelImpl, GenTopLevelNodeImpl

public interface GenCommonBase
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Gen Common Base'. One that combines attributes that are essential for diagram elements

The following features are supported:

See Also:
GMFGenPackage.getGenCommonBase()
Generated
Model Properties:
abstract="true" annotation="http://www.eclipse.org/gmf/2005/constraints ocl='styles->forAll(style|style.ecoreClass.eAllSuperTypes->including(style.ecoreClass)->one(ePackage.name = \'notation\' and name = \'Style\'))' description='Each style must be a notation::Style or sub-class'"

Field Summary
static String DEFAULT_CLASS_NAME_PREFIX
           
static String EDIT_PART_SUFFIX
           
static String ITEM_SEMANTIC_EDIT_POLICY_SUFFIX
           
static String NOTATION_VIEW_FACTORY_SUFFIX
           
 
Method Summary
 org.eclipse.emf.common.util.EList<Behaviour> getBehaviour()
          Returns the value of the 'Behaviour' containment reference list.
<T extends Behaviour>
List<T>
getBehaviour(Class<T> behaviourClass)
          Filter list of behavior to instances of particular kind.
 String getClassNamePrefix()
           
 String getClassNameSuffux()
           
 GenDiagram getDiagram()
           
 org.eclipse.emf.codegen.ecore.genmodel.GenClass getDiagramRunTimeClass()
          Returns the value of the 'Diagram Run Time Class' reference.
 String getEditPartClassName()
          Returns the value of the 'Edit Part Class Name' attribute.
 String getEditPartQualifiedClassName()
           
 ElementType getElementType()
          Returns the value of the 'Element Type' containment reference.
 String getItemSemanticEditPolicyClassName()
          Returns the value of the 'Item Semantic Edit Policy Class Name' attribute.
 String getItemSemanticEditPolicyQualifiedClassName()
           
 ViewmapLayoutType getLayoutType()
           
 String getNotationViewFactoryClassName()
          Returns the value of the 'Notation View Factory Class Name' attribute.
 String getNotationViewFactoryQualifiedClassName()
           
 org.eclipse.emf.common.util.EList<org.eclipse.emf.codegen.ecore.genmodel.GenClass> getStyles()
          Returns the value of the 'Styles' reference list.
 String getUniqueIdentifier()
          This unique string identifier could be used to construct unique identifiers in generated java code
 Viewmap getViewmap()
          Returns the value of the 'Viewmap' containment reference.
 int getVisualID()
          Returns the value of the 'Visual ID' attribute.
 boolean isSansDomain()
          Returns the value of the 'Sans Domain' attribute.
 void setDiagramRunTimeClass(org.eclipse.emf.codegen.ecore.genmodel.GenClass value)
          Sets the value of the 'Diagram Run Time Class' reference.
 void setEditPartClassName(String value)
          Sets the value of the 'Edit Part Class Name' attribute.
 void setElementType(ElementType value)
          Sets the value of the 'Element Type' containment reference.
 void setItemSemanticEditPolicyClassName(String value)
          Sets the value of the 'Item Semantic Edit Policy Class Name' attribute.
 void setNotationViewFactoryClassName(String value)
          Sets the value of the 'Notation View Factory Class Name' attribute.
 void setViewmap(Viewmap value)
          Sets the value of the 'Viewmap' containment reference.
 void setVisualID(int value)
          Sets the value of the 'Visual ID' attribute.
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

EDIT_PART_SUFFIX

static final String EDIT_PART_SUFFIX
See Also:
Constant Field Values

ITEM_SEMANTIC_EDIT_POLICY_SUFFIX

static final String ITEM_SEMANTIC_EDIT_POLICY_SUFFIX
See Also:
Constant Field Values

NOTATION_VIEW_FACTORY_SUFFIX

static final String NOTATION_VIEW_FACTORY_SUFFIX
See Also:
Constant Field Values

DEFAULT_CLASS_NAME_PREFIX

static final String DEFAULT_CLASS_NAME_PREFIX
See Also:
Constant Field Values
Method Detail

getDiagramRunTimeClass

org.eclipse.emf.codegen.ecore.genmodel.GenClass getDiagramRunTimeClass()
Returns the value of the 'Diagram Run Time Class' reference.

If the meaning of the 'Diagram Run Time Class' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Diagram Run Time Class' reference.
See Also:
setDiagramRunTimeClass(GenClass), GMFGenPackage.getGenCommonBase_DiagramRunTimeClass()
Generated
Model Properties:
required="true"

setDiagramRunTimeClass

void setDiagramRunTimeClass(org.eclipse.emf.codegen.ecore.genmodel.GenClass value)
Sets the value of the 'Diagram Run Time Class' reference.

Parameters:
value - the new value of the 'Diagram Run Time Class' reference.
See Also:
getDiagramRunTimeClass()
Generated

getVisualID

int getVisualID()
Returns the value of the 'Visual ID' attribute. way to decide which editpart to use for specific diagram element. Maps to attribute in DRT.

Returns:
the value of the 'Visual ID' attribute.
See Also:
setVisualID(int), GMFGenPackage.getGenCommonBase_VisualID()
Generated
Model Properties:
required="true" annotation="http://www.eclipse.org/gmf/2005/constraints ocl='visualID >= 0' description='Visual ID must be a non-negative integer'"

setVisualID

void setVisualID(int value)
Sets the value of the 'Visual ID' attribute.

Parameters:
value - the new value of the 'Visual ID' attribute.
See Also:
getVisualID()
Generated

getElementType

ElementType getElementType()
Returns the value of the 'Element Type' containment reference. It is bidirectional and its opposite is 'Diagram Element'.

If the meaning of the 'Element Type' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Element Type' containment reference.
See Also:
setElementType(ElementType), GMFGenPackage.getGenCommonBase_ElementType(), ElementType.getDiagramElement()
Generated
Model Properties:
opposite="diagramElement" containment="true"

setElementType

void setElementType(ElementType value)
Sets the value of the 'Element Type' containment reference.

Parameters:
value - the new value of the 'Element Type' containment reference.
See Also:
getElementType()
Generated

getEditPartClassName

String getEditPartClassName()
Returns the value of the 'Edit Part Class Name' attribute.

If the meaning of the 'Edit Part Class Name' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Edit Part Class Name' attribute.
See Also:
setEditPartClassName(String), GMFGenPackage.getGenCommonBase_EditPartClassName()
Generated
Model Properties:

setEditPartClassName

void setEditPartClassName(String value)
Sets the value of the 'Edit Part Class Name' attribute.

Parameters:
value - the new value of the 'Edit Part Class Name' attribute.
See Also:
getEditPartClassName()
Generated

getItemSemanticEditPolicyClassName

String getItemSemanticEditPolicyClassName()
Returns the value of the 'Item Semantic Edit Policy Class Name' attribute.

If the meaning of the 'Item Semantic Edit Policy Class Name' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Item Semantic Edit Policy Class Name' attribute.
See Also:
setItemSemanticEditPolicyClassName(String), GMFGenPackage.getGenCommonBase_ItemSemanticEditPolicyClassName()
Generated
Model Properties:

setItemSemanticEditPolicyClassName

void setItemSemanticEditPolicyClassName(String value)
Sets the value of the 'Item Semantic Edit Policy Class Name' attribute.

Parameters:
value - the new value of the 'Item Semantic Edit Policy Class Name' attribute.
See Also:
getItemSemanticEditPolicyClassName()
Generated

getNotationViewFactoryClassName

String getNotationViewFactoryClassName()
Returns the value of the 'Notation View Factory Class Name' attribute.

If the meaning of the 'Notation View Factory Class Name' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Notation View Factory Class Name' attribute.
See Also:
setNotationViewFactoryClassName(String), GMFGenPackage.getGenCommonBase_NotationViewFactoryClassName()
Generated
Model Properties:
annotation="http://www.eclipse.org/gmf/2006/deprecated documentation='ViewFactories are no longer generated'"

setNotationViewFactoryClassName

void setNotationViewFactoryClassName(String value)
Sets the value of the 'Notation View Factory Class Name' attribute.

Parameters:
value - the new value of the 'Notation View Factory Class Name' attribute.
See Also:
getNotationViewFactoryClassName()
Generated

getViewmap

Viewmap getViewmap()
Returns the value of the 'Viewmap' containment reference.

If the meaning of the 'Viewmap' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Viewmap' containment reference.
See Also:
setViewmap(Viewmap), GMFGenPackage.getGenCommonBase_Viewmap()
Generated
Model Properties:
containment="true" required="true"

setViewmap

void setViewmap(Viewmap value)
Sets the value of the 'Viewmap' containment reference.

Parameters:
value - the new value of the 'Viewmap' containment reference.
See Also:
getViewmap()
Generated

getStyles

org.eclipse.emf.common.util.EList<org.eclipse.emf.codegen.ecore.genmodel.GenClass> getStyles()
Returns the value of the 'Styles' reference list. The list contents are of type GenClass.

If the meaning of the 'Styles' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Styles' reference list.
See Also:
GMFGenPackage.getGenCommonBase_Styles()
Generated
Model Properties:

getBehaviour

org.eclipse.emf.common.util.EList<Behaviour> getBehaviour()
Returns the value of the 'Behaviour' containment reference list. The list contents are of type Behaviour. It is bidirectional and its opposite is 'Subject'.

If the meaning of the 'Behaviour' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Behaviour' containment reference list.
See Also:
GMFGenPackage.getGenCommonBase_Behaviour(), Behaviour.getSubject()
Generated
Model Properties:
opposite="subject" containment="true"

isSansDomain

boolean isSansDomain()
Returns the value of the 'Sans Domain' attribute.

If the meaning of the 'Sans Domain' attribute isn't clear, there really should be more of a description here...

Indicates this element has no associated domain model. IOW, pure design element.

Returns:
the value of the 'Sans Domain' attribute.
See Also:
GMFGenPackage.getGenCommonBase_SansDomain()
Generated
Model Properties:
transient="true" changeable="false" volatile="true" derived="true"

getBehaviour

<T extends Behaviour> List<T> getBehaviour(Class<T> behaviourClass)
Filter list of behavior to instances of particular kind. Note, behaviour returned is not necessarily owned (think contained) by this element, as this method unwraps SharedBehaviour

Parameters:
behaviourClass - should be Behaviour.class.isAssignableFrom(behaviourClass)

getClassNamePrefix

String getClassNamePrefix()

If the meaning of the 'Class Name Prefix' attribute isn't clear, there really should be more of a description here...

Generated
Model Properties:
kind="operation"

getClassNameSuffux

String getClassNameSuffux()

If the meaning of the 'Class Name Suffux' attribute isn't clear, there really should be more of a description here...

Generated
Model Properties:
kind="operation" annotation="http://www.eclipse.org/gmf/2006/deprecated documentation='No longer in use'"

getUniqueIdentifier

String getUniqueIdentifier()
This unique string identifier could be used to construct unique identifiers in generated java code

Generated
Model Properties:
kind="operation"

getLayoutType

ViewmapLayoutType getLayoutType()

Generated
Model Properties:
kind="operation"

getEditPartQualifiedClassName

String getEditPartQualifiedClassName()

Generated
Model Properties:
kind="operation"

getItemSemanticEditPolicyQualifiedClassName

String getItemSemanticEditPolicyQualifiedClassName()

Generated
Model Properties:
kind="operation"

getNotationViewFactoryQualifiedClassName

String getNotationViewFactoryQualifiedClassName()

Generated
Model Properties:
kind="operation" annotation="http://www.eclipse.org/gmf/2006/deprecated documentation='ViewFactories are no longer generated'"

getDiagram

GenDiagram getDiagram()

Generated
Model Properties:
kind="operation"


Copyright © 2012. All Rights Reserved.