org.jfree.pixie.wmf.records

Class MfCmdFrameRegion


public class MfCmdFrameRegion
extends MfCmd

The FrameRgn function draws a border around the specified region by using the specified brush.

Constructor Summary

MfCmdFrameRegion()
The default constructor, adjusts the scale to 1.

Method Summary

int
getBrush()
Dimension
getDimension()
int
getFunction()
Reads the function identifier.
MfCmd
getInstance()
Creates a empty unintialized copy of this command implementation.
MfRecord
getRecord()
Creates a new record based on the data stored in the MfCommand.
int
getRegion()
Dimension
getScaledDimension()
void
replay(WmfFile file)
Replays the command on the given WmfFile.
protected void
scaleXChanged()
A callback function to inform the object, that the x scale has changed and the internal coordinate values have to be adjusted.
protected void
scaleYChanged()
A callback function to inform the object, that the y scale has changed and the internal coordinate values have to be adjusted.
void
setBrush(int brush)
void
setDimension(Dimension dim)
void
setDimension(int width, int height)
void
setRecord(MfRecord record)
Reads the command data from the given record and adjusts the internal parameters according to the data parsed.
void
setRegion(int region)
String
toString()

Methods inherited from class org.jfree.pixie.wmf.records.MfCmd

applyScaleX, applyScaleY, getFunction, getInstance, getRecord, getScaledHeight, getScaledWidth, getScaledX, getScaledY, replay, scaleRect, scaleXChanged, scaleYChanged, setRecord, setScale

Constructor Details

MfCmdFrameRegion

public MfCmdFrameRegion()
The default constructor, adjusts the scale to 1.

Method Details

getBrush

public int getBrush()

getDimension

public Dimension getDimension()

getFunction

public int getFunction()
Reads the function identifier. Every record type is identified by a function number corresponding to one of the Windows GDI functions used.
Overrides:
getFunction in interface MfCmd
Returns:
the function identifier.

getInstance

public MfCmd getInstance()
Creates a empty unintialized copy of this command implementation.
Overrides:
getInstance in interface MfCmd
Returns:
a new instance of the command.

getRecord

public MfRecord getRecord()
Creates a new record based on the data stored in the MfCommand.
Overrides:
getRecord in interface MfCmd
Returns:
the created record.

getRegion

public int getRegion()

getScaledDimension

public Dimension getScaledDimension()

replay

public void replay(WmfFile file)
Replays the command on the given WmfFile.
Overrides:
replay in interface MfCmd
Parameters:
file - the meta file.

scaleXChanged

protected void scaleXChanged()
A callback function to inform the object, that the x scale has changed and the internal coordinate values have to be adjusted.
Overrides:
scaleXChanged in interface MfCmd

scaleYChanged

protected void scaleYChanged()
A callback function to inform the object, that the y scale has changed and the internal coordinate values have to be adjusted.
Overrides:
scaleYChanged in interface MfCmd

setBrush

public void setBrush(int brush)

setDimension

public void setDimension(Dimension dim)

setDimension

public void setDimension(int width,
                         int height)

setRecord

public 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.

Overrides:
setRecord in interface MfCmd
Parameters:
record - the raw data that makes up the record.

setRegion

public void setRegion(int region)

toString

public String toString()