Package com.github.tadukoo.view.paint.gradient

Class RadialGradient.RadialGradientBuilder

java.lang.Object

com.github.tadukoo.view.paint.gradient.GradientBuilder<RadialGradient>

com.github.tadukoo.view.paint.gradient.RadialGradient.RadialGradientBuilder

Enclosing class:

RadialGradient

public static class RadialGradient.RadialGradientBuilder
extends GradientBuilder<RadialGradient>

Radial Gradient Builder is a builder for RadialGradient. The only required parameters to specify are the color points. You must specify at least two, so that it's an actual gradient. The following parameters are optional:

• cycleMethod - defaults to MultipleGradientPaint.CycleMethod.NO_CYCLE
• colorSpace - defaults to MultipleGradientPaint.ColorSpaceType.SRGB
• gradientTransform - defaults to new AffineTransform()
• circleFunc - defaults to calculating a circle centered in the given space with focus in the center

Since:

Alpha v.0.2

Version:

Alpha v.0.2.1

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
private Function<Dimension,com.github.tadukoo.util.tuple.Triple<Point2D,Float,Point2D>>	circleFunc	A function taking in the dimension of the space to determine the center, radius, and focus of the circle

Fields inherited from class com.github.tadukoo.view.paint.gradient.GradientBuilder

colors, colorSpace, cycleMethod, fractions, gradientTransform

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RadialGradientBuilder()	Not allowed to create outside of RadialGradient

Method Summary

Modifier and Type	Method	Description
protected RadialGradient	buildGradient()	Builds the actual Gradient.
protected List<String>	checkForSubclassErrors()	Checks that circleFunc is not null
RadialGradient.RadialGradientBuilder	circleFunc(Function<Dimension,com.github.tadukoo.util.tuple.Triple<Point2D,Float,Point2D>> circleFunc)
RadialGradient.RadialGradientBuilder	colorPoint(float fraction, Color color)
RadialGradient.RadialGradientBuilder	colorSpace(MultipleGradientPaint.ColorSpaceType colorSpace)
RadialGradient.RadialGradientBuilder	cycleMethod(MultipleGradientPaint.CycleMethod cycleMethod)
RadialGradient.RadialGradientBuilder	gradientTransform(AffineTransform gradientTransform)

Methods inherited from class com.github.tadukoo.view.paint.gradient.GradientBuilder

build, checkForErrors

Methods inherited from class java.lang.Object

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

Field Details

circleFunc

private Function<Dimension,com.github.tadukoo.util.tuple.Triple<Point2D,Float,Point2D>> circleFunc

A function taking in the dimension of the space to determine the center, radius, and focus of the circle

Constructor Details

RadialGradientBuilder

private RadialGradientBuilder()

Not allowed to create outside of RadialGradient

Method Details

circleFunc

public RadialGradient.RadialGradientBuilder circleFunc(Function<Dimension,com.github.tadukoo.util.tuple.Triple<Point2D,Float,Point2D>> circleFunc)

Parameters:

circleFunc - A function taking in the dimension of the space to determine the center, radius, and focus of the circle

Returns:

this, to continue building

colorPoint

public RadialGradient.RadialGradientBuilder colorPoint(float fraction,
 Color color)

Overrides:

colorPoint in class GradientBuilder<RadialGradient>

Parameters:

fraction - The fraction to use for this color point

color - The Color to use for this color point

Returns:

this, to continue building

cycleMethod

public RadialGradient.RadialGradientBuilder cycleMethod(MultipleGradientPaint.CycleMethod cycleMethod)

Overrides:

cycleMethod in class GradientBuilder<RadialGradient>

Parameters:

cycleMethod - The cycle method involved in the Gradient

Returns:

this, to continue building

colorSpace

public RadialGradient.RadialGradientBuilder colorSpace(MultipleGradientPaint.ColorSpaceType colorSpace)

Overrides:

colorSpace in class GradientBuilder<RadialGradient>

Parameters:

colorSpace - The color space involved in the Gradient

Returns:

this, to continue building

gradientTransform

public RadialGradient.RadialGradientBuilder gradientTransform(AffineTransform gradientTransform)

Overrides:

gradientTransform in class GradientBuilder<RadialGradient>

Parameters:

gradientTransform - The AffineTransform involved in the Gradient

Returns:

this, to continue building

checkForSubclassErrors

protected List<String> checkForSubclassErrors()

Checks that circleFunc is not null

Specified by:

checkForSubclassErrors in class GradientBuilder<RadialGradient>

Returns:

An ArrayList of any errors found

buildGradient

protected RadialGradient buildGradient()

Builds the actual Gradient. This is implemented by the specific subclass.

Specified by:

buildGradient in class GradientBuilder<RadialGradient>

Returns:

The newly built Gradient