EMFDeviceContext (jvectClipboard 8.0.0 API)

java.lang.Object
- org.qenherkhopeshef.graphics.emf.EMFDeviceContext

All Implemented Interfaces:

EMFOpCodes
```
public class EMFDeviceContext
extends java.lang.Object
implements EMFOpCodes
```
A low level implementation of the emf vector file device.
The default scale is 1 device unit = 1/100 mm. It can be changed using setReferenceRatios(). To avoid the burden of encapsulating each integer value in an object, we have decided to use the following conventions:
In contrast with WMF, the order of coordinates in EMF is the usual one. X, then Y. (U means unsigned, S means signed, and the size is in bits).
- U8 is represented by a char.
- S16 is represented by a short.
- U16 is represented by an int.
- S32 is represented by an long.
- U32 is represented by an long.
- Thanks to these choices, computations are straightforward.

Field Summary
- Fields inherited from interface org.qenherkhopeshef.graphics.emf.EMFOpCodes
  EMR_ABORTPATH, EMR_ANGLEARC, EMR_ARC, EMR_ARCTO, EMR_BEGINPATH, EMR_BITBLT, EMR_CHORD, EMR_CLOSEFIGURE, EMR_CREATEBRUSHINDIRECT, EMR_CREATEDIBPATTERNBRUSHPT, EMR_CREATEMONOBRUSH, EMR_CREATEPALETTE, EMR_CREATEPEN, EMR_DELETEOBJECT, EMR_ELLIPSE, EMR_ENDPATH, EMR_EOF, EMR_EXCLUDECLIPRECT, EMR_EXTCREATEFONTINDIRECTW, EMR_EXTCREATEPEN, EMR_EXTFLOODFILL, EMR_EXTSELECTCLIPRGN, EMR_EXTTEXTOUTA, EMR_EXTTEXTOUTW, EMR_FILLPATH, EMR_FILLRGN, EMR_FLATTENPATH, EMR_FRAMERGN, EMR_GDICOMMENT, EMR_HEADER, EMR_INTERSECTCLIPRECT, EMR_INVERTRGN, EMR_LINETO, EMR_MASKBLT, EMR_MODIFYWORLDTRANSFORM, EMR_MOVETOEX, EMR_OFFSETCLIPRGN, EMR_PAINTRGN, EMR_PIE, EMR_PLGBLT, EMR_POLYBEZIER, EMR_POLYBEZIER16, EMR_POLYBEZIERTO, EMR_POLYBEZIERTO16, EMR_POLYDRAW, EMR_POLYDRAW16, EMR_POLYGON, EMR_POLYGON16, EMR_POLYLINE, EMR_POLYLINE16, EMR_POLYLINETO, EMR_POLYLINETO16, EMR_POLYPOLYGON, EMR_POLYPOLYGON16, EMR_POLYPOLYLINE, EMR_POLYPOLYLINE16, EMR_POLYTEXTOUTA, EMR_POLYTEXTOUTW, EMR_REALIZEPALETTE, EMR_RECTANGLE, EMR_RESIZEPALETTE, EMR_RESTOREDC, EMR_ROUNDRECT, EMR_SAVEDC, EMR_SCALEVIEWPORTEXTEX, EMR_SCALEWINDOWEXTEX, EMR_SELECTCLIPPATH, EMR_SELECTOBJECT, EMR_SELECTPALETTE, EMR_SETARCDIRECTION, EMR_SETBKCOLOR, EMR_SETBKMODE, EMR_SETBRUSHORGEX, EMR_SETCOLORADJUSTMENT, EMR_SETDIBITSTODEVICE, EMR_SETMAPMODE, EMR_SETMAPPERFLAGS, EMR_SETMETARGN, EMR_SETMITERLIMIT, EMR_SETPALETTEENTRIES, EMR_SETPIXELV, EMR_SETPOLYFILLMODE, EMR_SETROP2, EMR_SETSTRETCHBLTMODE, EMR_SETTEXTALIGN, EMR_SETTEXTCOLOR, EMR_SETVIEWPORTEXTEX, EMR_SETVIEWPORTORGEX, EMR_SETWINDOWEXTEX, EMR_SETWINDOWORGEX, EMR_SETWORLDTRANSFORM, EMR_STRETCHBLT, EMR_STRETCHDIBITS, EMR_STROKEANDFILLPATH, EMR_STROKEPATH, EMR_WIDENPATH

Constructor Summary

Constructors
Constructor and Description
`EMFDeviceContext(RandomAccessStream stream, java.awt.Dimension dims, java.lang.String creator, java.lang.String comment)` Create a device context.
`EMFDeviceContext(RandomAccessStream stream, long width, long height, java.lang.String creator, java.lang.String comment)` Create a metafile in a RandomAccessStream, for instance a RandomAccessByteArray or a RandomAccessFile.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`beginPath()`
`void`	`closeFigure()`
`void`	`closeMetafile()`
`short`	`createBrush(long hatch, long colour, long style)` Create a new brush and returns its number.
`EMFPen`	`createDrawPen(int penStyle, short width, long colour)`
`EMFPen`	`createDrawPen(short width, long colour)`
`EMFPen`	`createFillPen(long colour)`
`EMFPen`	`createFillPen(short fillHatch, long colour, int fillStyle)`
`short`	`createPen(int penStyle, int width, long colour)` Create a pen and return its object id.
`EMFPen`	`createPenBrush(int penStyle, short width, long penColour, short fillhatch, long fillColour, int fillStyle)` Generic function for building a Pen.
`void`	`deleteObject(int nobj)`
`void`	`deletePen(EMFPen pen)`
`void`	`endPath()`
`void`	`fillPath()` fill the last path.
`void`	`freePen(EMFPen pen)`
`double`	`getDevicePointSize()`
`double`	`getXScale()` Returns the length (in mm) of one horizontal device unit.
`double`	`getYScale()` Returns the length (in mm) of one vertical device unit.
`void`	`lineTo(EMFPoint point)`
`void`	`lineTo(long x, long y)`
`void`	`moveToEx(EMFPoint point)`
`void`	`moveToEx(long x, long y)` Moves the current point.
`void`	`polyBezierTo(EMFRectangle boundingBox, EMFPoint[] controls)` Draws a Bezier curve.
`void`	`polyBezierTo16(EMFRectangle boundingBox, EMFPoint[] controls)` Draws a Bezier curve.
`void`	`restoreDC()`
`void`	`saveDC()`
`void`	`selectObject(long nobj)`
`void`	`selectPen(EMFPen pen)`
`void`	`setBkColor(long color)`
`void`	`setBkMode(int bkMode)` Sets the background mode
`void`	`setDevicePointSize(double devicePointSize)` Sets the size of device point, in mm.
`void`	`setMapMode(long mapMode)` Sets the device coordinate system to use.
`void`	`setReferenceRatios(long dXpixels, long dyPixels, long dxMM, long dyMM)` Sets the scale for this picture.
`void`	`setTextColor(int col)`
`void`	`setViewPortOrgEx(int x, int y)`
`void`	`setWindowExt(int w, int h)` Sets the reference window extension.
`void`	`setWindowExtEx(int w, int h)` Defines window size in logical units.
`void`	`setWindowOrg(int x, int y)`
`void`	`setWindowOrgEx(int x, int y)` Sets window origin.
`void`	`strokePath(int minx, int miny, int maxx, int maxy)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- EMFDeviceContext
```
public EMFDeviceContext(RandomAccessStream stream,
                        java.awt.Dimension dims,
                        java.lang.String creator,
                        java.lang.String comment)
                 throws java.io.IOException
```
  Create a device context. If both software name and comments are null, the EMF file will have no comment.
  
  Parameters:
  
  stream - the stream where the data will be written.
  
  dims - size of the picture.
  
  creator - the software's name (may be null) (will default to "java" if needed).
  
  comment - a free text comment (may be null)
  
  Throws:
  
  java.io.IOException
- EMFDeviceContext
```
public EMFDeviceContext(RandomAccessStream stream,
                        long width,
                        long height,
                        java.lang.String creator,
                        java.lang.String comment)
                 throws java.io.IOException
```
  Create a metafile in a RandomAccessStream, for instance a RandomAccessByteArray or a RandomAccessFile. If both software name and comments are null, the EMF file will have no comment.
  
  Parameters:
  
  stream -
  
  width - : width in device points
  
  height - : height in mm
  
  creator - the software's name (may be null) (will default to "java" if needed).
  
  comment - a free text comment (may be null)
  
  Throws:
  
  java.io.IOException

Method Detail

beginPath

public void beginPath()
               throws java.io.IOException

Throws:: java.io.IOException

closeMetafile

public void closeMetafile()
                   throws java.io.IOException

Throws:: java.io.IOException

deleteObject

public void deleteObject(int nobj)
                  throws java.io.IOException

Throws:: java.io.IOException

endPath

public void endPath()
             throws java.io.IOException

Throws:: java.io.IOException

fillPath
```
public void fillPath()
              throws java.io.IOException
```
fill the last path. We should probably pass the dimensions as an argument.

Throws:

java.io.IOException

lineTo

public void lineTo(long x,
                   long y)
            throws java.io.IOException

Parameters:: x -; y -
Throws:: java.io.IOException

moveToEx

public void moveToEx(long x,
                     long y)
              throws java.io.IOException

Moves the current point.

Parameters:: x -; y -
Throws:: java.io.IOException

polyBezierTo

public void polyBezierTo(EMFRectangle boundingBox,
                         EMFPoint[] controls)
                  throws java.io.IOException

Draws a Bezier curve.

Parameters:: boundingBox - can be null, in which case it is computed.; controls -
Throws:: java.io.IOException

polyBezierTo16

public void polyBezierTo16(EMFRectangle boundingBox,
                           EMFPoint[] controls)
                    throws java.io.IOException

Draws a Bezier curve.

Parameters:: boundingBox - : can't be null.; controls -
Throws:: java.io.IOException

createBrush
```
public short createBrush(long hatch,
                         long colour,
                         long style)
                  throws java.io.IOException
```
Create a new brush and returns its number.

Parameters:

hatch - (a hatch style from WMFConstants: HS_something.)

colour - a 24bit RGB colour.

style - (a brush style from WMFConstants: BS_something.)

Returns:

the object id for this brush.

Throws:

java.io.IOException

See Also:

WMFConstants

createPen
```
public short createPen(int penStyle,
                       int width,
                       long colour)
                throws java.io.IOException
```
Create a pen and return its object id.

Parameters:

penStyle - a pen style (from WMFConstants)

width - pen width

colour - pen colour.

Throws:

java.io.IOException

setBkColor

public void setBkColor(long color)
                throws java.io.IOException

Throws:: java.io.IOException

strokePath

public void strokePath(int minx,
                       int miny,
                       int maxx,
                       int maxy)
                throws java.io.IOException

Throws:: java.io.IOException

setMapMode
```
public void setMapMode(long mapMode)
                throws java.io.IOException
```
Sets the device coordinate system to use. We suggest TWIPS 1/20 of a point, or 1/1440 of an inch

Parameters:

mapMode - one of the MM codes from the WMFConstants interface.

Throws:

java.io.IOException

See Also:

WMFConstants

setReferenceRatios
```
public void setReferenceRatios(long dXpixels,
                               long dyPixels,
                               long dxMM,
                               long dyMM)
```
Sets the scale for this picture.
The scales are expressed as two couples dXPixels/dxMM and dyPixel/dyMM. What's important is the corresponding ratio.

Parameters:

dXpixels -

dyPixels -

dxMM -

dyMM -

getXScale
```
public double getXScale()
```
Returns the length (in mm) of one horizontal device unit.

getYScale
```
public double getYScale()
```
Returns the length (in mm) of one vertical device unit.

setDevicePointSize
```
public void setDevicePointSize(double devicePointSize)
```
Sets the size of device point, in mm. Default value is 0.01mm.

Parameters:

devicePointSize - the devicePointSize to set

getDevicePointSize
```
public double getDevicePointSize()
```
Returns:

the devicePointSize

selectObject

public void selectObject(long nobj)
                  throws java.io.IOException

Throws:: java.io.IOException

closeFigure

public void closeFigure()
                 throws java.io.IOException

Throws:: java.io.IOException

setWindowOrg

public void setWindowOrg(int x,
                         int y)
                  throws java.io.IOException

Parameters:: x -; y -
Throws:: java.io.IOException

setWindowExt

public void setWindowExt(int w,
                         int h)
                  throws java.io.IOException

Sets the reference window extension.

Parameters:: w -; h -
Throws:: java.io.IOException

setWindowOrgEx

public void setWindowOrgEx(int x,
                           int y)
                    throws java.io.IOException

Sets window origin.

Parameters:: x -; y -
Throws:: java.io.IOException

setWindowExtEx

public void setWindowExtEx(int w,
                           int h)
                    throws java.io.IOException

Defines window size in logical units.

Parameters:: w -; h -
Throws:: java.io.IOException

setBkMode
```
public void setBkMode(int bkMode)
               throws java.io.IOException
```
Sets the background mode

Parameters:

bkMode - one of WMFConstants.TRANSPARENT or WMFConstants.OPAQUE

Throws:

java.io.IOException

See Also:

WMFConstants

lineTo

public void lineTo(EMFPoint point)
            throws java.io.IOException

Throws:: java.io.IOException

moveToEx

public void moveToEx(EMFPoint point)
              throws java.io.IOException

Throws:: java.io.IOException

createPenBrush
```
public EMFPen createPenBrush(int penStyle,
                             short width,
                             long penColour,
                             short fillhatch,
                             long fillColour,
                             int fillStyle)
                      throws java.io.IOException
```
Generic function for building a Pen.

Parameters:

penStyle - : one of : one of PS_SOLID, PS_DASH, PS_DOT, PS_DASHDOT, PS_DASHDOTDOT, PS_NULL, PS_INSIDEFRAME, PS_USERSTYLE, PS_ALTERNATE

width - : the pen's width, in 1/1440 of an inch.

penColour - : the line colour

fillhatch - : ignored if style is not hatched ; else : one of HS_HORIZONTAL, HS_VERTICAL, HS_FDIAGONAL, HS_BDIAGONAL, HS_CROSS, HS_DIAGCROSS

fillColour - : the fill colour.

fillStyle - one of BS_SOLID, BS_NULL or BS_HATCHED.

Returns:

the new pen.

Throws:

java.io.IOException

createDrawPen

public EMFPen createDrawPen(int penStyle,
                            short width,
                            long colour)
                     throws java.io.IOException

Throws:: java.io.IOException

createDrawPen

public EMFPen createDrawPen(short width,
                            long colour)
                     throws java.io.IOException

Throws:: java.io.IOException

createFillPen

public EMFPen createFillPen(short fillHatch,
                            long colour,
                            int fillStyle)
                     throws java.io.IOException

Throws:: java.io.IOException

deletePen

public void deletePen(EMFPen pen)
               throws java.io.IOException

Throws:: java.io.IOException

saveDC

public void saveDC()
            throws java.io.IOException

Throws:: java.io.IOException

restoreDC

public void restoreDC()
               throws java.io.IOException

Throws:: java.io.IOException

createFillPen

public EMFPen createFillPen(long colour)
                     throws java.io.IOException

Throws:: java.io.IOException

selectPen

public void selectPen(EMFPen pen)
               throws java.io.IOException

Throws:: java.io.IOException

freePen

public void freePen(EMFPen pen)
             throws java.io.IOException

Throws:: java.io.IOException

setViewPortOrgEx

public void setViewPortOrgEx(int x,
                             int y)
                      throws java.io.IOException

Throws:: java.io.IOException

setTextColor

public void setTextColor(int col)
                  throws java.io.IOException

Throws:: java.io.IOException

Class EMFDeviceContext

Field Summary

Fields inherited from interface org.qenherkhopeshef.graphics.emf.EMFOpCodes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EMFDeviceContext

EMFDeviceContext

Method Detail

beginPath

closeMetafile

deleteObject

endPath

fillPath

lineTo

moveToEx

polyBezierTo

polyBezierTo16

createBrush

createPen

setBkColor

strokePath

setMapMode

setReferenceRatios

getXScale

getYScale

setDevicePointSize

getDevicePointSize

selectObject

closeFigure

setWindowOrg

setWindowExt

setWindowOrgEx

setWindowExtEx

setBkMode

lineTo

moveToEx

createPenBrush

createDrawPen

createDrawPen

createFillPen

deletePen

saveDC

restoreDC

createFillPen

selectPen

freePen

setViewPortOrgEx

setTextColor