org.girod.javafx.svgimage.tosvg.converters

Class AbstractConverter

java.lang.Object

org.girod.javafx.svgimage.tosvg.converters.AbstractConverter

All Implemented Interfaces:

CSSProperties, NodeConverter

Direct Known Subclasses:

AbstractImageConverter, GroupConverter, RegionConverter, ShapeConverter, SubSceneConverter

public abstract class AbstractConverter
extends java.lang.Object
implements CSSProperties, NodeConverter

The abstract Converter class.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	allProperties The CSS Properties of the Node to convert, including only those which have a not null StyleOrigin.
protected java.util.Map<java.lang.String,CSSProperty>	cssProperties The CSS Properties of the Node to convert, including all the properties.
protected ConverterDelegate	delegate The ConverterDelegate.
protected java.util.Map<java.lang.String,java.lang.Object>	properties The CSS Properties of the Node to convert, including only those which have a not null StyleOrigin.
protected XMLNode	xmlParent Parent XML node used as the output container.

Fields inherited from interface org.girod.javafx.svgimage.tosvg.utils.CSSProperties

ARC_HEIGHT, ARC_WIDTH, BACKGROUND_COLOR, BACKGROUND_IMAGE, BACKGROUND_RADIUS, BORDER_COLOR, BORDER_RADIUS, FILL_PAINT, FONT, FONT_FAMILY, FONT_SIZE, FONT_STYLE, FONT_WEIGHT, IMAGE, OPACITY, REGION_BACKGROUND, REGION_BACKGROUND_POSITION, REGION_BACKGROUND_RADIUS, REGION_BACKGROUND_SIZE, REGION_BORDER, SCALE_SHAPE, SCALE_X, SCALE_Y, SHAPE, STROKE_DASHARRAY, STROKE_DASHOFFSET, STROKE_LINECAP, STROKE_LINEJOIN, STROKE_MITERLIMIT, STROKE_PAINT, STROKE_TYPE, STROKE_WIDTH, TEXT_BOUNDS_TYPE, TEXT_FILL, TRANSLATE_X, TRANSLATE_Y, VISIBILITY

Constructor Summary

Constructors

Constructor and Description
AbstractConverter(ConverterDelegate delegate, javafx.scene.Node node, XMLNode xmlParent) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addFill(javafx.scene.paint.Paint paint, java.lang.StringBuilder buf) Append fill style information based on the provided paint.
protected void	addStroke(javafx.scene.paint.Paint paint, java.lang.StringBuilder buf) Append stroke style information based on the provided paint.
void	applyTransforms(XMLNode xmlNode) Apply all the Nodes transformations on the ConverterDelegate.
javafx.scene.Node	getAdditionalNode() Return the additional child Node on this Node (this is for example the case with the graphics Node on Labeled Nodes).
java.util.Map<java.lang.String,java.lang.Object>	getAllProperties() Return all the CSS properties Map of the Node.
java.util.Map<java.lang.String,CSSProperty>	getCSSProperties() Return the CSS properties Map of the Node.
protected double	getOpacity() Return the opacity of the Node.
javafx.scene.Parent	getParent() Return the converter Parent Node (may be null).
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Return the CSS properties Map of the Node.
protected javafx.scene.transform.Transform	getTransformFromAncestor(javafx.scene.Node node) Return the Transform from the root of the Scene to the converter Node.
boolean	hasVisibility() Return true if a visibility property is explicitly set.
boolean	isVisible() Return true if the node should be visible based on its visibility property.
protected void	setClip(java.lang.StringBuilder buf, java.lang.String clipID) Append a clip-path style if a clip id is provided.
protected void	setFillOpacity(javafx.scene.paint.Paint paint, XMLNode node) Set the fill opacity attribute on the SVG node when applicable.
protected void	setStrokeOpacity(javafx.scene.paint.Paint paint, XMLNode node) Set the stroke opacity attribute on the SVG node when applicable.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.girod.javafx.svgimage.tosvg.utils.NodeConverter

applyStyle, convert

Field Detail

delegate

protected ConverterDelegate delegate

The ConverterDelegate.

xmlParent

protected final XMLNode xmlParent

Parent XML node used as the output container.

cssProperties

protected java.util.Map<java.lang.String,CSSProperty> cssProperties

The CSS Properties of the Node to convert, including all the properties.

properties

protected java.util.Map<java.lang.String,java.lang.Object> properties

The CSS Properties of the Node to convert, including only those which have a not null StyleOrigin. These propeties only include those set by the CSS user file or inline for the widget.

allProperties

protected java.util.Map<java.lang.String,java.lang.Object> allProperties

The CSS Properties of the Node to convert, including only those which have a not null StyleOrigin. These propeties only include those set by the CSS user file or inline for the widget.

Constructor Detail

AbstractConverter

public AbstractConverter(ConverterDelegate delegate,
                         javafx.scene.Node node,
                         XMLNode xmlParent)

Constructor.

Parameters:

delegate - the ConverterDelegate

node - the Node

xmlParent - the parent xml node

Method Detail

getParent

public javafx.scene.Parent getParent()

Return the converter Parent Node (may be null). Return null by default.

Returns:

the converter Parent Node

getTransformFromAncestor

protected javafx.scene.transform.Transform getTransformFromAncestor(javafx.scene.Node node)

Return the Transform from the root of the Scene to the converter Node.

Parameters:

node - the Node

Returns:

the Transform

setClip

protected void setClip(java.lang.StringBuilder buf,
                       java.lang.String clipID)

Append a clip-path style if a clip id is provided.

Parameters:

buf - the style buffer

clipID - the clip id to reference

getCSSProperties

public java.util.Map<java.lang.String,CSSProperty> getCSSProperties()

Return the CSS properties Map of the Node. These properties include those which are set by default (null StyleOrigin).

Specified by:

getCSSProperties in interface NodeConverter

Returns:

the CSS properties Map

getAllProperties

public java.util.Map<java.lang.String,java.lang.Object> getAllProperties()

Return all the CSS properties Map of the Node.

Specified by:

getAllProperties in interface NodeConverter

Returns:

the CSS properties Map

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Return the CSS properties Map of the Node. These propeties only include those set by the CSS user file or inline for the widget.

Specified by:

getProperties in interface NodeConverter

Returns:

the CSS properties Map

applyTransforms

public void applyTransforms(XMLNode xmlNode)

Apply all the Nodes transformations on the ConverterDelegate.

Parameters:

xmlNode - the node

hasVisibility

public boolean hasVisibility()

Return true if a visibility property is explicitly set.

Returns:

true if visibility is defined

isVisible

public boolean isVisible()

Return true if the node should be visible based on its visibility property.

Returns:

true if visible

getOpacity

protected double getOpacity()

Return the opacity of the Node.

Returns:

the opacity

addStroke

protected void addStroke(javafx.scene.paint.Paint paint,
                         java.lang.StringBuilder buf)

Append stroke style information based on the provided paint.

Parameters:

paint - the stroke paint

buf - the style buffer

addFill

protected void addFill(javafx.scene.paint.Paint paint,
                       java.lang.StringBuilder buf)

Append fill style information based on the provided paint.

Parameters:

paint - the fill paint

buf - the style buffer

setStrokeOpacity

protected void setStrokeOpacity(javafx.scene.paint.Paint paint,
                                XMLNode node)

Set the stroke opacity attribute on the SVG node when applicable.

Parameters:

paint - the stroke paint

node - the SVG node to update

setFillOpacity

protected void setFillOpacity(javafx.scene.paint.Paint paint,
                              XMLNode node)

Set the fill opacity attribute on the SVG node when applicable.

Parameters:

paint - the fill paint

node - the SVG node to update

getAdditionalNode

public javafx.scene.Node getAdditionalNode()

Return the additional child Node on this Node (this is for example the case with the graphics Node on Labeled Nodes). Return null by default.

Returns:

the additional child Node on this Node