JHotDraw 7.4.1

org.jhotdraw.draw.io
Class ImageInputFormat

java.lang.Object
  extended by org.jhotdraw.draw.io.ImageInputFormat
All Implemented Interfaces:
InputFormat

public class ImageInputFormat
extends java.lang.Object
implements InputFormat

An input format for importing drawings using one of the image formats supported by javax.imageio.

This class uses the prototype design pattern. A ImageHolderFigure figure is used as a prototype for creating a figure that holds the imported image.

If the drawing is replaced using the loaded image, the size of the drawing is set to match the size of the image using the attributes AttributeKeys.CANVAS_WIDTH and AttributeKeys.CANVAS_HEIGHT.


Design Patterns

Prototype
The image input format creates new image holder figures by cloning a prototype figure object and assigning an image to it, which was read from data input. That's the reason why Figure extends the Cloneable interface.
Prototype: ImageHolderFigure; Client: ImageInputFormat.


Version:
$Id: ImageInputFormat.java 604 2010-01-09 12:00:29Z rawcoder $
Author:
Werner Randelshor

Constructor Summary
ImageInputFormat(ImageHolderFigure prototype)
          Creates a new image input format for all formats supported by javax.imageio.ImageIO.
ImageInputFormat(ImageHolderFigure prototype, java.lang.String formatName, java.lang.String description, java.lang.String[] fileExtensions, java.lang.String[] mimeTypes)
          Creates a new image input format for the specified image format.
ImageInputFormat(ImageHolderFigure prototype, java.lang.String formatName, java.lang.String description, java.lang.String fileExtension, java.lang.String mimeType)
          Creates a new image input format for the specified image format.
 
Method Summary
 ImageHolderFigure createImageHolder(java.io.InputStream in)
           
 java.lang.String[] getFileExtensions()
           
 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)
          Reads figures from a file and replaces the children of the drawing with them.
 void read(java.io.File file, Drawing drawing, boolean replace)
          Reads figures from a file and adds them to the specified drawing.
 void read(java.io.InputStream in, Drawing drawing, boolean replace)
          Reads figures from a file and adds them to the specified drawing.
 void read(java.awt.datatransfer.Transferable t, Drawing drawing, boolean replace)
          Reads figures from the specified Transferable and adds them to the specified drawing.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ImageInputFormat

public ImageInputFormat(ImageHolderFigure prototype)
Creates a new image input format for all formats supported by javax.imageio.ImageIO.


ImageInputFormat

public ImageInputFormat(ImageHolderFigure prototype,
                        java.lang.String formatName,
                        java.lang.String description,
                        java.lang.String fileExtension,
                        java.lang.String mimeType)
Creates a new image input format for the specified image format.

Parameters:
formatName - The format name for the javax.imageio.ImageIO object.
description - The format description to be used for the file filter.
fileExtension - The file extension to be used for the file filter.
mimeType - The mime type used for filtering data flavors from Transferable objects.

ImageInputFormat

public ImageInputFormat(ImageHolderFigure prototype,
                        java.lang.String formatName,
                        java.lang.String description,
                        java.lang.String[] fileExtensions,
                        java.lang.String[] mimeTypes)
Creates a new image input format for the specified image format.

Parameters:
formatName - The format name for the javax.imageio.ImageIO object.
description - The format description to be used for the file filter.
fileExtensions - The file extensions to be used for the file filter.
mimeTypes - The mime typse used for filtering data flavors from Transferable objects.
Method Detail

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

getFileExtensions

public java.lang.String[] getFileExtensions()

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.

read

public void read(java.io.File file,
                 Drawing drawing,
                 boolean replace)
          throws java.io.IOException
Description copied from interface: InputFormat
Reads figures from a file and adds them to the specified drawing.

Specified by:
read in interface InputFormat
Parameters:
file - The file.
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
Description copied from interface: InputFormat
Reads figures from a file and replaces the children of the drawing with them.

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

Specified by:
read in interface InputFormat
Parameters:
file - The file.
drawing - The drawing.
Throws:
java.io.IOException

read

public void read(java.io.InputStream in,
                 Drawing drawing,
                 boolean replace)
          throws java.io.IOException
Description copied from interface: InputFormat
Reads figures from a file and adds them to the specified drawing.

Specified by:
read in interface InputFormat
Parameters:
in - The input stream.
drawing - The drawing.
replace - Set this to true, if the contents of the stream replaces the contents of the drawing (for example, when loading a drawing from a stream). Set this to false, to add the contents of the file to the drawing (for example, when the stream has been dropped into the drawing view).
Throws:
java.io.IOException

createImageHolder

public ImageHolderFigure createImageHolder(java.io.InputStream in)
                                    throws java.io.IOException
Throws:
java.io.IOException

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

Copyright 1996-2010 (c) by the authors and contributors of the JHotDraw project.
Some rights reserved.