org.girod.javafx.svgimage

Class Viewbox

java.lang.Object

org.girod.javafx.svgimage.Viewbox

Direct Known Subclasses:

Viewport

public class Viewbox
extends java.lang.Object

Represents a viewbox.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	hasWidthAndHeight True if the viewbox has a width and height.
protected double	height The height attribute.
protected boolean	preserveAspectRatio True if the "preserveAspectRatio" attribute has a value different from "none".
protected double	viewboxHeight The height of the viewBox attribute.
protected double	viewboxWidth The width of the viewBox attribute.
protected double	viewboxX The x position of the viewBox attribute.
protected double	viewboxY The y position of the viewBox attribute.
protected double	width The width attribute.

Constructor Summary

Constructors

Constructor and Description
Viewbox(double width, double height) Create a viewbox with explicit width and height.

Method Summary

Modifier and Type	Method and Description
double	getHeight() Return the height.
double	getViewboxHeight() Return the viewBox height.
double	getViewboxWidth() Return the viewBox width.
double	getViewboxX() Return the viewBox x position.
double	getViewboxY() Return the viewBox y position.
double	getWidth() Return the width.
boolean	hasWidthAndHeight() Return true if the viewbox has a width and height.
boolean	isPreservingAspectRatio() Return true if the aspect ratio must be preserved.
void	scaleNode(javafx.scene.Node node) Scale a Node.
double	scaleValue(boolean isWidth, double value) Scale a SVG element attribute value.
void	setPreserveAspectRatio(boolean preserveAspectRatio) Set true if the aspect ratio must be preserved.
void	setViewbox(double viewboxX, double viewboxY, double viewboxWidth, double viewboxHeight) Set the width and height of the viewBox

Methods inherited from class java.lang.Object

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

Field Detail

width

protected double width

The width attribute.

height

protected double height

The height attribute.

hasWidthAndHeight

protected boolean hasWidthAndHeight

True if the viewbox has a width and height.

viewboxX

protected double viewboxX

The x position of the viewBox attribute.

viewboxY

protected double viewboxY

The y position of the viewBox attribute.

viewboxWidth

protected double viewboxWidth

The width of the viewBox attribute.

viewboxHeight

protected double viewboxHeight

The height of the viewBox attribute.

preserveAspectRatio

protected boolean preserveAspectRatio

True if the "preserveAspectRatio" attribute has a value different from "none".

Constructor Detail

Viewbox

public Viewbox(double width,
               double height)

Create a viewbox with explicit width and height.

Parameters:

width - the width

height - the height

Method Detail

hasWidthAndHeight

public boolean hasWidthAndHeight()

Return true if the viewbox has a width and height.

Returns:

true if the viewbox has a width and height

setPreserveAspectRatio

public void setPreserveAspectRatio(boolean preserveAspectRatio)

Set true if the aspect ratio must be preserved. Note that only two states are supported, contrary to the full SVG specification.

Parameters:

preserveAspectRatio - true if the aspect ratio must be preserved

isPreservingAspectRatio

public boolean isPreservingAspectRatio()

Return true if the aspect ratio must be preserved. Note that only two states are supported, contrary to the full SVG specification.

Returns:

true if the aspect ratio must be preserved

setViewbox

public void setViewbox(double viewboxX,
                       double viewboxY,
                       double viewboxWidth,
                       double viewboxHeight)

Set the width and height of the viewBox

Parameters:

viewboxX - the viewBox X coordinate

viewboxY - the viewBox y coordinate

viewboxWidth - the viewBox width

viewboxHeight - the viewBox height

scaleNode

public void scaleNode(javafx.scene.Node node)

Scale a Node.

Parameters:

node - the node

scaleValue

public double scaleValue(boolean isWidth,
                         double value)

Scale a SVG element attribute value. The value will only be scaled if the isPreservingAspectRatio() returns true.

Parameters:

isWidth - true for a width value

value - the value

Returns:

the scaled value

getViewboxX

public double getViewboxX()

Return the viewBox x position.

Returns:

the x position

getViewboxY

public double getViewboxY()

Return the viewBox y position.

Returns:

the y position

getViewboxWidth

public double getViewboxWidth()

Return the viewBox width.

Returns:

the width

getViewboxHeight

public double getViewboxHeight()

Return the viewBox height.

Returns:

the height

getWidth

public double getWidth()

Return the width.

Returns:

the width

getHeight

public double getHeight()

Return the height.

Returns:

the height