Eclipse GMF Guide (Galileo) - View (Eclipse GMF Documentation)

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:

See Also:: NotationPackage.getView()
** Generated **
Model:: abstract="true"

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

isVisible

boolean isVisible()

Returns the value of the ' Visible ' attribute. The default value is "true".

Returns:: the value of the 'Visible' attribute.
See Also:: setVisible(boolean), NotationPackage.getView_Visible()
** Generated **
Model:: default="true"

setVisible

void setVisible(boolean value)

Sets the value of the ' Visible' attribute.

Parameters:: value - the new value of the 'Visible' attribute.
See Also:: isVisible()
** Generated **

getType

java.lang.String getType()

Returns the value of the ' Type ' attribute. The default value is "".

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

Returns:: the value of the 'Type' attribute.
See Also:: setType(String), NotationPackage.getView_Type()
** Generated **
Model:: default=""

setType

void setType(java.lang.String value)

Sets the value of the ' 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

Parameters:: value - the new value of the 'Type' attribute.
See Also:: getType()
** Generated **

isMutable

boolean isMutable()

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

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

Returns:: the value of the 'Mutable' attribute.
See Also:: setMutable(boolean), NotationPackage.getView_Mutable()
** Generated **
Model:: default="false" transient="true"

setMutable

void setMutable(boolean value)

Sets the value of the ' Mutable' attribute.

Parameters:: value - the new value of the 'Mutable' attribute.
See Also:: isMutable()
** Generated **

getSourceEdges

org.eclipse.emf.common.util.EList getSourceEdges()

Returns the value of the ' Source Edges ' reference list. The list contents are of type Edge. It is bidirectional and its opposite is ' Source'.

The property is a list of zero or more outgoing edges from the view

Must use only for addition/removal purposes. Otherwise check if feature is set first EObject.eIsSet(org.eclipse.emf.ecore.EStructuralFeature)

Returns:: the value of the 'Source Edges' reference list.
See Also:: NotationPackage.getView_SourceEdges(), Edge.getSource()
** Generated **
Model:: type="org.eclipse.gmf.runtime.notation.Edge" opposite="source" resolveProxies="false" transient="true"

getTargetEdges

org.eclipse.emf.common.util.EList getTargetEdges()

Returns the value of the ' Target Edges ' reference list. The list contents are of type Edge. It is bidirectional and its opposite is ' Target'.

The property is a list of zero or more incoming edges to the view

Must use only for addition/removal purposes. Otherwise check if feature is set firts EObject.eIsSet(org.eclipse.emf.ecore.EStructuralFeature)

Returns:: the value of the 'Target Edges' reference list.
See Also:: NotationPackage.getView_TargetEdges(), Edge.getTarget()
** Generated **
Model:: type="org.eclipse.gmf.runtime.notation.Edge" opposite="target" resolveProxies="false" transient="true"

getPersistedChildren

org.eclipse.emf.common.util.EList getPersistedChildren()

Returns the value of the ' Persisted Children ' containment reference list. The list contents are of type Node.

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

Returns:: the value of the 'Persisted Children' containment reference list.
See Also:: NotationPackage.getView_PersistedChildren()
** Generated **
Model:: type="org.eclipse.gmf.runtime.notation.Node" containment="true"

getChildren

org.eclipse.emf.common.util.EList getChildren()

Returns the value of the ' Children 'list. the returned list is an Unmodifable list. The list contents are of type View.

Returns:: the value of the 'Children' list.
See Also:: org.eclipse.gmf.runtime.notation.NotationPackage#getView_Children()

getVisibleChildren

org.eclipse.emf.common.util.EList getVisibleChildren()

Returns an Unmodifable list that contains all the visible children in the Children list. The list contents are of type View.

Returns:: Unmodifable list of Visible children

getStyles

org.eclipse.emf.common.util.EList getStyles()

Returns the value of the ' Styles ' containment reference list. The list contents are of type Style.

The list contains unique instances of these styles.

Must use getStyle(EClass) to access specific style

Returns:: the value of the 'Styles' containment reference list.
See Also:: NotationPackage.getView_Styles()
** Generated **
Model:: type="org.eclipse.gmf.runtime.notation.Style" containment="true"

getElement

org.eclipse.emf.ecore.EObject getElement()

Returns the value of the ' Element ' reference.

This is The referenced business model element

Returns:: the value of the 'Element' reference.
See Also:: isSetElement(), unsetElement(), setElement(EObject), NotationPackage.getView_Element()
** Generated **
Model:: unsettable="true"

setElement

void setElement(org.eclipse.emf.ecore.EObject value)

Sets the value of the ' Element' reference. This is The referenced business model element

Parameters:: value - the new value of the 'Element' reference.
See Also:: isSetElement(), unsetElement(), getElement()
** Generated **

unsetElement

void unsetElement()

Unsets the value of the ' Element' reference.

See Also:: isSetElement(), getElement(), setElement(EObject)
** Generated **

isSetElement

boolean isSetElement()

Returns whether the value of the ' Element' reference is set.

Returns:: whether the value of the 'Element' reference is set.
See Also:: unsetElement(), getElement(), setElement(EObject)
** Generated **

getDiagram


Diagram getDiagram()

Returns the value of the ' Diagram ' reference.

The diagram is the top level container of this view

Returns:: the value of the 'Diagram' reference.
See Also:: NotationPackage.getView_Diagram()
** Generated **
Model:: required="true" transient="true" changeable="false" volatile="true"

getTransientChildren

org.eclipse.emf.common.util.EList getTransientChildren()

Returns the value of the ' Transient Children ' containment reference list. The list contents are of type Node.

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

Returns:: the value of the 'Transient Children' containment reference list.
See Also:: NotationPackage.getView_TransientChildren()
** Generated **
Model:: type="org.eclipse.gmf.runtime.notation.Node" containment="true" transient="true"

getStyle


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 EClasses

** Generated **
Model:

createChild


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

Parameters:: eClass - the EClass to be used in creating the Node object
** Generated **
Model:

createStyle


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

Parameters:: eClass - the EClass to be used in creating the Style object
** Generated **
Model:

getNamedStyle


NamedStyle getNamedStyle(org.eclipse.emf.ecore.EClass eClass,
                         java.lang.String name)

** Generated **
Model:

persistChildren

void persistChildren()

A utililty method to persist all view's children

persist

void persist()

A utililty method to persist the view, it will do nothing if the view is alrady peristed

insertChild

void insertChild(
View child)

A utililty method to insert a persisted child

Parameters:: child - the 'View' to insert.

insertChildAt

void insertChildAt(
View child,
                   int index)

A utililty method to insert a persisted child at a specific index

Parameters:: child - the 'View' to insert.; the - index of the child

insertChild

void insertChild(
View child,
                 boolean persisted)

A utililty method to insert a persisted or transient child

Parameters:: child - the 'View' to insert.; persisted, - indicate if the view will be persisted or not

removeChild

void removeChild(
View child)

A utililty method to remove a child form a view

Parameters:: child - the 'View' to remove

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Runtime

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Guidelines for using Eclipse APIs.

org.eclipse.gmf.runtime.notation Interface View

isVisible

setVisible

getType

setType

isMutable

setMutable

getSourceEdges

getTargetEdges

getPersistedChildren

getChildren

getVisibleChildren

getStyles

getElement

setElement

unsetElement

isSetElement

getDiagram

getTransientChildren

getStyle

createChild

createStyle

getNamedStyle

persistChildren

persist

insertChild

insertChildAt

insertChild

removeChild

org.eclipse.gmf.runtime.notation
Interface View