IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.notation
Interface View

All Superinterfaces:
EModelElement, EObject, Notifier
All Known Subinterfaces:
Diagram, Edge, Node

public interface View
extends EModelElement

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:

See Also:
NotationPackage.getView()

Method Summary
 Node createChild(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(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
 EList getChildren()
          Returns the value of the 'Children' containment reference list.
 Diagram getDiagram()
          Returns the value of the 'Diagram' reference
 EObject getElement()
          Returns the value of the 'Element' reference
 EList getSourceEdges()
          Returns the value of the 'Source Edges' reference list.
 Style getStyle(EClass eClass)
           Looks up a style in the view's collection of styles that extends/implements the given EClass.
 EList getStyles()
          Returns the value of the 'Styles' containment reference list.
 EList getTargetEdges()
          Returns the value of the 'Target Edges' reference list.
 String getType()
          Returns the value of the 'Type' attribute.
 boolean isVisible()
          Returns the value of the 'Visible' attribute.
 void setElement(EObject value)
          Sets the value of the 'Element' reference
 void setType(String value)
          Sets the value of the 'Type' attribute
 void setVisible(boolean value)
          Sets the value of the 'Visible' attribute
 
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

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

setVisible

public void setVisible(boolean value)
Sets the value of the 'Visible' attribute.

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

getType

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

setType

public void setType(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()

getSourceEdges

public 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

Returns:
the value of the 'Source Edges' reference list.
See Also:
NotationPackage.getView_SourceEdges(), Edge.getSource()

getTargetEdges

public 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

Returns:
the value of the 'Target Edges' reference list.
See Also:
NotationPackage.getView_TargetEdges(), Edge.getTarget()

getChildren

public EList getChildren()
Returns the value of the 'Children' containment reference list. The list contents are of type Node.

Returns:
the value of the 'Children' containment reference list.
See Also:
NotationPackage.getView_Children()

getStyles

public 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

Returns:
the value of the 'Styles' containment reference list.
See Also:
NotationPackage.getView_Styles()

getElement

public 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:
setElement(EObject), NotationPackage.getView_Element()

setElement

public void setElement(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:
getElement()

getDiagram

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

getStyle

public Style getStyle(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


createChild

public Node createChild(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

createStyle

public Style createStyle(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

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.