Package org.apache.poi.hwmf.record

Class HwmfDraw.WmfFrameRegion

java.lang.Object

org.apache.poi.hwmf.record.HwmfDraw.WmfFrameRegion

All Implemented Interfaces:

GenericRecord, HwmfRecord

Direct Known Subclasses:

HemfFill.EmfFrameRgn

Enclosing class:

HwmfDraw

public static class HwmfDraw.WmfFrameRegion
extends Object
implements HwmfRecord

The META_FRAMEREGION record draws a border around a specified region using a specified brush.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	brushIndex	A 16-bit unsigned integer used to index into the WMF Object Table to get the Brush to use for filling the region.
protected final Dimension2D	frame	The region frame, in logical units
protected int	regionIndex	A 16-bit unsigned integer used to index into the WMF Object Table to get the region to be framed.

Constructor Summary

Constructors

Constructor	Description
WmfFrameRegion()

Method Summary

Modifier and Type	Method	Description
void	draw(HwmfGraphics ctx)	Apply the record settings to the graphics context
int	getBrushIndex()
Dimension2D	getFrame()
Map<String,Supplier<?>>	getGenericProperties()
int	getRegionIndex()
HwmfRecordType	getWmfRecordType()
int	init(LittleEndianInputStream leis, long recordSize, int recordFunction)	Init record from stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren

Methods inherited from interface org.apache.poi.hwmf.record.HwmfRecord

getGenericRecordType

Field Details

regionIndex

protected int regionIndex

A 16-bit unsigned integer used to index into the WMF Object Table to get the region to be framed.

brushIndex

protected int brushIndex

A 16-bit unsigned integer used to index into the WMF Object Table to get the Brush to use for filling the region.

frame

protected final Dimension2D frame

The region frame, in logical units

Constructor Details

WmfFrameRegion

public WmfFrameRegion()

Method Details

getWmfRecordType

public HwmfRecordType getWmfRecordType()

Specified by:

getWmfRecordType in interface HwmfRecord

init

public int init(LittleEndianInputStream leis,
 long recordSize,
 int recordFunction)
         throws IOException

Description copied from interface: HwmfRecord

Init record from stream

Specified by:

init in interface HwmfRecord

Parameters:

leis - the little endian input stream

Returns:

count of processed bytes

Throws:

IOException

draw

public void draw(HwmfGraphics ctx)

Description copied from interface: HwmfRecord

Apply the record settings to the graphics context

Specified by:

draw in interface HwmfRecord

Parameters:

ctx - the graphics context to modify

getRegionIndex

public int getRegionIndex()

getBrushIndex

public int getBrushIndex()

getFrame

public Dimension2D getFrame()

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord