Module org.jhotdraw8.svg

Package org.jhotdraw8.svg.io

Class AbstractFXSvgWriter

java.lang.Object

org.jhotdraw8.fxbase.beans.AbstractPropertyBean

org.jhotdraw8.svg.io.AbstractFXSvgWriter

All Implemented Interfaces:

org.jhotdraw8.fxbase.beans.PropertyBean, SvgSceneGraphWriter

Direct Known Subclasses:

FXSvgFullWriter, FXSvgTinyWriter

public abstract class AbstractFXSvgWriter
extends org.jhotdraw8.fxbase.beans.AbstractPropertyBean
implements SvgSceneGraphWriter

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull IdFactory	idFactory
protected final @NonNull org.jhotdraw8.xml.converter.DoubleXmlConverter	nb
protected final @NonNull org.jhotdraw8.xml.converter.FloatXmlConverter	nbf
protected final @NonNull org.jhotdraw8.xml.converter.IntegerXmlConverter	nbi
static final @NonNull String	SVG_MIME_TYPE
static final @NonNull String	SVG_NS
protected static final @NonNull String	XLINK_NS
protected static final @NonNull String	XLINK_PREFIX

Fields inherited from class org.jhotdraw8.fxbase.beans.AbstractPropertyBean

properties

Fields inherited from interface org.jhotdraw8.svg.io.SvgSceneGraphWriter

CONVERT_TEXT_TO_PATH_KEY, DESC_PROPERTY_NAME, EXPORT_INVISIBLE_ELEMENTS_KEY, RELATIVIZE_PATHS_KEY, TITLE_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
AbstractFXSvgWriter(@Nullable Object imageUriKey, @Nullable Object skipKey)

Method Summary

Modifier and Type	Method	Description
protected abstract List<String>	getAdditionalNodeClasses(@NonNull javafx.scene.Node node)
protected abstract String	getSvgBaseProfile()
protected abstract String	getSvgVersion()
boolean	isConvertTextToPath()
boolean	isExportInvisibleElements()
boolean	isRelativizePaths()
void	setConvertTextToPath(boolean newValue)
void	setExportInvisibleElements(boolean newValue)
void	setRelativizePaths(boolean relativizePaths)
Document	toDocument(@NonNull javafx.scene.Node drawingNode, @Nullable CssDimension2D size)
void	write(@NonNull OutputStream out, @NonNull javafx.scene.Node drawingNode, @Nullable CssDimension2D size)
void	write(@NonNull Writer out, @NonNull javafx.scene.Node drawingNode, @Nullable CssDimension2D size)
protected abstract void	writeClipAttributes(@NonNull XMLStreamWriter w, @NonNull javafx.scene.Node node)
protected abstract void	writeClipPathDefs(XMLStreamWriter w, javafx.scene.Node node)
protected abstract void	writeCompositingAttributes(@NonNull XMLStreamWriter w, @NonNull javafx.scene.Node node)
protected void	writeDescElement(@NonNull XMLStreamWriter w, @NonNull javafx.scene.Node node)
protected abstract void	writeDocumentElementAttributes(@NonNull XMLStreamWriter w, javafx.scene.Node drawingNode, @Nullable CssDimension2D size)
protected void	writeGroupStartElement(@NonNull XMLStreamWriter w, @NonNull javafx.scene.Group node)
protected void	writeIdAttribute(@NonNull XMLStreamWriter w, @NonNull javafx.scene.Node node)
protected void	writeNodeRecursively(@NonNull XMLStreamWriter w, @NonNull javafx.scene.Node node, int depth)
protected void	writePathStartElement(@NonNull XMLStreamWriter w, @NonNull javafx.scene.shape.Path node)
protected void	writeStrokedShapeElement(@NonNull XMLStreamWriter w, @NonNull javafx.scene.shape.Shape fxShape)
protected void	writeStyleAttributes(@NonNull XMLStreamWriter w, @NonNull javafx.scene.Node node)
protected void	writeTitleElement(@NonNull XMLStreamWriter w, @NonNull javafx.scene.Node node)

Methods inherited from class org.jhotdraw8.fxbase.beans.AbstractPropertyBean

get, getNonNull, getProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jhotdraw8.fxbase.beans.PropertyBean

getProperty, put, remove, set, setNonNull, valueAt

Field Details

SVG_MIME_TYPE

public static final @NonNull String SVG_MIME_TYPE

See Also:

• Constant Field Values

SVG_NS

public static final @NonNull String SVG_NS

See Also:

• Constant Field Values

XLINK_NS

protected static final @NonNull String XLINK_NS

See Also:

• Constant Field Values

XLINK_PREFIX

protected static final @NonNull String XLINK_PREFIX

See Also:

• Constant Field Values

nb

protected final @NonNull org.jhotdraw8.xml.converter.DoubleXmlConverter nb

nbi

protected final @NonNull org.jhotdraw8.xml.converter.IntegerXmlConverter nbi

nbf

protected final @NonNull org.jhotdraw8.xml.converter.FloatXmlConverter nbf

idFactory

protected final @NonNull IdFactory idFactory

Constructor Details

AbstractFXSvgWriter

public AbstractFXSvgWriter(@Nullable Object imageUriKey,
 @Nullable Object skipKey)

Parameters:

imageUriKey - this property is used to retrieve an URL from an ImageView. If an ImageView does not have an URL, then the exporter includes the image with a data URL.

skipKey - this property is used to retrieve a Boolean from a Node. If the Boolean is true, then the node is skipped.

Method Details

getAdditionalNodeClasses

protected abstract List<String> getAdditionalNodeClasses(@NonNull javafx.scene.Node node)

getSvgBaseProfile

protected abstract String getSvgBaseProfile()

getSvgVersion

protected abstract String getSvgVersion()

isExportInvisibleElements

public boolean isExportInvisibleElements()

setExportInvisibleElements

public void setExportInvisibleElements(boolean newValue)

isRelativizePaths

public boolean isRelativizePaths()

setRelativizePaths

public void setRelativizePaths(boolean relativizePaths)

isConvertTextToPath

public boolean isConvertTextToPath()

setConvertTextToPath

public void setConvertTextToPath(boolean newValue)

toDocument

public Document toDocument(@NonNull javafx.scene.Node drawingNode,
 @Nullable CssDimension2D size)
                    throws IOException

Throws:

IOException

write

public void write(@NonNull OutputStream out,
 @NonNull javafx.scene.Node drawingNode,
 @Nullable CssDimension2D size)
           throws IOException

Throws:

IOException

write

public void write(@NonNull Writer out,
 @NonNull javafx.scene.Node drawingNode,
 @Nullable CssDimension2D size)
           throws IOException

Throws:

IOException

writeClipAttributes

protected abstract void writeClipAttributes(@NonNull XMLStreamWriter w,
 @NonNull javafx.scene.Node node)
                                     throws XMLStreamException

Throws:

XMLStreamException

writeClipPathDefs

protected abstract void writeClipPathDefs(XMLStreamWriter w,
 javafx.scene.Node node)
                                   throws XMLStreamException,
IOException

Throws:

XMLStreamException

IOException

writeCompositingAttributes

protected abstract void writeCompositingAttributes(@NonNull XMLStreamWriter w,
 @NonNull javafx.scene.Node node)
                                            throws XMLStreamException

Throws:

XMLStreamException

writeDescElement

protected void writeDescElement(@NonNull XMLStreamWriter w,
 @NonNull javafx.scene.Node node)
                         throws XMLStreamException

Throws:

XMLStreamException

writeDocumentElementAttributes

protected abstract void writeDocumentElementAttributes(@NonNull XMLStreamWriter w,
 javafx.scene.Node drawingNode,
 @Nullable CssDimension2D size)
                                                throws XMLStreamException

Throws:

XMLStreamException

writeGroupStartElement

protected void writeGroupStartElement(@NonNull XMLStreamWriter w,
 @NonNull javafx.scene.Group node)
                               throws XMLStreamException

Throws:

XMLStreamException

writeIdAttribute

protected void writeIdAttribute(@NonNull XMLStreamWriter w,
 @NonNull javafx.scene.Node node)
                         throws XMLStreamException

Throws:

XMLStreamException

writeNodeRecursively

protected void writeNodeRecursively(@NonNull XMLStreamWriter w,
 @NonNull javafx.scene.Node node,
 int depth)
                             throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

writePathStartElement

protected void writePathStartElement(@NonNull XMLStreamWriter w,
 @NonNull javafx.scene.shape.Path node)
                              throws XMLStreamException

Throws:

XMLStreamException

writeStrokedShapeElement

protected void writeStrokedShapeElement(@NonNull XMLStreamWriter w,
 @NonNull javafx.scene.shape.Shape fxShape)
                                 throws XMLStreamException,
IOException

Throws:

XMLStreamException

IOException

writeStyleAttributes

protected void writeStyleAttributes(@NonNull XMLStreamWriter w,
 @NonNull javafx.scene.Node node)
                             throws XMLStreamException

Throws:

XMLStreamException

writeTitleElement

protected void writeTitleElement(@NonNull XMLStreamWriter w,
 @NonNull javafx.scene.Node node)
                          throws XMLStreamException

Throws:

XMLStreamException