org.jfree.pixie.wmf
Class MfRecord

java.lang.Object
  org.jfree.pixie.wmf.Buffer
      org.jfree.pixie.wmf.MfRecord

public class MfRecord

extends Buffer

A Windows metafile record.

Field Summary

static int

RECORD_HEADER_SIZE The size of the record header in bytes.

Fields inherited from class org.jfree.pixie.wmf.Buffer

bytes

Constructor Summary

MfRecord(java.io.InputStream in)
Constructs a new MfRecord by reading the data from the input stream.

MfRecord(int parcount)
Creates a new MetaFileRecord with the specified capacitiy.

Method Summary

boolean	doesMark() True if this record marks the screen.
int	getLongParam(int p) Return a 32-bit param from the given offset.
java.lang.String	getName() Return the name of this type of record.
int	getParam(int p) Return a 16-bit param from the given offset.
java.lang.String	getStringParam(int p, int len) Return a string param from the given offset.
int	getType() Queries the 16-bit type of this record.
boolean	isMappingMode() True if this record affects mapping modes.
protected void	read(java.io.InputStream in) Read a record from an input stream.
void	setLongParam(int p, int value) Defines a 32-bit param at the given offset.
void	setParam(int p, int value) Defines a 16-bit param at the given offset.
void	setStringParam(int p, java.lang.String s) Defines a string param at the given offset.
void	setType(int type) Defines the 16-bit type of this record.
java.lang.String	toString() Return debug info.

Methods inherited from class org.jfree.pixie.wmf.Buffer

getByte, getInputStream, getInt, getLength, getShort, getString, read, setByte, setCapacity, setInt, setLength, setShort, setString

Methods inherited from class java.lang.Object

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

Field Detail

RECORD_HEADER_SIZE

public static int RECORD_HEADER_SIZE

The size of the record header in bytes.

Constructor Detail

MfRecord

public MfRecord(int parcount)

Creates a new MetaFileRecord with the specified capacitiy. The capacity is given in 16-Bit words. The resulting buffer has the size of 2*parcount + RECORD_HEADER.

Parameters:

parcount - the number of 16-Bit words stored as bulk in the record.

MfRecord

public MfRecord(java.io.InputStream in)
         throws java.io.IOException

Constructs a new MfRecord by reading the data from the input stream.

Parameters:

in - the source inputstream

Throws:

java.io.IOException - if an IOError occurs.

Method Detail

read

protected void read(java.io.InputStream in)
             throws java.io.IOException

Read a record from an input stream.

Throws:

java.io.IOException

getType

public int getType()

Queries the 16-bit type of this record.

Returns:

the RecordType

setType

public void setType(int type)

Defines the 16-bit type of this record.

Parameters:

type - the RecordType

getParam

public int getParam(int p)

Return a 16-bit param from the given offset. Offset is in 16-bit words.

Parameters:

p - the parameter position in words.

Returns:

the parameter value.

setParam

public void setParam(int p,
                     int value)

Defines a 16-bit param at the given offset. Offset is in 16-bit words.

Parameters:

p - the parameter position in words.

value - the parameter value.

getLongParam

public int getLongParam(int p)

Return a 32-bit param from the given offset. Offset is in 16-bit words.

Parameters:

p - the parameter position in words.

Returns:

the parameter value.

setLongParam

public void setLongParam(int p,
                         int value)

Defines a 32-bit param at the given offset. Offset is in 16-bit words.

Parameters:

p - the parameter position in words.

value - the parameter value.

getStringParam

public java.lang.String getStringParam(int p,
                                       int len)

Return a string param from the given offset. Offset is in 16-bit words.

Parameters:

p - the parameter position in words.

Returns:

the parameter value.

setStringParam

public void setStringParam(int p,
                           java.lang.String s)

Defines a string param at the given offset. Offset is in 16-bit words.

Parameters:

p - the parameter position in words.

s - the parameter value.

getName

public java.lang.String getName()

Return the name of this type of record.

toString

public java.lang.String toString()

Return debug info.

doesMark

public boolean doesMark()

True if this record marks the screen. Currently such records are ignored.

isMappingMode

public boolean isMappingMode()

True if this record affects mapping modes.