|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface View
A representation of the model object 'View'.
The views are the central abstraction in a notation model. View objects reference a business model and contain other notation objects that together hold all the properties needed to visualize that business model. The reason the view object does not have all the properties itself but rather delegates to other abstractions is to allow for easy extension of properties.
The following features are supported:
Visible
Type
Mutable
Source Edges
Target Edges
Persisted Children
Styles
Element
Diagram
Transient Children
NotationPackage.getView()
Method Summary | |
---|---|
Node |
createChild(org.eclipse.emf.ecore.EClass eClass)
A utililty method to create a new Node from the given eClass paramter
and then inserts the object in the view's Children collection
|
Style |
createStyle(org.eclipse.emf.ecore.EClass eClass)
A utililty method to create a new Style from the given eClass paramter
and then inserts the object in the view's Styles collection
|
org.eclipse.emf.common.util.EList |
getChildren()
Returns the value of the 'Children'list. |
Diagram |
getDiagram()
Returns the value of the 'Diagram' reference |
org.eclipse.emf.ecore.EObject |
getElement()
Returns the value of the 'Element' reference |
NamedStyle |
getNamedStyle(org.eclipse.emf.ecore.EClass eClass,
java.lang.String name)
|
org.eclipse.emf.common.util.EList |
getPersistedChildren()
Returns the value of the 'Persisted Children' containment reference list. |
org.eclipse.emf.common.util.EList |
getSourceEdges()
Returns the value of the 'Source Edges' reference list. |
Style |
getStyle(org.eclipse.emf.ecore.EClass eClass)
Looks up a style in the view's collection of styles that extends/implements the given EClass . |
org.eclipse.emf.common.util.EList |
getStyles()
Returns the value of the 'Styles' containment reference list. |
org.eclipse.emf.common.util.EList |
getTargetEdges()
Returns the value of the 'Target Edges' reference list. |
org.eclipse.emf.common.util.EList |
getTransientChildren()
Returns the value of the 'Transient Children' containment reference list. |
java.lang.String |
getType()
Returns the value of the 'Type' attribute. |
org.eclipse.emf.common.util.EList |
getVisibleChildren()
Returns an Unmodifable list that contains all the visible children in the Children list. |
void |
insertChild(View child)
A utililty method to insert a persisted child |
void |
insertChild(View child,
boolean persisted)
A utililty method to insert a persisted or transient child |
void |
insertChildAt(View child,
int index)
A utililty method to insert a persisted child at a specific index |
boolean |
isMutable()
Returns the value of the 'Mutable' attribute. |
boolean |
isSetElement()
Returns whether the value of the ' Element ' reference is set |
boolean |
isVisible()
Returns the value of the 'Visible' attribute. |
void |
persist()
A utililty method to persist the view, it will do nothing if the view is alrady peristed |
void |
persistChildren()
A utililty method to persist all view's children |
void |
removeChild(View child)
A utililty method to remove a child form a view |
void |
setElement(org.eclipse.emf.ecore.EObject value)
Sets the value of the ' Element ' reference |
void |
setMutable(boolean value)
Sets the value of the ' Mutable ' attribute |
void |
setType(java.lang.String value)
Sets the value of the ' Type ' attribute |
void |
setVisible(boolean value)
Sets the value of the ' Visible ' attribute |
void |
unsetElement()
Unsets the value of the ' Element ' reference |
Methods inherited from interface org.eclipse.emf.ecore.EModelElement |
---|
getEAnnotation, getEAnnotations |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
---|
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
---|
eAdapters, eDeliver, eNotify, eSetDeliver |
Method Detail |
---|
boolean isVisible()
"true"
.
setVisible(boolean)
,
NotationPackage.getView_Visible()
void setVisible(boolean value)
Visible
' attribute.
value
- the new value of the 'Visible' attribute.isVisible()
java.lang.String getType()
""
.
The view's type is a context-defined unique string representing the kind of the view. It is usually used if the view is a subview or if it is a top level view that does not have a business model
setType(String)
,
NotationPackage.getView_Type()
void setType(java.lang.String value)
Type
' attribute.
The view's type is a context-defined unique string representing the kind of the view. It is usually used if the view is a subview or if it is a top level view that does not have a business model
value
- the new value of the 'Type' attribute.getType()
boolean isMutable()
"false"
.
If the meaning of the 'Mutable' attribute isn't clear, there really should be more of a description here...
setMutable(boolean)
,
NotationPackage.getView_Mutable()
void setMutable(boolean value)
Mutable
' attribute.
value
- the new value of the 'Mutable' attribute.isMutable()
org.eclipse.emf.common.util.EList getSourceEdges()
Edge
.
It is bidirectional and its opposite is 'Source
'.
The property is a list of zero or more outgoing edges from the view
NotationPackage.getView_SourceEdges()
,
Edge.getSource()
org.eclipse.emf.common.util.EList getTargetEdges()
Edge
.
It is bidirectional and its opposite is 'Target
'.
The property is a list of zero or more incoming edges to the view
NotationPackage.getView_TargetEdges()
,
Edge.getTarget()
org.eclipse.emf.common.util.EList getPersistedChildren()
Node
.
If the meaning of the 'Persisted Children' containment reference list isn't clear, there really should be more of a description here...
NotationPackage.getView_PersistedChildren()
org.eclipse.emf.common.util.EList getChildren()
View
.
org.eclipse.gmf.runtime.notation.NotationPackage#getView_Children()
org.eclipse.emf.common.util.EList getVisibleChildren()
View
.
org.eclipse.emf.common.util.EList getStyles()
Style
.
The list contains unique instances of these styles
NotationPackage.getView_Styles()
org.eclipse.emf.ecore.EObject getElement()
This is The referenced business model element
isSetElement()
,
unsetElement()
,
setElement(EObject)
,
NotationPackage.getView_Element()
void setElement(org.eclipse.emf.ecore.EObject value)
Element
' reference.
This is The referenced business model element
value
- the new value of the 'Element' reference.isSetElement()
,
unsetElement()
,
getElement()
void unsetElement()
Element
' reference.
isSetElement()
,
getElement()
,
setElement(EObject)
boolean isSetElement()
Element
' reference is set.
unsetElement()
,
getElement()
,
setElement(EObject)
Diagram getDiagram()
The diagram is the top level container of this view
NotationPackage.getView_Diagram()
org.eclipse.emf.common.util.EList getTransientChildren()
Node
.
If the meaning of the 'Transient Children' containment reference list isn't clear, there really should be more of a description here...
NotationPackage.getView_TransientChildren()
Style getStyle(org.eclipse.emf.ecore.EClass eClass)
Looks up a style in the view's collection of styles that extends/implements
the given EClass
. Thefore the returned style instance is not guaranteed
to be unique for different EClass
es
Node createChild(org.eclipse.emf.ecore.EClass eClass)
A utililty method to create a new Node
from the given eClass
paramter
and then inserts the object in the view's Children collection
eClass
- the EClass
to be used in creating the Node
object
Style createStyle(org.eclipse.emf.ecore.EClass eClass)
A utililty method to create a new Style
from the given eClass
paramter
and then inserts the object in the view's Styles collection
eClass
- the EClass
to be used in creating the Style
object
NamedStyle getNamedStyle(org.eclipse.emf.ecore.EClass eClass, java.lang.String name)
void persistChildren()
A utililty method to persist all view's children
void persist()
A utililty method to persist the view, it will do nothing if the view is alrady peristed
void insertChild(View child)
A utililty method to insert a persisted child
child
- the 'View' to insert.
void insertChildAt(View child, int index)
A utililty method to insert a persisted child at a specific index
child
- the 'View' to insert.the
- index of the child
void insertChild(View child, boolean persisted)
A utililty method to insert a persisted or transient child
child
- the 'View' to insert.persisted,
- indicate if the view will be persisted or not
void removeChild(View child)
A utililty method to remove a child form a view
child
- the 'View' to remove
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.