org.jhotdraw.samples.svg.io

Class SVGInputFormat

java.lang.Object

org.jhotdraw.samples.svg.io.SVGInputFormat

All Implemented Interfaces:

InputFormat

Direct Known Subclasses:

SVGZInputFormat

public class SVGInputFormat
extends java.lang.Object
implements InputFormat

SVGInputFormat. This format is aimed to comply to the Scalable Vector Graphics (SVG) Tiny 1.2 Specification supporting the SVG-static feature string. http://www.w3.org/TR/SVGMobile12/

Design pattern:
Name: Abstract Factory.
Role: Client.
Partners: SVGFigureFactory as Abstract Factory.

Constructor Summary

Constructors

Constructor and Description
SVGInputFormat() Creates a new instance.
SVGInputFormat(SVGFigureFactory factory)

Method Summary

Modifier and Type	Method and Description
javax.swing.filechooser.FileFilter	getFileFilter() Return a FileFilter that can be used to identify files which can be read with this input format.
javax.swing.JComponent	getInputFormatAccessory() Return a JFileChooser accessory that can be used to customize the input format.
boolean	isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor) Returns true, if this InputFormat can readFigures TransferData using the specified DataFlavor.
void	read(java.io.File file, Drawing drawing)
void	read(java.io.File file, Drawing drawing, boolean replace)
void	read(java.io.InputStream in, Drawing drawing, boolean replace) This is the main reading method.
void	read(java.awt.datatransfer.Transferable t, Drawing drawing, boolean replace) Reads figures from the specified Transferable and adds them to the specified drawing.
void	read(java.net.URI uri, Drawing drawing) Reads figures from an URI and replaces the children of the drawing with them.
void	read(java.net.URI uri, Drawing drawing, boolean replace) Reads figures from an URI and adds them to the specified drawing.
void	read(java.net.URL url, Drawing drawing, boolean replace)
static java.lang.String[]	toCommaSeparatedArray(java.lang.String str) Returns a value as a String array.
static java.lang.String[]	toQuotedAndCommaSeparatedArray(java.lang.String str) Returns a value as a String array.
static java.awt.geom.AffineTransform	toTransform(IXMLElement elem, java.lang.String str)
static java.lang.String[]	toWSOrCommaSeparatedArray(java.lang.String str) Returns a value as a String array.

Methods inherited from class java.lang.Object

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

Constructor Detail

SVGInputFormat

public SVGInputFormat()

Creates a new instance.

SVGInputFormat

public SVGInputFormat(SVGFigureFactory factory)

Method Detail

read

public void read(java.net.URI uri,
                 Drawing drawing)
          throws java.io.IOException

Description copied from interface: InputFormat

Reads figures from an URI and replaces the children of the drawing with them.

This is a convenience method for calling read(URI,Drawing,true).

Specified by:

read in interface InputFormat

Parameters:

uri - The URI.

drawing - The drawing.

Throws:

java.io.IOException

read

public void read(java.net.URI uri,
                 Drawing drawing,
                 boolean replace)
          throws java.io.IOException

Description copied from interface: InputFormat

Reads figures from an URI and adds them to the specified drawing.

Specified by:

read in interface InputFormat

Parameters:

uri - The URI.

drawing - The drawing.

replace - Set this to true, if the contents of the file replaces the contents of the drawing (for example, when loading a drawing from a file). Set this to false, to add the contents of the file to the drawing (for example, when the file has been dropped into the drawing view).

Throws:

java.io.IOException

read

public void read(java.io.File file,
                 Drawing drawing)
          throws java.io.IOException

Throws:

java.io.IOException

read

public void read(java.io.File file,
                 Drawing drawing,
                 boolean replace)
          throws java.io.IOException

Throws:

java.io.IOException

read

public void read(java.net.URL url,
                 Drawing drawing,
                 boolean replace)
          throws java.io.IOException

Throws:

java.io.IOException

read

public void read(java.io.InputStream in,
                 Drawing drawing,
                 boolean replace)
          throws java.io.IOException

This is the main reading method.

Specified by:

read in interface InputFormat

Parameters:

in - The input stream.

drawing - The drawing to which this method adds figures.

replace - Whether attributes on the drawing object should by changed by this method. Set this to false, when reading individual images from the clipboard.

Throws:

java.io.IOException

toCommaSeparatedArray

public static java.lang.String[] toCommaSeparatedArray(java.lang.String str)
                                                throws java.io.IOException

Returns a value as a String array. The values are separated by commas with optional white space.

Throws:

java.io.IOException

toWSOrCommaSeparatedArray

public static java.lang.String[] toWSOrCommaSeparatedArray(java.lang.String str)
                                                    throws java.io.IOException

Returns a value as a String array. The values are separated by whitespace or by commas with optional white space.

Throws:

java.io.IOException

toQuotedAndCommaSeparatedArray

public static java.lang.String[] toQuotedAndCommaSeparatedArray(java.lang.String str)
                                                         throws java.io.IOException

Returns a value as a String array. The values are separated by commas with optional quotes and white space.

Throws:

java.io.IOException

toTransform

public static java.awt.geom.AffineTransform toTransform(IXMLElement elem,
                                                        java.lang.String str)
                                                 throws java.io.IOException

Throws:

java.io.IOException

getFileFilter

public javax.swing.filechooser.FileFilter getFileFilter()

Description copied from interface: InputFormat

Return a FileFilter that can be used to identify files which can be read with this input format. Typically, each input format has its own recognizable file naming convention.

Specified by:

getFileFilter in interface InputFormat

Returns:

FileFilter to be used with a javax.swing.JFileChooser

getInputFormatAccessory

public javax.swing.JComponent getInputFormatAccessory()

Description copied from interface: InputFormat

Return a JFileChooser accessory that can be used to customize the input format.

Specified by:

getInputFormatAccessory in interface InputFormat

Returns:

A JFileChooser accessory to be used with a javax.swing.JFileChooser Returns null, if no accessory is provided for this format.

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)

Description copied from interface: InputFormat

Returns true, if this InputFormat can readFigures TransferData using the specified DataFlavor.

Specified by:

isDataFlavorSupported in interface InputFormat

Parameters:

flavor - A DataFlavor.

read

public void read(java.awt.datatransfer.Transferable t,
                 Drawing drawing,
                 boolean replace)
          throws java.awt.datatransfer.UnsupportedFlavorException,
                 java.io.IOException

Description copied from interface: InputFormat

Reads figures from the specified Transferable and adds them to the specified drawing.

Specified by:

read in interface InputFormat

Parameters:

t - The Transferable.

drawing - The drawing.

replace - Set this to true, if the contents of the transferable replaces the contents of the drawing (for example, when loading a drawing from a transferable). Set this to false, to add the contents of the transferable to the drawing (for example, when the transferable has been dropped or pasted into the drawing view).

Throws:

java.awt.datatransfer.UnsupportedFlavorException

java.io.IOException