org.pentaho.reporting.libraries.pixie.wmf.records

Class MfCmd

java.lang.Object

org.pentaho.reporting.libraries.pixie.wmf.records.MfCmd

Direct Known Subclasses:

MfCmdAnimatePalette, MfCmdArc, MfCmdBitBlt, MfCmdChord, MfCmdCreateBrush, MfCmdCreateDibPatternBrush, MfCmdCreateFont, MfCmdCreatePalette, MfCmdCreatePatternBrush, MfCmdCreatePen, MfCmdCreateRegion, MfCmdDeleteObject, MfCmdDibBitBlt, MfCmdDibStretchBlt, MfCmdEllipse, MfCmdEscape, MfCmdExcludeClipRect, MfCmdExtFloodFill, MfCmdExtTextOut, MfCmdFillRegion, MfCmdFloodFill, MfCmdFrameRegion, MfCmdIntersectClipRect, MfCmdInvertRegion, MfCmdLineTo, MfCmdMoveTo, MfCmdOffsetClipRgn, MfCmdOffsetViewportOrg, MfCmdOffsetWindowOrg, MfCmdPaintRgn, MfCmdPatBlt, MfCmdPie, MfCmdPolygon, MfCmdPolyline, MfCmdPolyPolygon, MfCmdRealisePalette, MfCmdRectangle, MfCmdResizePalette, MfCmdRestoreDc, MfCmdRoundRect, MfCmdSaveDc, MfCmdScaleViewportExt, MfCmdScaleWindowExt, MfCmdSelectClipRegion, MfCmdSelectObject, MfCmdSelectPalette, MfCmdSetBkColor, MfCmdSetBkMode, MfCmdSetDibitsToDevice, MfCmdSetMapMode, MfCmdSetMapperFlags, MfCmdSetPaletteEntries, MfCmdSetPixel, MfCmdSetPolyFillMode, MfCmdSetRop2, MfCmdSetStretchBltMode, MfCmdSetTextAlign, MfCmdSetTextCharExtra, MfCmdSetTextColor, MfCmdSetTextJustification, MfCmdSetViewPortExt, MfCmdSetViewPortOrg, MfCmdSetWindowExt, MfCmdSetWindowOrg, MfCmdStretchBlt, MfCmdStretchDibits, MfCmdTextOut, MfCmdUnknownCommand

public abstract class MfCmd
extends Object

This is the base class for all WMF-Records. A WMF record specifies a single command for drawing a element of the image.

Method Summary

Modifier and Type	Method and Description
abstract int	getFunction() Reads the function identifier.
abstract MfCmd	getInstance() Creates a empty unintialized copy of this command implementation.
abstract MfRecord	getRecord() Creates a new record based on the data stored in the MfCommand.
int	getScaledX(int x) Return integer scaled to output units.
int	getScaledY(int y) Return integer scaled to output units.
abstract void	replay(WmfFile metafile) Replays the command on the given WmfFile.
abstract void	setRecord(MfRecord record) Reads the command data from the given record and adjusts the internal parameters according to the data parsed.
void	setScale(float scaleX, float scaleY) Set the scale for the command.

Methods inherited from class java.lang.Object

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

Method Detail

getRecord

public abstract MfRecord getRecord()
                            throws RecordCreationException

Creates a new record based on the data stored in the MfCommand.

Returns:

the created record.

Throws:

RecordCreationException - if an error occured while generating the record.

setRecord

public abstract void setRecord(MfRecord record)

Reads the command data from the given record and adjusts the internal parameters according to the data parsed.

After the raw record was read from the datasource, the record is parsed by the concrete implementation.

Parameters:

record - the raw data that makes up the record.

getFunction

public abstract int getFunction()

Reads the function identifier. Every record type is identified by a function number corresponding to one of the Windows GDI functions used.

Returns:

the function identifier.

getInstance

public abstract MfCmd getInstance()

Creates a empty unintialized copy of this command implementation.

Returns:

a new instance of the command.

replay

public abstract void replay(WmfFile metafile)

Replays the command on the given WmfFile.

Parameters:

metafile - the meta file.

setScale

public void setScale(float scaleX,
                     float scaleY)

Set the scale for the command.

Parameters:

scaleX - the horizontal scale

scaleY - the vertical scale

getScaledY

public int getScaledY(int y)

Return integer scaled to output units.

Parameters:

y - the unscaled y

Returns:

the scaled y value

getScaledX

public int getScaledX(int x)

Return integer scaled to output units.

Parameters:

x - the unscaled x

Returns:

the scaled x value