com.fr.code.bar.output

类 AbstractOutput

java.lang.Object

com.fr.code.bar.output.AbstractOutput

直接已知子类:

GraphicsOutput, SizingOutput

public abstract class AbstractOutput
extends java.lang.Object

Abstract class of which concrete implementations provide means for outputting barcodes to different output formats.

作者:

Ian Bourke

字段概要

字段

限定符和类型	字段和说明
protected java.awt.Color	backgroundColour The background colour for drawing
protected double	barHeight The bar height.
protected java.awt.Font	font The font to draw any text labels with.
protected java.awt.Color	foregroundColour The foreground colour for drawing
protected boolean	painting Flag indicating whether the barcode will actually be outputted, or is just being sized.
protected double	scalar The scaling factor to correctly size the barcode in the output units.

构造器概要

构造器

限定符	构造器和说明
protected	AbstractOutput(java.awt.Font font, double barWidth, double barHeight, boolean painting, double scalar, java.awt.Color foregroundColour, java.awt.Color backgroundColour) Populates this abstract outputter with common values.

方法概要

方法

限定符和类型	方法和说明
abstract void	beginDraw(double width, double height) Sets up the drawing environment.
abstract void	drawBar(int x, int y, int width, int height, boolean paintWithForegroundColor) "Draws" a bar at the given coordinates.
abstract double	drawText(java.lang.String text, double x, double y, double width) Draw the specified text.
abstract void	drawText(java.lang.String leadChar, LabelLayout createMarginLayout)
abstract void	endDraw() Balanced with startDraw() above, used for caching, output of epilogues (for SVG), etc.
java.awt.Color	getBackgroundColour() Returns the current background colour for any artifacts drawn to the graphics.
double	getBarHeight() Get the Height of the barcode
double	getBarWidth() returns the unit bar width
java.awt.Color	getForegroundColour() Returns the current foreground colour for any artifacts drawn to the graphics.
void	setupForBlankDrawing() Used by BlankModule() to prevent drawing of the white header space.
void	teardownFromBlankDrawing() see setupForBlankDrawing()

从类继承的方法 java.lang.Object

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

字段详细资料

barHeight

protected final double barHeight

The bar height.

painting

protected final boolean painting

Flag indicating whether the barcode will actually be outputted, or is just being sized.

scalar

protected final double scalar

The scaling factor to correctly size the barcode in the output units.

font

protected java.awt.Font font

The font to draw any text labels with.

backgroundColour

protected final java.awt.Color backgroundColour

The background colour for drawing

foregroundColour

protected java.awt.Color foregroundColour

The foreground colour for drawing

构造器详细资料

AbstractOutput

protected AbstractOutput(java.awt.Font font,
              double barWidth,
              double barHeight,
              boolean painting,
              double scalar,
              java.awt.Color foregroundColour,
              java.awt.Color backgroundColour)

Populates this abstract outputter with common values.

参数:

font - The font to draw text labels with

barWidth - The width of the smallest bar (in bar units)

barHeight - The height of the bars

painting - Flag indicating whether painting will actually occur

scalar - The scaling factor to size the barcode into the correct units

foregroundColour - The colour to paint in

backgroundColour - The background colour

方法详细资料

setupForBlankDrawing

public void setupForBlankDrawing()

Used by BlankModule() to prevent drawing of the white header space. Must be matched with a call to tearDownFromBlankDrawing()

teardownFromBlankDrawing

public void teardownFromBlankDrawing()

see setupForBlankDrawing()

getBarWidth

public double getBarWidth()

returns the unit bar width

返回:

the width of the smallest bar

getBarHeight

public double getBarHeight()

Get the Height of the barcode

返回:

the height

drawBar

public abstract void drawBar(int x,
           int y,
           int width,
           int height,
           boolean paintWithForegroundColor)

"Draws" a bar at the given coordinates.

参数:

x - the x coordinate

y - the y coordinate

width - the width

height - the height

paintWithForegroundColor - if true, use the foreground color, otherwise use the background color

beginDraw

public abstract void beginDraw(double width,
             double height)

Sets up the drawing environment. Called before drawBar(). Matched with call to endDraw() at the end. This allows for caching as needed.

参数:

width - The output width (in pixels) of the barcode

height - The output height (in pixels) of the barcode.

endDraw

public abstract void endDraw()

Balanced with startDraw() above, used for caching, output of epilogues (for SVG), etc.

drawText

public abstract double drawText(java.lang.String text,
              double x,
              double y,
              double width)

Draw the specified text.

参数:

text - text to draw

x - x position

y - y position

width - width of barcode (total)

返回:

the height of this text

getForegroundColour

public java.awt.Color getForegroundColour()

Returns the current foreground colour for any artifacts drawn to the graphics.

返回:

The current foreground colour

getBackgroundColour

public java.awt.Color getBackgroundColour()

Returns the current background colour for any artifacts drawn to the graphics.

返回:

The current background colour

drawText

public abstract void drawText(java.lang.String leadChar,
            LabelLayout createMarginLayout)