Package de.cau.cs.kieler.klighd.krendering.extensions

Class KContainerRenderingExtensions

java.lang.Object

de.cau.cs.kieler.klighd.krendering.extensions.KContainerRenderingExtensions

public class KContainerRenderingExtensions
extends Object

This class contains lots of convenient helper functions for composing and configuring KRendering-based view models. In order to be consistent with the further extension classes the extension methods are non-static ones requiring this class to be instantiated. Since this class doesn't declare any fields (i.e. required memory) except the reference of further extensions classes the instantiation should not be a problem. The instantiation may be done directly by calling 'new KContainerRenderingExtensions()' or by delegating that to a dependency injection framework.

NOTE: Do NOT introduce create extensions or other continuous memory in that class!

Author:

chsch, alb

This class contains Xtend extension methods.

Constructor Summary

Constructors

Constructor	Description
KContainerRenderingExtensions()

Method Summary

Modifier and Type	Method	Description
KArc	addArc(KContainerRendering cr)
<T extends KRendering> T	addChild(KContainerRendering parent, T child)
KChildArea	addChildArea(KContainerRendering cr)
KCustomRendering	addCustomRendering(KContainerRendering cr)
KCustomRendering	addCustomRendering(KContainerRendering cr, Object figureObject)
KEllipse	addEllipse(KContainerRendering cr)
KEllipse	addEllipticalClip(KImage image)	Sets a KEllipse clip shape on the provided image. Set area or point placement data on this (returned) ellipse as usual in order to determine the clip area.
KRectangle	addGridBox(KContainerRendering cr, float widthHint, float heightHint, KPosition topLeft, KPosition bottomRight)
KPolyline	addHorizontalLine(KContainerRendering cr, float leftRightAbsIndent)
KPolyline	addHorizontalLine(KContainerRendering cr, float leftRightAbsIndent, float lineWidth)
KPolyline	addHorizontalLine(KContainerRendering cr, PositionReferenceY y, float absIndent)
KPolyline	addHorizontalLine(KContainerRendering cr, PositionReferenceY y, float absIndent, float lineWidth)
KPolyline	addHorizontalSeperatorLine(KContainerRendering cr, float lineWidth, int spacing)
KImage	addImage(KContainerRendering cr, Object imageObj)
KImage	addImage(KContainerRendering cr, String bundleId, String imagePath)
KPolygon	addPolygon(KContainerRendering cr)
KPolygon	addPolygonClip(KImage image)	Sets a KPolygon clip shape on the provided image. Add KPositions on this (returned) polygon as usual in order to determine the clip area.
KPolyline	addPolyline(KContainerRendering cr)
KPolyline	addPolyline(KContainerRendering cr, float lineWidth)
KPolyline	addPolyline(KContainerRendering cr, float lineWidth, List<KPosition> points)
KRectangle	addRectangle(KContainerRendering cr)
KRectangle	addRectangularClip(KImage image)	Sets a KRectangle clip shape on the provided image. Set area or point placement data on this (returned) rectangle as usual in order to determine the clip area.
KRoundedRectangle	addRoundedRectangle(KContainerRendering cr, float cWidth, float cHeight)
KRoundedRectangle	addRoundedRectangle(KContainerRendering cr, float cWidth, float cHeight, float lineWidth)
KText	addText(KContainerRendering cr, String text)
KPolyline	addVerticalLine(KContainerRendering cr, PositionReferenceX x, float absIndent)
KPolyline	addVerticalLine(KContainerRendering cr, PositionReferenceX x, float absIndent, float lineWidth)
KPolygon	drawArrow(KContainerRendering cr)
KPolygon	drawTriangle(KContainerRendering cr)
KGridPlacement	setGridPlacement(KContainerRendering cr, int cols)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KContainerRenderingExtensions

public KContainerRenderingExtensions()

Method Details

addChild

public <T extends KRendering> T addChild(KContainerRendering parent,
 T child)

Returns:

the child!

addChildArea

public KChildArea addChildArea(KContainerRendering cr)

addArc

public KArc addArc(KContainerRendering cr)

Extension Category:

composition

addEllipse

public KEllipse addEllipse(KContainerRendering cr)

Extension Category:

composition

addPolygon

public KPolygon addPolygon(KContainerRendering cr)

Extension Category:

composition

addRectangle

public KRectangle addRectangle(KContainerRendering cr)

Extension Category:

composition

addRoundedRectangle

public KRoundedRectangle addRoundedRectangle(KContainerRendering cr,
 float cWidth,
 float cHeight)

Extension Category:

composition

addRoundedRectangle

public KRoundedRectangle addRoundedRectangle(KContainerRendering cr,
 float cWidth,
 float cHeight,
 float lineWidth)

Extension Category:

composition

addText

public KText addText(KContainerRendering cr,
 String text)

addImage

public KImage addImage(KContainerRendering cr,
 String bundleId,
 String imagePath)

addImage

public KImage addImage(KContainerRendering cr,
 Object imageObj)

addRectangularClip

public KRectangle addRectangularClip(KImage image)

Sets a KRectangle clip shape on the provided image.
Set area or point placement data on this (returned) rectangle as usual in order to determine the clip area.

Extension Category:

composition

Code Example:

...addImage(...).addRectangularClip .addAreaPlacementData.from(LEFT, 3, 0, TOP, 3, 0).to(RIGHT, 3, 0, BOTTOM, 3, 0);

addEllipticalClip

public KEllipse addEllipticalClip(KImage image)

Sets a KEllipse clip shape on the provided image.
Set area or point placement data on this (returned) ellipse as usual in order to determine the clip area.

Extension Category:

composition

Code Example:

...addImage(...).addEllipticalClip .addAreaPlacementData.from(LEFT, 3, 0, TOP, 3, 0).to(RIGHT, 3, 0, BOTTOM, 3, 0);

addPolygonClip

public KPolygon addPolygonClip(KImage image)

Sets a KPolygon clip shape on the provided image.
Add KPositions on this (returned) polygon as usual in order to determine the clip area.

Extension Category:

composition

Code Example:

..addImage(...).addPolygonClip.addKPosition(LEFT, 3, 0, TOP, 3, 0) .addKPosition(RIGHT, 3, 0, TOP, 3, 0) .addKPosition(LEFT, 0, 0.5f, BOTTOM, 3, 0);

addCustomRendering

public KCustomRendering addCustomRendering(KContainerRendering cr)

addCustomRendering

public KCustomRendering addCustomRendering(KContainerRendering cr,
 Object figureObject)

setGridPlacement

public KGridPlacement setGridPlacement(KContainerRendering cr,
 int cols)

Extension Category:

microLayout

Code Example:

rectangle.setGridPlacement(1).from(LEFT, 0, 0, TOP, padding - 3, 0).to(RIGHT, 0, 0, BOTTOM, 0, 0)

addGridBox

public KRectangle addGridBox(KContainerRendering cr,
 float widthHint,
 float heightHint,
 KPosition topLeft,
 KPosition bottomRight)

addPolyline

public KPolyline addPolyline(KContainerRendering cr)

addPolyline

public KPolyline addPolyline(KContainerRendering cr,
 float lineWidth)

addPolyline

public KPolyline addPolyline(KContainerRendering cr,
 float lineWidth,
 List<KPosition> points)

addHorizontalLine

public KPolyline addHorizontalLine(KContainerRendering cr,
 float leftRightAbsIndent)

addHorizontalLine

public KPolyline addHorizontalLine(KContainerRendering cr,
 float leftRightAbsIndent,
 float lineWidth)

addHorizontalLine

public KPolyline addHorizontalLine(KContainerRendering cr,
 PositionReferenceY y,
 float absIndent)

addHorizontalLine

public KPolyline addHorizontalLine(KContainerRendering cr,
 PositionReferenceY y,
 float absIndent,
 float lineWidth)

addVerticalLine

public KPolyline addVerticalLine(KContainerRendering cr,
 PositionReferenceX x,
 float absIndent)

addVerticalLine

public KPolyline addVerticalLine(KContainerRendering cr,
 PositionReferenceX x,
 float absIndent,
 float lineWidth)

addHorizontalSeperatorLine

public KPolyline addHorizontalSeperatorLine(KContainerRendering cr,
 float lineWidth,
 int spacing)

drawArrow

public KPolygon drawArrow(KContainerRendering cr)

drawTriangle

public KPolygon drawTriangle(KContainerRendering cr)