org.eclipse.swt.custom

Class StyledText.Printing

java.lang.Object

org.eclipse.swt.custom.StyledText.Printing

All Implemented Interfaces:

java.lang.Runnable

Enclosing class:

StyledText

static class StyledText.Printing
extends java.lang.Object
implements java.lang.Runnable

The Printing class implements printing of a range of text. An instance of Printing is returned in the StyledText#print(Printer) API. The run() method may be invoked from any thread.

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	CENTER
(package private) Rectangle	clientArea
(package private) int	endLine
(package private) int	endPage
(package private) FontData	fontData
(package private) GC	gc
(package private) static int	LEFT
(package private) int	lineSpacing
(package private) boolean	mirrored
(package private) int	pageWidth
(package private) Printer	printer
(package private) Font	printerFont
(package private) StyledTextRenderer	printerRenderer
(package private) int	printMargin
(package private) StyledTextPrintOptions	printOptions
(package private) java.util.Hashtable	resources
(package private) static int	RIGHT
(package private) int	scope
(package private) Point	selection
(package private) boolean	singleLine
(package private) int	startLine
(package private) int	startPage
(package private) int	tabLength

Constructor Summary

Constructors

Constructor and Description
StyledText.Printing(StyledText styledText, Printer printer, StyledTextPrintOptions printOptions) Creates an instance of Printing.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	cacheLineData(StyledText styledText) Caches all line data that needs to be requested from a listener.
(package private) StyledTextContent	copyContent(StyledTextContent original) Copies the text of the specified StyledTextContent.
(package private) void	dispose() Disposes of the resources and the PrintRenderer.
(package private) void	init()
(package private) void	print() Prints the lines in the specified page range.
(package private) void	printDecoration(int page, boolean header, TextLayout layout) Print header or footer decorations.
(package private) void	printDecorationSegment(java.lang.String segment, int alignment, int page, boolean header, TextLayout layout) Print one segment of a header or footer decoration.
(package private) void	printLine(int x, int y, GC gc, Color foreground, Color background, TextLayout layout, TextLayout printLayout, int index)
void	run() Starts a print job and prints the pages specified in the constructor.

Methods inherited from class java.lang.Object

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

Field Detail

LEFT

static final int LEFT

See Also:

Constant Field Values

CENTER

static final int CENTER

See Also:

Constant Field Values

RIGHT

static final int RIGHT

See Also:

Constant Field Values

printer

Printer printer

printerRenderer

StyledTextRenderer printerRenderer

printOptions

StyledTextPrintOptions printOptions

clientArea

Rectangle clientArea

fontData

FontData fontData

printerFont

Font printerFont

resources

java.util.Hashtable resources

tabLength

int tabLength

gc

GC gc

pageWidth

int pageWidth

startPage

int startPage

endPage

int endPage

scope

int scope

startLine

int startLine

endLine

int endLine

singleLine

boolean singleLine

selection

Point selection

mirrored

boolean mirrored

lineSpacing

int lineSpacing

printMargin

int printMargin

Constructor Detail

StyledText.Printing

StyledText.Printing(StyledText styledText,
                   Printer printer,
                   StyledTextPrintOptions printOptions)

Creates an instance of Printing. Copies the widget content and rendering data that needs to be requested from listeners.

Parameters:

parent - StyledText widget to print.

printer - printer device to print on.

printOptions - print options

Method Detail

cacheLineData

void cacheLineData(StyledText styledText)

Caches all line data that needs to be requested from a listener.

Parameters:

printerContent - StyledTextContent to request line data for.

copyContent

StyledTextContent copyContent(StyledTextContent original)

Copies the text of the specified StyledTextContent.

Parameters:

original - the StyledTextContent to copy.

dispose

void dispose()

Disposes of the resources and the PrintRenderer.

init

void init()

print

void print()

Prints the lines in the specified page range.

printDecoration

void printDecoration(int page,
                   boolean header,
                   TextLayout layout)

Print header or footer decorations.

Parameters:

page - page number to print, if specified in the StyledTextPrintOptions header or footer.

header - true = print the header, false = print the footer

printDecorationSegment

void printDecorationSegment(java.lang.String segment,
                          int alignment,
                          int page,
                          boolean header,
                          TextLayout layout)

Print one segment of a header or footer decoration. Headers and footers have three different segments. One each for left aligned, centered, and right aligned text.

Parameters:

segment - decoration segment to print

alignment - alignment of the segment. 0=left, 1=center, 2=right

page - page number to print, if specified in the decoration segment.

header - true = print the header, false = print the footer

printLine

void printLine(int x,
             int y,
             GC gc,
             Color foreground,
             Color background,
             TextLayout layout,
             TextLayout printLayout,
             int index)

run

public void run()

Starts a print job and prints the pages specified in the constructor.

Specified by:

run in interface java.lang.Runnable