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

Class LinearGradient.LinearGradientBuilder

java.lang.Object

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

com.github.tadukoo.view.paint.gradient.LinearGradient.LinearGradientBuilder

Enclosing class:

LinearGradient

public static class LinearGradient.LinearGradientBuilder
extends GradientBuilder<LinearGradient>

Linear Gradient Builder is a builder for LinearGradient. 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()
• direction - defaults to LinearGradient.GradientDirection.HORIZONTAL
• startAndEndPointsFunc - defaults to calculating based on the direction given

Since:

Alpha v.0.2

Version:

Alpha v.0.2.1

Author:

Logan Ferree (Tadukoo)

Field Summary

Fields

Modifier and Type	Field	Description
private LinearGradient.GradientDirection	direction	The direction for the LinearGradient to go.
private BiFunction<Dimension,LinearGradient.GradientDirection,com.github.tadukoo.util.tuple.Pair<Point2D,Point2D>>	startAndEndPointsFunc	A function taking in the dimensions of the space and the chosen LinearGradient.GradientDirection to return the start and end points in space for the LinearGradient

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

colors, colorSpace, cycleMethod, fractions, gradientTransform

Constructor Summary

Constructors

Modifier	Constructor	Description
private	LinearGradientBuilder()	Not allowed to create outside of LinearGradient

Method Summary

Modifier and Type	Method	Description
protected LinearGradient	buildGradient()	Builds the actual Gradient.
protected List<String>	checkForSubclassErrors()	Checks that startAndEndPointsFunc is not null
LinearGradient.LinearGradientBuilder	colorPoint(float fraction, Color color)
LinearGradient.LinearGradientBuilder	colorSpace(MultipleGradientPaint.ColorSpaceType colorSpace)
LinearGradient.LinearGradientBuilder	cycleMethod(MultipleGradientPaint.CycleMethod cycleMethod)
LinearGradient.LinearGradientBuilder	direction(LinearGradient.GradientDirection direction)
LinearGradient.LinearGradientBuilder	gradientTransform(AffineTransform gradientTransform)
LinearGradient.LinearGradientBuilder	startAndEndPointsFunc(BiFunction<Dimension,LinearGradient.GradientDirection,com.github.tadukoo.util.tuple.Pair<Point2D,Point2D>> startAndEndPointsFunc)

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

direction

private LinearGradient.GradientDirection direction

The direction for the LinearGradient to go. This may be ignored by the startAndEndPointsFunc

startAndEndPointsFunc

private BiFunction<Dimension,LinearGradient.GradientDirection,com.github.tadukoo.util.tuple.Pair<Point2D,Point2D>> startAndEndPointsFunc

A function taking in the dimensions of the space and the chosen LinearGradient.GradientDirection to return the start and end points in space for the LinearGradient

Constructor Details

LinearGradientBuilder

private LinearGradientBuilder()

Not allowed to create outside of LinearGradient

Method Details

direction

public LinearGradient.LinearGradientBuilder direction(LinearGradient.GradientDirection direction)

Parameters:

direction - The direction for the LinearGradient to go. This may be ignored by the startAndEndPointsFunc

Returns:

this, to continue building

startAndEndPointsFunc

public LinearGradient.LinearGradientBuilder startAndEndPointsFunc(BiFunction<Dimension,LinearGradient.GradientDirection,com.github.tadukoo.util.tuple.Pair<Point2D,Point2D>> startAndEndPointsFunc)

Parameters:

startAndEndPointsFunc - A function taking in the dimensions of the space and the chosen LinearGradient.GradientDirection to return the start and end points in space for the LinearGradient

Returns:

this, to continue building

colorPoint

public LinearGradient.LinearGradientBuilder colorPoint(float fraction,
 Color color)

Overrides:

colorPoint in class GradientBuilder<LinearGradient>

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 LinearGradient.LinearGradientBuilder cycleMethod(MultipleGradientPaint.CycleMethod cycleMethod)

Overrides:

cycleMethod in class GradientBuilder<LinearGradient>

Parameters:

cycleMethod - The cycle method involved in the Gradient

Returns:

this, to continue building

colorSpace

public LinearGradient.LinearGradientBuilder colorSpace(MultipleGradientPaint.ColorSpaceType colorSpace)

Overrides:

colorSpace in class GradientBuilder<LinearGradient>

Parameters:

colorSpace - The color space involved in the Gradient

Returns:

this, to continue building

gradientTransform

public LinearGradient.LinearGradientBuilder gradientTransform(AffineTransform gradientTransform)

Overrides:

gradientTransform in class GradientBuilder<LinearGradient>

Parameters:

gradientTransform - The AffineTransform involved in the Gradient

Returns:

this, to continue building

checkForSubclassErrors

protected List<String> checkForSubclassErrors()

Checks that startAndEndPointsFunc is not null

Specified by:

checkForSubclassErrors in class GradientBuilder<LinearGradient>

Returns:

An ArrayList of any errors found

buildGradient

protected LinearGradient buildGradient()

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

Specified by:

buildGradient in class GradientBuilder<LinearGradient>

Returns:

The newly built Gradient