org.apache.batik.transcoder.wmf.tosvg

Class AbstractWMFReader

public abstract class AbstractWMFReader extends Object

This class provides a general framework to read WMF Metafiles.

Field Summary
protected int	bottom
protected boolean	bReading
protected int	height
protected int	inch
protected boolean	isAldus
protected boolean	isotropic
int	lastObjectIdx
protected int	left
protected int	mtHeaderSize
protected int	mtMaxRecord
protected int	mtNoObjects
protected int	mtNoParameters
protected int	mtSize
protected int	mtType
protected int	mtVersion
static float	MM_PER_PIXEL
protected int	numObjects
protected List	objectVector
static float	PIXEL_PER_INCH
protected int	right
protected float	scaleX
protected float	scaleXY
protected float	scaleY
protected int	top
protected int	vpH
protected int	vpW
protected int	vpX
protected int	vpY
protected int	width
protected int	windowHeight
protected int	windowWidth
protected int	xSign
protected int	ySign

Constructor Summary
	AbstractWMFReader()
	AbstractWMFReader(int width, int height)

Method Summary
int	addObject(int type, Object obj)
int	addObjectAt(int type, Object obj, int idx) Adds a GdiObject to the internal handle table.
int	getBottomUnits() get the bottom units in the WMF Metafile.
int	getHeightPixels() get the height of the WMF Metafile, in pixels.
int	getHeightUnits() get the height units in the WMF Metafile.
int	getLeftUnits() get the left units in the WMF Metafile.
int	getMetaFileUnitsPerInch() get the number of Metafile units per inch in the WMF Metafile.
int	getNumObjects() Returns the number of GdiObjects in the handle table
GdiObject	getObject(int idx) Returns a GdiObject from the handle table
float	getPixelsPerUnit() Return the number of pixels per unit.
Rectangle2D	getRectangleInch() get the Rectangle defining the viewport of the WMF Metafile, in inchs.
Rectangle2D	getRectanglePixel() get the Rectangle defining the viewport of the WMF Metafile, in pixels.
Rectangle	getRectangleUnits() get the Rectangle defining the viewport of the WMF Metafile, in Metafile units.
int	getRightUnits() get the right units in the WMF Metafile.
int	getTopUnits() get the top units in the WMF Metafile.
float	getUnitsToPixels() get the factor to transform Metafile dimensions in pixels
float	getViewportHeightInch() Returns the viewport height, in inches.
float	getViewportHeightUnits() Returns the viewport height, in Metafile Units
float	getViewportWidthInch() Returns the viewport width, in inches.
float	getViewportWidthUnits() Returns the viewport width, in Metafile Units
int	getVpH() Returns the viewport height, in pixels.
float	getVpHFactor() get the factor to transform logical units height in pixels
int	getVpW() Returns the viewport width, in pixels.
float	getVpWFactor() get the factor to transform logical units width in pixels
int	getWidthPixels() get the width of the WMF Metafile, in pixels.
int	getWidthUnits() get the width units in the WMF Metafile.
int	getXSign() Return the sign of X coordinates.
int	getYSign() Return the sign of Y coordinates.
boolean	isReading()
void	read(DataInputStream is) Reads the WMF file from the specified Stream, read it and set the following properties: mtType : File type (0 : memory, 1 : disk) mtHeaderSize : Size of header in WORDS (always 9) mtVersion : Version of Microsoft Windows used mtSize : Total size of the metafile in WORDs mtNoObjects : Number of objects in the file mtMaxRecord : The size of largest record in WORDs mtNoParameters : Not Used (always 0) If the file contains an APM (aldus placeable header), this method read these additionnal properties : left : Left coordinate in metafile units right : Right coordinate in metafile units top : Top coordinate in metafile units bottom : Bottom coordinate in metafile units inch : Number of metafile units per inch Then it calls the readRecords abstract method, whose behavior is left to the subclass .
protected int	readInt(DataInputStream is) Read the next int (4 bytes) value in the DataInputStream.
protected abstract boolean	readRecords(DataInputStream is) Read this InputStream records.
protected short	readShort(DataInputStream is) Read the next short (2 bytes) value in the DataInputStream.
abstract void	reset() resets this WMFReader.
protected void	setReading(boolean state)

Field Detail

PIXEL_PER_INCH

public static final float PIXEL_PER_INCH

Constructor Detail

AbstractWMFReader

public AbstractWMFReader(int width, int height)

Method Detail

addObject

public int addObject(int type, Object obj)

addObjectAt

public int addObjectAt(int type, Object obj, int idx)

Adds a GdiObject to the internal handle table. Wmf files specify the index as given in EMF records such as EMRCREATEPENINDIRECT whereas WMF files always use 0. This function should not normally be called by an application.

Returns: the object index

getBottomUnits

public int getBottomUnits()

get the bottom units in the WMF Metafile. This value is given in the Aldus Placable Header.

getHeightPixels

public int getHeightPixels()

get the height of the WMF Metafile, in pixels.

getHeightUnits

public int getHeightUnits()

get the height units in the WMF Metafile. This value is given in the Aldus Placable Header.

getLeftUnits

public int getLeftUnits()

get the left units in the WMF Metafile. This value is given in the Aldus Placable Metafile.

getMetaFileUnitsPerInch

public int getMetaFileUnitsPerInch()

get the number of Metafile units per inch in the WMF Metafile. This value is given in the Aldus Placable Header.

getNumObjects

public int getNumObjects()

Returns the number of GdiObjects in the handle table

getObject

public GdiObject getObject(int idx)

Returns a GdiObject from the handle table

getPixelsPerUnit

public float getPixelsPerUnit()

Return the number of pixels per unit.

getRectangleInch

public Rectangle2D getRectangleInch()

get the Rectangle defining the viewport of the WMF Metafile, in inchs.

getRectanglePixel

public Rectangle2D getRectanglePixel()

get the Rectangle defining the viewport of the WMF Metafile, in pixels.

getRectangleUnits

public Rectangle getRectangleUnits()

get the Rectangle defining the viewport of the WMF Metafile, in Metafile units. This viewport is defined in the Aldus Placable Header, by its left, top, bottom, right components.

getRightUnits

public int getRightUnits()

get the right units in the WMF Metafile. This value is given in the Aldus Placable Header.

getTopUnits

public int getTopUnits()

get the top units in the WMF Metafile. This value is given in the Aldus Placable Header.

getUnitsToPixels

public float getUnitsToPixels()

get the factor to transform Metafile dimensions in pixels

getViewportHeightInch

public float getViewportHeightInch()

Returns the viewport height, in inches.

getViewportHeightUnits

public float getViewportHeightUnits()

Returns the viewport height, in Metafile Units

getViewportWidthInch

public float getViewportWidthInch()

Returns the viewport width, in inches.

getViewportWidthUnits

public float getViewportWidthUnits()

Returns the viewport width, in Metafile Units

getVpH

public int getVpH()

Returns the viewport height, in pixels.

getVpHFactor

public float getVpHFactor()

get the factor to transform logical units height in pixels

getVpW

public int getVpW()

Returns the viewport width, in pixels.

getVpWFactor

public float getVpWFactor()

get the factor to transform logical units width in pixels

getWidthPixels

public int getWidthPixels()

get the width of the WMF Metafile, in pixels.

getWidthUnits

public int getWidthUnits()

get the width units in the WMF Metafile. This value is given in the Aldus Placable Header.

getXSign

public int getXSign()

Return the sign of X coordinates. It is equal to 1 by default, but can be -1 if all X coordinates are inversed.

getYSign

public int getYSign()

Return the sign of Y coordinates. It is equal to 1 by default, but can be -1 if all Y coordinates are inversed.

isReading

public boolean isReading()

Returns: true if the reader is currently reading an InputStream.

read

public void read(DataInputStream is)

Reads the WMF file from the specified Stream, read it and set the following properties:

mtType : File type (0 : memory, 1 : disk)
mtHeaderSize : Size of header in WORDS (always 9)
mtVersion : Version of Microsoft Windows used
mtSize : Total size of the metafile in WORDs
mtNoObjects : Number of objects in the file
mtMaxRecord : The size of largest record in WORDs
mtNoParameters : Not Used (always 0)

If the file contains an APM (aldus placeable header), this method read these additionnal properties :

left : Left coordinate in metafile units
right : Right coordinate in metafile units
top : Top coordinate in metafile units
bottom : Bottom coordinate in metafile units
inch : Number of metafile units per inch

Then it calls the readRecords abstract method, whose behavior is left to the subclass

readInt

protected int readInt(DataInputStream is)

Read the next int (4 bytes) value in the DataInputStream.

readRecords

protected abstract boolean readRecords(DataInputStream is)

Read this InputStream records. The aldus placeable header have already been read (see read). The behavior of this method is left to the subclass.

Each Metafile record is composed of :

the size of the Record in int (32 bits)
the function ID for the Record on a short word (16 bits)
the function parameters, according to the WMF Metafile specification. the remaining size in short words (16 bits) for the parameters is equal to the total size for the record minus 3 short words (= 16 + 32 bits)

Example :

while (functionId > 0) {
        recSize = readInt( is );
        // Subtract size in 16-bit words of recSize and functionId;
        recSize -= 3;
        functionId = readShort( is );
        if ( functionId <= 0 )
          break;
        switch ( functionId ) {
          case WMFConstants.<a WMF function ID> {
            do something when this function is encountered
          }
          break;

          default:
             for ( int j = 0; j < recSize; j++ )
               readShort(is);
          break;