de.cau.cs.kieler.kiml.klayoutdata
Interface KShapeLayout

All Superinterfaces:
EMapPropertyHolder, EObject, IPropertyHolder, KGraphData, Notifier
All Known Implementing Classes:
KShapeLayoutImpl

public interface KShapeLayout
extends KGraphData

A representation of the model object 'Shape Layout'. This layout data contains information for graph elements for which rectangular shape is assumed for layout, such as nodes, ports, and labels. Each graph element has either a shape layout or an edge layout attached. The shape layout of nodes has insets.

Layout coordinates for nodes, ports, and node labels are relative to the parent node. The insets of the parent node are not included in the relative coordinates of child nodes, but they are included in the relative coordinates of ports and node labels. For edge labels the rules defined in KEdgeLayout apply. Port labels are relative to their ports.

The following features are supported:

See Also:
KLayoutDataPackage.getKShapeLayout()
Rating yellow
(2011-03-14) reviewed by cmot, cds
Generated:
This code was automatically generated.
Model element

Method Summary
 void applyVector(KVector pos)
          Set the position of this shape layout by applying the given vector.
 KVector createVector()
          Create a vector from the position of this shape layout.
 float getHeight()
          Returns the value of the 'Height' attribute.
 KInsets getInsets()
          Returns the value of the 'Insets' containment reference.
 float getWidth()
          Returns the value of the 'Width' attribute.
 float getXpos()
          Returns the value of the 'Xpos' attribute.
 float getYpos()
          Returns the value of the 'Ypos' attribute.
 void setHeight(float value)
          Sets the value of the 'Height' attribute.
 void setInsets(KInsets value)
          Sets the value of the 'Insets' containment reference.
 void setPos(float x, float y)
          Set the position of this shape layout.
 void setSize(float width, float height)
          Set the size of this shape layout.
 void setWidth(float value)
          Sets the value of the 'Width' attribute.
 void setXpos(float value)
          Sets the value of the 'Xpos' attribute.
 void setYpos(float value)
          Sets the value of the 'Ypos' attribute.
 
Methods inherited from interface de.cau.cs.kieler.core.kgraph.EMapPropertyHolder
getPersistentEntries, getProperties, makePersistent
 
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
 
Methods inherited from interface de.cau.cs.kieler.core.properties.IPropertyHolder
copyProperties, getAllProperties, getProperty, setProperty
 

Method Detail

getXpos

float getXpos()
Returns the value of the 'Xpos' attribute. The default value is "0.0f".

Returns:
the value of the 'Xpos' attribute.
See Also:
setXpos(float), KLayoutDataPackage.getKShapeLayout_Xpos()
Generated:
This code was automatically generated.
Model element:
default=0.0f

setXpos

void setXpos(float value)
Sets the value of the 'Xpos' attribute.

Parameters:
value - the new value of the 'Xpos' attribute.
See Also:
getXpos()
Generated:
This code was automatically generated.

getYpos

float getYpos()
Returns the value of the 'Ypos' attribute. The default value is "0.0f".

Returns:
the value of the 'Ypos' attribute.
See Also:
setYpos(float), KLayoutDataPackage.getKShapeLayout_Ypos()
Generated:
This code was automatically generated.
Model element:
default=0.0f

setYpos

void setYpos(float value)
Sets the value of the 'Ypos' attribute.

Parameters:
value - the new value of the 'Ypos' attribute.
See Also:
getYpos()
Generated:
This code was automatically generated.

getWidth

float getWidth()
Returns the value of the 'Width' attribute. The default value is "0.0f".

Returns:
the value of the 'Width' attribute.
See Also:
setWidth(float), KLayoutDataPackage.getKShapeLayout_Width()
Generated:
This code was automatically generated.
Model element:
default=0.0f

setWidth

void setWidth(float value)
Sets the value of the 'Width' attribute.

Parameters:
value - the new value of the 'Width' attribute.
See Also:
getWidth()
Generated:
This code was automatically generated.

getHeight

float getHeight()
Returns the value of the 'Height' attribute. The default value is "0.0f".

Returns:
the value of the 'Height' attribute.
See Also:
setHeight(float), KLayoutDataPackage.getKShapeLayout_Height()
Generated:
This code was automatically generated.
Model element:
default=0.0f

setHeight

void setHeight(float value)
Sets the value of the 'Height' attribute.

Parameters:
value - the new value of the 'Height' attribute.
See Also:
getHeight()
Generated:
This code was automatically generated.

getInsets

KInsets getInsets()
Returns the value of the 'Insets' containment reference.

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

Returns:
the value of the 'Insets' containment reference.
See Also:
setInsets(KInsets), KLayoutDataPackage.getKShapeLayout_Insets()
Generated:
This code was automatically generated.
Model element:
containment=true

setInsets

void setInsets(KInsets value)
Sets the value of the 'Insets' containment reference.

Parameters:
value - the new value of the 'Insets' containment reference.
See Also:
getInsets()
Generated:
This code was automatically generated.

setPos

void setPos(float x,
            float y)
Set the position of this shape layout.

Parameters:
x - the new x coordinate value
y - the new y coordinate value
Generated:
This code was automatically generated.
Model element

applyVector

void applyVector(KVector pos)
Set the position of this shape layout by applying the given vector.

Parameters:
pos - the vector for the new position
Generated:
This code was automatically generated.
Model element:
posType=de.cau.cs.kieler.kiml.klayoutdata.KVector

createVector

KVector createVector()
Create a vector from the position of this shape layout.

Returns:
the position vector
Generated:
This code was automatically generated.
Model element:
type=de.cau.cs.kieler.kiml.klayoutdata.KVector

setSize

void setSize(float width,
             float height)
Set the size of this shape layout.

Parameters:
width - the new width
height - the new height
Generated:
This code was automatically generated.
Model element