Module io.github.sosuisen.api.jfxbuilder.graphics

Package io.github.sosuisen.jfxbuilder.graphics

Class GraphicsContextBuilder

java.lang.Object

io.github.sosuisen.jfxbuilder.graphics.GraphicsContextBuilder

public class GraphicsContextBuilder
extends Object

The GraphicsContextBuilder class constructs instances of the GraphicsContext class and offers a fluent interface for creating and configuring it.

This class includes a static create method that accepts the same arguments as the original GraphicsContext constructor and returns an instance of the GraphicsContextBuilder.

You can use method chaining to call the builder methods for configuring the GraphicsContext. Finally, invoke the build method to generate an instance of the GraphicsContext class.

Note that intermediate builder methods are not evaluated until the build method is called, meaning they are evaluated lazily.

Author:

Hidekazu Kubota <hidekazu.kubota@gmail.com>

Method Summary

Modifier and Type	Method	Description
GraphicsContextBuilder	apply(Consumer<GraphicsContext> func)	Applies a function to the GraphicsContext instance being constructed.
GraphicsContext	build()	Builds and returns an instance of the GraphicsContext class.
GraphicsContextBuilder	effect(Effect e)	A builder method that invokes the setEffect method on the instance being constructed.
GraphicsContextBuilder	fill(Paint p)	A builder method that invokes the setFill method on the instance being constructed.
GraphicsContextBuilder	fillRule(FillRule fillRule)	A builder method that invokes the setFillRule method on the instance being constructed.
GraphicsContextBuilder	font(Font f)	A builder method that invokes the setFont method on the instance being constructed.
GraphicsContextBuilder	fontSmoothingType(FontSmoothingType fontsmoothing)	A builder method that invokes the setFontSmoothingType method on the instance being constructed.
GraphicsContextBuilder	globalAlpha(double alpha)	A builder method that invokes the setGlobalAlpha method on the instance being constructed.
GraphicsContextBuilder	globalBlendMode(BlendMode op)	A builder method that invokes the setGlobalBlendMode method on the instance being constructed.
GraphicsContextBuilder	imageSmoothing(boolean imageSmoothing)	A builder method that invokes the setImageSmoothing method on the instance being constructed.
GraphicsContextBuilder	lineCap(StrokeLineCap cap)	A builder method that invokes the setLineCap method on the instance being constructed.
GraphicsContextBuilder	lineDashes(double... dashes)	A builder method that invokes the setLineDashes method on the instance being constructed.
GraphicsContextBuilder	lineDashOffset(double dashOffset)	A builder method that invokes the setLineDashOffset method on the instance being constructed.
GraphicsContextBuilder	lineJoin(StrokeLineJoin join)	A builder method that invokes the setLineJoin method on the instance being constructed.
GraphicsContextBuilder	lineWidth(double lw)	A builder method that invokes the setLineWidth method on the instance being constructed.
GraphicsContextBuilder	miterLimit(double ml)	A builder method that invokes the setMiterLimit method on the instance being constructed.
GraphicsContextBuilder	stroke(Paint p)	A builder method that invokes the setStroke method on the instance being constructed.
GraphicsContextBuilder	textAlign(TextAlignment align)	A builder method that invokes the setTextAlign method on the instance being constructed.
GraphicsContextBuilder	textBaseline(VPos baseline)	A builder method that invokes the setTextBaseline method on the instance being constructed.
GraphicsContextBuilder	transform(double mxx, double myx, double mxy, double myy, double mxt, double myt)	A builder method that invokes the setTransform method on the instance being constructed.
GraphicsContextBuilder	transform(Affine xform)	A builder method that invokes the setTransform method on the instance being constructed.

Methods inherited from class java.lang.Object

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

Method Details

build

public GraphicsContext build()

Builds and returns an instance of the GraphicsContext class.

Intermediate builder methods are not evaluated until the build method is called; in other words, they are evaluated lazily.

Returns:

new instance of the GraphicsContext class

apply

public GraphicsContextBuilder apply(Consumer<GraphicsContext> func)

Applies a function to the GraphicsContext instance being constructed. Most operations on the instance can be performed using this method.

Returns:

builder instance

effect

public GraphicsContextBuilder effect(Effect e)

A builder method that invokes the setEffect method on the instance being constructed.

Returns:

builder instance

fill

public GraphicsContextBuilder fill(Paint p)

A builder method that invokes the setFill method on the instance being constructed.

Returns:

builder instance

fillRule

public GraphicsContextBuilder fillRule(FillRule fillRule)

A builder method that invokes the setFillRule method on the instance being constructed.

Returns:

builder instance

font

public GraphicsContextBuilder font(Font f)

A builder method that invokes the setFont method on the instance being constructed.

Returns:

builder instance

fontSmoothingType

public GraphicsContextBuilder fontSmoothingType(FontSmoothingType fontsmoothing)

A builder method that invokes the setFontSmoothingType method on the instance being constructed.

Returns:

builder instance

globalAlpha

public GraphicsContextBuilder globalAlpha(double alpha)

A builder method that invokes the setGlobalAlpha method on the instance being constructed.

Returns:

builder instance

globalBlendMode

public GraphicsContextBuilder globalBlendMode(BlendMode op)

A builder method that invokes the setGlobalBlendMode method on the instance being constructed.

Returns:

builder instance

imageSmoothing

public GraphicsContextBuilder imageSmoothing(boolean imageSmoothing)

A builder method that invokes the setImageSmoothing method on the instance being constructed.

Returns:

builder instance

lineCap

public GraphicsContextBuilder lineCap(StrokeLineCap cap)

A builder method that invokes the setLineCap method on the instance being constructed.

Returns:

builder instance

lineDashOffset

public GraphicsContextBuilder lineDashOffset(double dashOffset)

A builder method that invokes the setLineDashOffset method on the instance being constructed.

Returns:

builder instance

lineDashes

public GraphicsContextBuilder lineDashes(double... dashes)

A builder method that invokes the setLineDashes method on the instance being constructed.

Returns:

builder instance

lineJoin

public GraphicsContextBuilder lineJoin(StrokeLineJoin join)

A builder method that invokes the setLineJoin method on the instance being constructed.

Returns:

builder instance

lineWidth

public GraphicsContextBuilder lineWidth(double lw)

A builder method that invokes the setLineWidth method on the instance being constructed.

Returns:

builder instance

miterLimit

public GraphicsContextBuilder miterLimit(double ml)

A builder method that invokes the setMiterLimit method on the instance being constructed.

Returns:

builder instance

stroke

public GraphicsContextBuilder stroke(Paint p)

A builder method that invokes the setStroke method on the instance being constructed.

Returns:

builder instance

textAlign

public GraphicsContextBuilder textAlign(TextAlignment align)

A builder method that invokes the setTextAlign method on the instance being constructed.

Returns:

builder instance

textBaseline

public GraphicsContextBuilder textBaseline(VPos baseline)

A builder method that invokes the setTextBaseline method on the instance being constructed.

Returns:

builder instance

transform

public GraphicsContextBuilder transform(double mxx,
 double myx,
 double mxy,
 double myy,
 double mxt,
 double myt)

A builder method that invokes the setTransform method on the instance being constructed.

Returns:

builder instance

transform

public GraphicsContextBuilder transform(Affine xform)

A builder method that invokes the setTransform method on the instance being constructed.

Returns:

builder instance