com.heirloomcomputing.ecs.api

Interface IGenericPrinter

public interface IGenericPrinter

Generic Printing Functions

Any class that implements this may be used as a PERCobol printer.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONNECT_ALL
static int	CONNECT_DOUBLE
static int	CONNECT_DOWN
static int	CONNECT_HORIZONTAL
static int	CONNECT_LEFT
static int	CONNECT_RIGHT
static int	CONNECT_ROUND
static int	CONNECT_SHADE
static int	CONNECT_SINGLE
static int	CONNECT_TYPE
static int	CONNECT_UP
static int	CONNECT_VERTICAL
static int	PD_RETURN_CANCELLED
static int	PD_RETURN_ERROR
static int	PD_RETURN_OK
static int	PITCH_COMPRESSED_VALUE
static int	PITCH_EXPANDED_VALUE
static int	PITCH_NORMAL_VALUE

Method Summary

Modifier and Type	Method and Description
void	clearDialog() Set the dialog to initial unset default values.
void	clearFont() Clear the font to default.
void	close() Close the printer access.
java.lang.String	command(java.lang.String command) Command Send arbitrary text commands to the PERCobol printer driver; this may be interpreted in any manner by the PERCobol printer driver.
boolean	displayDialog() Display Dialog Box to user.
void	draw(java.awt.Component component, double xpos, double ypos, double width, double height) Draw a Component
void	draw(java.awt.Image image, double xpos, double ypos, double width, double height) Draw a Bitmap.
void	drawArc(double xpos, double ypos, double width, double height, boolean shade, int startAngle, int endAngle) Draw a partial Oval, optionally shaded.
void	drawBox(double xpos, double ypos, double width, double height, boolean shade, boolean _3d, boolean raised) Draw a Box, shaded or 3d.
void	drawBox(double xpos, double ypos, double width, double height, boolean shade, int arcWidth, int arcHeight) Draw a Rounded Box, optionally shaded.
void	drawLine(double x1, double y1, double x2, double y2) Draw a line; set the next from to the current to.
void	drawLineFrom(double x1, double y1) Set the initial drawing location for the next drawLineTo; does not render anything.
void	drawLineTo(double x2, double y2) Draw a line to the given coordinates, from the last drawn line.
void	drawOval(double xpos, double ypos, double width, double height, boolean shade) Draw an Oval
void	eject() Eject the current page.
double	getBottomMargin() Get the bottom margin.
java.awt.Component	getComponent() Return a component related to the printing; this is suitable ONLY for usage with obtaining an image, and it is NOT guaranteed to be anything other than null for a CobolPrinter, especially on later edition servers.
java.lang.String	getDeviceCapability(java.lang.String attrib) Get the value of a device attribute.
java.lang.String	getDialog(java.lang.String attribute) Get Dialog attributes.
java.awt.Font	getFont() Get the current font.
java.awt.FontMetrics	getFontMetrics() Get the current font metrics.
double	getLeftMargin() Get the left margin.
double	getPositionX() Set the pen attributes.
double	getPositionY() Set the pen attributes.
java.lang.String	getPrinterInfo(java.lang.String attrib) Get printer info attribute.
double	getScaleX(java.lang.String unitName) Get scale in the X direction
double	getScaleY(java.lang.String unitName) Get scale in the Y direction
java.awt.Color	getShadeColor() Get shading color;
java.awt.Color	getTextColor() Get the text color.
java.awt.Dimension	getTextExtent(java.lang.String text) Get renderable text extend in width and height as Dimension.
double	getTextPositionX(boolean bottom)
double	getTextPositionY(boolean bottom)
double	getTopMargin() Get the top margin.
boolean	isFontStrikeOut()
boolean	isFontUnderline()
boolean	open(boolean enableDialog, boolean rawMode, java.lang.String filename) Open the printer according to filename.
void	setBottomMargin(double bottomMargin) Set the bottom margin.
void	setConnector(double xpos, double ypos, int type) Set a connector of the given type on the page; the page is responsible for connecting connectors appropriately.
void	setConnectorThickness(int thickness) Set the connector thickness, in pixels away from the center.
void	setDeviceMode(java.lang.String attrib, java.lang.String value) Set device modes.
void	setDialog(java.lang.String attribute, java.lang.String value) Set Dialog attributes.
void	setEscapeSequences(boolean state) Enable or disable escape sequences.
void	setFont(java.awt.Font f, boolean underline, boolean strikeOut, boolean doubleStrike) Set the current font.
void	setLeftMargin(double leftMargin) Set the left margin.
void	setLineExtend(double extend) Set the amount of space between two overwritten lines.
void	setPaintMode() PaintMode This is the normal painting mode for drawing to the printer.
void	setPen(int penStyle, double penWidth, java.awt.Color penColor) Set the pen attributes.
void	setPitch(int pitchType) Set the pitch of the font.
void	setPositionX(double xpos) Set the pen attributes.
void	setPositionY(double ypos) Set the pen attributes.
void	setShadeColor(java.awt.Color shade) Set shading color.
void	setTabStop(double tabStops) Set the tab stop increment.
void	setTextColor(java.awt.Color textColor) Set the text color.
void	setTextPositionX(double xpos, boolean bottom) Set the text position x.
void	setTextPositionY(double ypos, boolean bottom) Set the text position y.
void	setTopMargin(double topMargin) Set the top margin.
void	setXORMode(java.awt.Color c) XORMode This painting mode for drawing to the printer has the attribute such that drawing the object twice will return the graphics to the original state.
void	textOut(java.lang.String text, double xpos, double ypos, boolean box, boolean shade) Output text at position, with a box or shade.
boolean	write(java.lang.String text) Write plain text, with possible escapes if enabled; this MAY cause a page eject and movement to the next page.

Field Detail

PD_RETURN_OK

static final int PD_RETURN_OK

See Also:

Constant Field Values

PD_RETURN_CANCELLED

static final int PD_RETURN_CANCELLED

See Also:

Constant Field Values

PD_RETURN_ERROR

static final int PD_RETURN_ERROR

See Also:

Constant Field Values

PITCH_NORMAL_VALUE

static final int PITCH_NORMAL_VALUE

See Also:

Constant Field Values

PITCH_EXPANDED_VALUE

static final int PITCH_EXPANDED_VALUE

See Also:

Constant Field Values

PITCH_COMPRESSED_VALUE

static final int PITCH_COMPRESSED_VALUE

See Also:

Constant Field Values

CONNECT_LEFT

static final int CONNECT_LEFT

See Also:

Constant Field Values

CONNECT_RIGHT

static final int CONNECT_RIGHT

See Also:

Constant Field Values

CONNECT_UP

static final int CONNECT_UP

See Also:

Constant Field Values

CONNECT_DOWN

static final int CONNECT_DOWN

See Also:

Constant Field Values

CONNECT_HORIZONTAL

static final int CONNECT_HORIZONTAL

See Also:

Constant Field Values

CONNECT_VERTICAL

static final int CONNECT_VERTICAL

See Also:

Constant Field Values

CONNECT_ALL

static final int CONNECT_ALL

See Also:

Constant Field Values

CONNECT_SHADE

static final int CONNECT_SHADE

See Also:

Constant Field Values

CONNECT_SINGLE

static final int CONNECT_SINGLE

See Also:

Constant Field Values

CONNECT_DOUBLE

static final int CONNECT_DOUBLE

See Also:

Constant Field Values

CONNECT_ROUND

static final int CONNECT_ROUND

See Also:

Constant Field Values

CONNECT_TYPE

static final int CONNECT_TYPE

See Also:

Constant Field Values

Method Detail

clearDialog

void clearDialog()

Set the dialog to initial unset default values.

displayDialog

boolean displayDialog()

Display Dialog Box to user.

Returns:

true for success, false for failure, RuntimeException for error

getDialog

java.lang.String getDialog(java.lang.String attribute)

Get Dialog attributes.

Parameters:

attribute - the Dialog attribute.

Returns:

value of attribute

setDialog

void setDialog(java.lang.String attribute,
               java.lang.String value)

Set Dialog attributes.

Parameters:

attribute - The Dialog attribute.

value - The value of the attribute.

getComponent

java.awt.Component getComponent()

Return a component related to the printing; this is suitable ONLY for usage with obtaining an image, and it is NOT guaranteed to be anything other than null for a CobolPrinter, especially on later edition servers.

Returns:

the component

getScaleX

double getScaleX(java.lang.String unitName)

Get scale in the X direction

Returns:

the scale in horizontal pixels for the unit name.

getScaleY

double getScaleY(java.lang.String unitName)

Get scale in the Y direction

Returns:

the scale in vertical pixels for the unit name.

draw

void draw(java.awt.Image image,
          double xpos,
          double ypos,
          double width,
          double height)

Draw a Bitmap.

Parameters:

image - - the image to draw

xpos - - the x position

ypos - - the y position

width - - the width

height - - the height

draw

void draw(java.awt.Component component,
          double xpos,
          double ypos,
          double width,
          double height)

Draw a Component

Parameters:

component - - the component to draw

xpos - - the x position

ypos - - the y position

width - - the width

height - - the height

drawBox

void drawBox(double xpos,
             double ypos,
             double width,
             double height,
             boolean shade,
             boolean _3d,
             boolean raised)

Draw a Box, shaded or 3d.

Parameters:

xpos - - the x position

ypos - - the y position

width - - the width

height - - the height

shade - - shade the box

_3d - - draw in 3D

raised - - raised font

drawBox

void drawBox(double xpos,
             double ypos,
             double width,
             double height,
             boolean shade,
             int arcWidth,
             int arcHeight)

Draw a Rounded Box, optionally shaded.

Parameters:

xpos - - the x position

ypos - - the y position

width - - the width

height - - the height

shade - - shade the box

arcWidth - - amount of arc, width wise

arcHeight - - amount of arc, height wise

drawOval

void drawOval(double xpos,
              double ypos,
              double width,
              double height,
              boolean shade)

Draw an Oval

Parameters:

xpos - - the x position

ypos - - the y position

width - - the width

height - - the height

shade - - shade the box

drawArc

void drawArc(double xpos,
             double ypos,
             double width,
             double height,
             boolean shade,
             int startAngle,
             int endAngle)

Draw a partial Oval, optionally shaded.

Parameters:

xpos - - the x position

ypos - - the y position

width - - the width

height - - the height

shade - - shade the box

startAngle - - the angle to start at

endAngle - - the angle to end at

drawLine

void drawLine(double x1,
              double y1,
              double x2,
              double y2)

Draw a line; set the next from to the current to.

Parameters:

x1 - - start x position

y1 - - start y position

x2 - - end x position

y2 - - end y position

drawLineFrom

void drawLineFrom(double x1,
                  double y1)

Set the initial drawing location for the next drawLineTo; does not render anything.

Parameters:

x1 - - start x position

y1 - - start y position

drawLineTo

void drawLineTo(double x2,
                double y2)

Draw a line to the given coordinates, from the last drawn line.

Parameters:

x2 - - end x position

y2 - - end y position

setShadeColor

void setShadeColor(java.awt.Color shade)

Set shading color.

Parameters:

shade - - the shading color

getShadeColor

java.awt.Color getShadeColor()

Get shading color;

Returns:

the shading color

setPen

void setPen(int penStyle,
            double penWidth,
            java.awt.Color penColor)

Set the pen attributes.

Parameters:

penStyle - - from PEN_STYLE_SOLID (0), PEN_STYLE_DASH (1), PEN_STYLE_DOT (2), PEN_STYLE_DASH_DOT (3), PEN_STYLE_DASH_DOT_DOT (4), PEN_STYLE_NULL (5)

penWidth - - the width

penColor - - the color

getPositionX

double getPositionX()

Set the pen attributes.

Returns:

ending X position of previous print

getPositionY

double getPositionY()

Set the pen attributes.

Returns:

ending Y position of previous print

setPositionX

void setPositionX(double xpos)

Set the pen attributes.

Parameters:

xpos - - set position X of next print

setPositionY

void setPositionY(double ypos)

Set the pen attributes.

Parameters:

ypos - - set position Y of next print

eject

void eject()

Eject the current page.

open

boolean open(boolean enableDialog,
             boolean rawMode,
             java.lang.String filename)

Open the printer according to filename.

Parameters:

enableDialog - true if dialog should be enabled

rawMode - true if should open in rawMode, false if cooked

filename -

Returns:

true for success, false for failure (cancelled by user)

close

void close()

Close the printer access.

clearFont

void clearFont()

Clear the font to default.

getTextPositionX

double getTextPositionX(boolean bottom)

Parameters:

bottom - is false if top of text, true if bottom

Returns:

ending X position of previous print

getTextPositionY

double getTextPositionY(boolean bottom)

Parameters:

bottom - is false if top of text, true if bottom

Returns:

ending Y position of previous print

setFont

void setFont(java.awt.Font f,
             boolean underline,
             boolean strikeOut,
             boolean doubleStrike)

Set the current font.

Parameters:

f - current font.

underline - current font.

strikeOut - current font.

doubleStrike - strikeOut font.

isFontUnderline

boolean isFontUnderline()

isFontStrikeOut

boolean isFontStrikeOut()

getFont

java.awt.Font getFont()

Get the current font.

getFontMetrics

java.awt.FontMetrics getFontMetrics()

Get the current font metrics.

setLineExtend

void setLineExtend(double extend)

Set the amount of space between two overwritten lines.

Parameters:

extend - - extend the line (true) or don't (false)

setPitch

void setPitch(int pitchType)

Set the pitch of the font.

Parameters:

pitchType - - the amount of pitch

setTabStop

void setTabStop(double tabStops)

Set the tab stop increment.

Parameters:

tabStops - - the number of tabs

getTextColor

java.awt.Color getTextColor()

Get the text color.

setTextColor

void setTextColor(java.awt.Color textColor)

Set the text color.

Parameters:

textColor - - the text color

setTextPositionX

void setTextPositionX(double xpos,
                      boolean bottom)

Set the text position x.

Parameters:

xpos - is the text position

bottom - is true if bottom, false if top

setTextPositionY

void setTextPositionY(double ypos,
                      boolean bottom)

Set the text position y.

Parameters:

ypos - is the text position

bottom - is true if bottom, false if top

textOut

void textOut(java.lang.String text,
             double xpos,
             double ypos,
             boolean box,
             boolean shade)

Output text at position, with a box or shade.

Parameters:

text - - the text

xpos - - the position of the text

ypos - - the position of the text

box - - draw a box around the text

shade - - the shading of the text

write

boolean write(java.lang.String text)

Write plain text, with possible escapes if enabled; this MAY cause a page eject and movement to the next page.

Parameters:

text - - the text to write

Returns:

true if page ejected

getTextExtent

java.awt.Dimension getTextExtent(java.lang.String text)

Get renderable text extend in width and height as Dimension.

Parameters:

text - - the text to extend

Returns:

physical dimension of text

setLeftMargin

void setLeftMargin(double leftMargin)

Set the left margin.

Parameters:

leftMargin - - the left margin to set

getLeftMargin

double getLeftMargin()

Get the left margin.

Returns:

the left margin value

setTopMargin

void setTopMargin(double topMargin)

Set the top margin.

Parameters:

topMargin - - the top margin to set

getTopMargin

double getTopMargin()

Get the top margin.

Returns:

the top margin value

setBottomMargin

void setBottomMargin(double bottomMargin)

Set the bottom margin.

Parameters:

bottomMargin - - the bottom margin to set

getBottomMargin

double getBottomMargin()

Get the bottom margin.

Returns:

the bottom margin

setDeviceMode

void setDeviceMode(java.lang.String attrib,
                   java.lang.String value)

Set device modes. (ChangeDeviceMode)

Parameters:

attrib - - the attributes to set

value - - the value to set

getDeviceCapability

java.lang.String getDeviceCapability(java.lang.String attrib)

Get the value of a device attribute.

Returns:

value of attrib

setEscapeSequences

void setEscapeSequences(boolean state)

Enable or disable escape sequences.

Parameters:

state - - true if escape if sequences are to be enabled.

getPrinterInfo

java.lang.String getPrinterInfo(java.lang.String attrib)

Get printer info attribute.

Parameters:

attrib - - the attrib to get

Returns:

value of attribute.

setConnectorThickness

void setConnectorThickness(int thickness)

Set the connector thickness, in pixels away from the center.

Parameters:

thickness - - the thickness to set

setConnector

void setConnector(double xpos,
                  double ypos,
                  int type)

Set a connector of the given type on the page; the page is responsible for connecting connectors appropriately.

Parameters:

xpos - - the x position to set

ypos - - the y position to set

type - - the type of connector

setXORMode

void setXORMode(java.awt.Color c)

XORMode This painting mode for drawing to the printer has the attribute such that drawing the object twice will return the graphics to the original state.

Parameters:

c - - the color to XOR

setPaintMode

void setPaintMode()

PaintMode This is the normal painting mode for drawing to the printer.

command

java.lang.String command(java.lang.String command)

Command Send arbitrary text commands to the PERCobol printer driver; this may be interpreted in any manner by the PERCobol printer driver.

Parameters:

command - - the command to get

Returns:

the command value