Package de.cau.cs.kieler.klighd.kgraph

Interface KShapeLayout

All Superinterfaces:
EMapPropertyHolder, org.eclipse.emf.ecore.EObject, org.eclipse.elk.graph.properties.IPropertyHolder, KLayoutData, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
KLabel, KNode, KPort
All Known Implementing Classes:
KLabelImpl, KNodeImpl, KPortImpl
public interface KShapeLayout extends KLayoutData
A representation of the model object 'KShape 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:
EMF generated code
EMF model element
interface="true" abstract="true"

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyVector(org.eclipse.elk.core.math.KVector pos)
    Set the position of this shape layout by applying the given vector.
    org.eclipse.elk.core.math.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.klighd.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.elk.graph.properties.IPropertyHolder

    copyProperties, getAllProperties, getProperty, hasProperty, setProperty

    Methods inherited from interface de.cau.cs.kieler.klighd.kgraph.KLayoutData

    isModified, resetModificationFlag

    Methods inherited from interface org.eclipse.emf.common.notify.Notifier

    eAdapters, eDeliver, eNotify, eSetDeliver

  • Method Details

    • getXpos

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

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

      Returns:
      the value of the 'Xpos' attribute.
      See Also:
      EMF generated code
      EMF 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:
      EMF generated code

    • getYpos

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

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

      Returns:
      the value of the 'Ypos' attribute.
      See Also:
      EMF generated code
      EMF 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:
      EMF generated code

    • getWidth

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

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

      Returns:
      the value of the 'Width' attribute.
      See Also:
      EMF generated code
      EMF 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:
      EMF generated code

    • getHeight

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

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

      Returns:
      the value of the 'Height' attribute.
      See Also:
      EMF generated code
      EMF 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:
      EMF generated code

    • 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:
      EMF generated code
      EMF 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:
      EMF generated code

    • 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
      EMF generated code
      EMF model element

    • applyVector

      void applyVector(org.eclipse.elk.core.math.KVector pos)
      Set the position of this shape layout by applying the given vector.
      Parameters:
      pos - the vector for the new position
      EMF generated code
      EMF model element
      posDataType="de.cau.cs.kieler.klighd.kgraph.KVector"

    • createVector

      org.eclipse.elk.core.math.KVector createVector()
      Create a vector from the position of this shape layout.
      Returns:
      the position vector
      EMF generated code
      EMF model element
      dataType="de.cau.cs.kieler.klighd.kgraph.KVector"

    • setSize

      void setSize(float width, float height)
      Set the size of this shape layout.
      Parameters:
      width - the new width
      height - the new height
      EMF generated code
      EMF model element