de.vandermeer.svg2vector.applications.base

Class SV_DocumentLoader

Object

SV_DocumentLoader

Direct Known Subclasses:

BatikLoader, IsLoader

public abstract class SV_DocumentLoader
extends Object

Base class for an SVG document loader.

Since:

v2.0.0

Version:

v2.0.0 build 170413 (13-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isLoaded Flag indicating if a document is loaded or not.
protected HashMap<String,Integer>	layers List of layers with identifier and index.

Constructor Summary

Constructors

Constructor and Description
SV_DocumentLoader()

Method Summary

Modifier and Type	Method and Description
HashMap<String,Integer>	getLayers() Returns the map of layers (layer name to index), empty if no layers found.
boolean	hasInkscapeLayers() Tests if the loaded document has Inkscape layers.
boolean	isLoaded() Returns the status of the loader.
abstract String	load(String fn) Loads the SVG file.
abstract void	switchOffAllLayers() Switch all layers off.
abstract void	switchOnAllLayers() Switch all layers off.
abstract void	switchOnLayer(String layer) Switches the given layer on, nothing happens if the layer was blank or not in the layer list.

Methods inherited from class Object

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

Field Detail

isLoaded

protected boolean isLoaded

Flag indicating if a document is loaded or not.

layers

protected final HashMap<String,Integer> layers

List of layers with identifier and index.

Constructor Detail

SV_DocumentLoader

public SV_DocumentLoader()

Method Detail

load

public abstract String load(String fn)

Loads the SVG file. This method will not re-load an SVG file once the loader already has a document loaded.

Parameters:

fn - the file name for the SVG document

Returns:

null on success, error message on error

Throws:

NullPointerException - if argument was null

IllegalArgumentException - if argument was blank

isLoaded

public boolean isLoaded()

Returns the status of the loader.

Returns:

true if document is loaded, false otherwise

hasInkscapeLayers

public boolean hasInkscapeLayers()

Tests if the loaded document has Inkscape layers.

Returns:

true if the document has Inkscape layers (2 or more layers), false otherwise (0 or 1 layer)

switchOnAllLayers

public abstract void switchOnAllLayers()

Switch all layers off.

switchOffAllLayers

public abstract void switchOffAllLayers()

Switch all layers off.

switchOnLayer

public abstract void switchOnLayer(String layer)

Switches the given layer on, nothing happens if the layer was blank or not in the layer list.

Parameters:

layer - the layer to be switched on

getLayers

public HashMap<String,Integer> getLayers()

Returns the map of layers (layer name to index), empty if no layers found.

Returns:

map of layers