org.girod.javafx.svgimage.tosvg.wrappers

Class BackgroundWrapper

java.lang.Object

org.girod.javafx.svgimage.tosvg.wrappers.BackgroundWrapper

public class BackgroundWrapper
extends java.lang.Object

Wraps the definition for an element in the list associated with a JavaFX Background.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
BackgroundWrapper(javafx.scene.paint.Paint paint) Constructor.

Method Summary

Modifier and Type	Method and Description
double	getHeight() Return the height of the wrapper.
javafx.scene.layout.BackgroundPosition	getImagePosition() Return the wrapper image position.
int	getMeanRadiiHeight() Return the mean height value of the corners Radii.
int	getMeanRadiiWidth() Return the mean width value of the corners Radii.
javafx.scene.paint.Paint	getPaint() Return the Paint of the wrapper.
javafx.scene.layout.CornerRadii	getRadii() Return the corners Radii of the wrapper.
double	getWidth() Return the width of the wrapper.
double	getX() Return the X position of the wrapper.
double	getY() Return the Y position of the wrapper.
boolean	hasRadii() Return true if the wrapper has a CornerRadii (means that at least one corner radius is 0).
boolean	isTexture() Return true if the wrapper wraps a Texture.
void	setImagePosition(javafx.scene.layout.BackgroundPosition position) Set the wrapper image position.
void	setPosition(double x, double y) Set the position of the wrapper.
void	setRadii(javafx.scene.layout.CornerRadii radii) Set the corners Radii of the wrapper.
void	setSize(double width, double height) Set the size of the wrapper.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundWrapper

public BackgroundWrapper(javafx.scene.paint.Paint paint)

Constructor.

Parameters:

paint - the Paint

Method Detail

isTexture

public boolean isTexture()

Return true if the wrapper wraps a Texture.

Returns:

true if the wrapper wraps a Texture

setPosition

public void setPosition(double x,
                        double y)

Set the position of the wrapper.

Parameters:

x - the X position

y - the Y position

setImagePosition

public void setImagePosition(javafx.scene.layout.BackgroundPosition position)

Set the wrapper image position. This is only useful for the Texture.

Parameters:

position - the wrapper image position

getImagePosition

public javafx.scene.layout.BackgroundPosition getImagePosition()

Return the wrapper image position. This will be null if the wrapper does not wrap a Texture.

Returns:

the wrapper image position

setRadii

public void setRadii(javafx.scene.layout.CornerRadii radii)

Set the corners Radii of the wrapper.

Parameters:

radii - the Radii

getRadii

public javafx.scene.layout.CornerRadii getRadii()

Return the corners Radii of the wrapper.

Returns:

the Radii

hasRadii

public boolean hasRadii()

Return true if the wrapper has a CornerRadii (means that at least one corner radius is 0).

Returns:

true if the wrapper has a CornerRadii

getMeanRadiiWidth

public int getMeanRadiiWidth()

Return the mean width value of the corners Radii.

Returns:

the mean width value of the corners Radii

getMeanRadiiHeight

public int getMeanRadiiHeight()

Return the mean height value of the corners Radii.

Returns:

the mean height value of the corners Radii

getX

public double getX()

Return the X position of the wrapper.

Returns:

the X position of the wrapper

getY

public double getY()

Return the Y position of the wrapper.

Returns:

the Y position of the wrapper

setSize

public void setSize(double width,
                    double height)

Set the size of the wrapper.

Parameters:

width - the width

height - the height

getWidth

public double getWidth()

Return the width of the wrapper.

Returns:

the width of the wrapper

getHeight

public double getHeight()

Return the height of the wrapper.

Returns:

the height of the wrapper

getPaint

public javafx.scene.paint.Paint getPaint()

Return the Paint of the wrapper.

Returns:

the Paint of the wrapper