IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.notation
Interface Guide

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

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

A representation of the model object 'Guide'.

A guide is a constraint on the x-y layout of nodes. A guide is defined by a position along one the of the diagram rulers. Nodes attached to a guide can be attached by a varierty of alignments

The following features are supported:

See Also:
NotationPackage.getGuide()

Method Summary
 org.eclipse.emf.common.util.EMap getNodeMap()
          Returns the value of the 'Node Map' map.
 int getPosition()
          Returns the value of the 'Position' attribute.
 void setPosition(int value)
          Sets the value of the 'Position' attribute
 
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

getPosition

public int getPosition()
Returns the value of the 'Position' attribute. The default value is "0".

The position is the distance along the diagram ruler of the guide

Returns:
the value of the 'Position' attribute.
See Also:
setPosition(int), NotationPackage.getGuide_Position()

setPosition

public void setPosition(int value)
Sets the value of the 'Position' attribute.

The position is the distance along the diagram ruler of the guide

Parameters:
value - the new value of the 'Position' attribute.
See Also:
getPosition()

getNodeMap

public org.eclipse.emf.common.util.EMap getNodeMap()
Returns the value of the 'Node Map' map. The key is of type Node, and the value is of type Alignment,

The map is an unordered map from nodes to their alignment in respect to the guide.

Returns:
the value of the 'Node Map' map.
See Also:
NotationPackage.getGuide_NodeMap()

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

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