Package org.sbml.jsbml.ext.render.director

Interface LayoutBuilder<P>

Type Parameters:

P - Type of the product.

All Known Implementing Classes:

AbstractLayoutBuilder

public interface LayoutBuilder<P>

LayoutBuilder provides methods to build graphical representations for all glyph types.

Since:

1.4

Author:

Mirjam Gutekunst

Method Summary

Modifier and Type	Method	Description
void	buildCompartment(CompartmentGlyph compartmentGlyph)	method for the drawing of a compartment with the size and position of the BoundingBox of the given CompartmentGlyph
void	buildConnectingArc(SpeciesReferenceGlyph srg, ReactionGlyph rg, double curveWidth)	method for the drawing of a connecting arc or line with the size and position specified by the given SpeciesReferenceGlyph
void	buildCubicBezier(CubicBezier cubicBezier, double lineWidth)	method to draw an arc between the two base points of the given CubicBezier.
void	buildEntityPoolNode(SpeciesGlyph speciesGlyph, boolean cloneMarker)	method for the drawing of an entity pool node with the given size and position of the BoundingBox of the given SpeciesGlyph
void	builderEnd()	method for actions that have to be done at the end of the builder e.g.
void	builderStart(Layout layout)	method for preparations that have to be done at the beginning of the builder, e.g., the commands at the beginning of a LaTeX document
void	buildProcessNode(ReactionGlyph reactionGlyph, double rotationAngle, double curveWidth)	method for the drawing of a process node with the size and position of the BoundingBox of the given ReactionGlyph
void	buildTextGlyph(TextGlyph textGlyph)	method for drawing/writing the given TextGlyph
P	getProduct()
boolean	isProductReady()	method to check if the builder has produced a complete product

Method Detail

builderStart

void builderStart(Layout layout)

method for preparations that have to be done at the beginning of the builder, e.g., the commands at the beginning of a LaTeX document

Parameters:

layout -

buildCompartment

void buildCompartment(CompartmentGlyph compartmentGlyph)

method for the drawing of a compartment with the size and position of the BoundingBox of the given CompartmentGlyph

Parameters:

compartmentGlyph -

buildConnectingArc

void buildConnectingArc(SpeciesReferenceGlyph srg,
                        ReactionGlyph rg,
                        double curveWidth)

method for the drawing of a connecting arc or line with the size and position specified by the given SpeciesReferenceGlyph

Parameters:

srg - species reference glyph that defines the connecting arc

rg - associated reaction glyph

curveWidth - line width of the arc

buildCubicBezier

void buildCubicBezier(CubicBezier cubicBezier,
                      double lineWidth)

method to draw an arc between the two base points of the given CubicBezier.

Parameters:

cubicBezier -

lineWidth -

buildEntityPoolNode

void buildEntityPoolNode(SpeciesGlyph speciesGlyph,
                         boolean cloneMarker)

method for the drawing of an entity pool node with the given size and position of the BoundingBox of the given SpeciesGlyph

Parameters:

speciesGlyph - of the entity pool node

cloneMarker - true if a clone marker is set for this speciesGlyph

buildProcessNode

void buildProcessNode(ReactionGlyph reactionGlyph,
                      double rotationAngle,
                      double curveWidth)

method for the drawing of a process node with the size and position of the BoundingBox of the given ReactionGlyph

Parameters:

rotationAngle - by which the lines from the reaction box are rotated

reactionGlyph - the glyph for the process node to be drawn

curveWidth -

buildTextGlyph

void buildTextGlyph(TextGlyph textGlyph)

method for drawing/writing the given TextGlyph

Parameters:

textGlyph -

builderEnd

void builderEnd()

method for actions that have to be done at the end of the builder e.g. the commands at the end of a LaTeX document

getProduct

P getProduct()

Returns:

the resulting product of the builder, an object of the type P

isProductReady

boolean isProductReady()

method to check if the builder has produced a complete product

Returns:

true, if product is not empty, else false