Package | Description |
---|---|
org.eclipse.nebula.paperclips.core |
Core classes for creating printable documents.
|
org.eclipse.nebula.paperclips.core.border | |
org.eclipse.nebula.paperclips.core.grid | |
org.eclipse.nebula.paperclips.core.grid.internal | |
org.eclipse.nebula.paperclips.core.internal | |
org.eclipse.nebula.paperclips.core.page | |
org.eclipse.nebula.paperclips.core.text |
Modifier and Type | Class and Description |
---|---|
class |
AlignPrint
A wrapper print that aligns its target vertically and/or horizontally.
|
class |
BackgroundPrint
A decorator that paints a background color behind it's target.
|
class |
BigPrint
A wrapper for prints whose minimum size is too large to fit on one page.
|
class |
BreakPrint
A print which inserts a page break (or a column break, if inside a
ColumnPrint).
|
class |
ColumnPrint
A wrapper Print which splits its child print into multiple columns.
|
class |
DebugPrint
Deprecated.
Reminder to remove references to DebugPrint when you're done
debugging a print job.
|
class |
EmptyPrint
A Print which displays nothing but takes up space.
|
class |
ImagePrint
A Print for displaying images.
|
class |
LayerPrint
A Print which displays its child Prints on top each other.
|
class |
LinePrint
A Print for drawing horizontal and vertical lines.
|
class |
NoBreakPrint
A print wrapper which prevents its target from being broken into multiple
pieces when printed.
|
class |
RotatePrint
A decorator print that rotates it's target by increments of 90 degrees.
|
class |
ScalePrint
A decorator print that scales it's target larger or smaller.
|
class |
SeriesPrint
A Print which displays its child prints in series.
|
class |
SidewaysPrint
A decorator print that rotates it's target by increments of 90 degrees.
|
Modifier and Type | Field and Description |
---|---|
(package private) Print |
ScalePrint.target |
(package private) Print |
ColumnPrint.target |
(package private) Print |
BackgroundPrint.target |
(package private) Print |
AlignPrint.target |
Modifier and Type | Field and Description |
---|---|
(package private) java.util.List<Print> |
SeriesPrint.items |
Modifier and Type | Method and Description |
---|---|
Print |
PrintJob.getDocument()
Returns the document to be printed.
|
Print[] |
SeriesPrint.getItems()
Returns an array of items in the series.
|
Print |
SidewaysPrint.getTarget()
Returns the print to be rotated.
|
Print |
ScalePrint.getTarget()
Returns the print being scaled.
|
Print |
RotatePrint.getTarget()
Returns the print to be rotated.
|
Print |
NoBreakPrint.getTarget()
Returns the print which will not be broken across pages.
|
Print |
LayerEntry.getTarget()
Returns the target print of this entry.
|
Print |
ColumnPrint.getTarget()
Returns the target print being split into columns.
|
Print |
BigPrint.getTarget()
Returns the wrapped print which is being split across pages.
|
Print |
BackgroundPrint.getTarget()
Returns the wrapped print to which the background color is being applied.
|
Print |
AlignPrint.getTarget()
Returns the wrapped print being aligned
|
Modifier and Type | Method and Description |
---|---|
void |
SeriesPrint.add(Print item)
Adds the given print to this SeriesPrint.
|
void |
LayerPrint.add(Print print)
Adds the given Print to this LayerPrint using the default alignment.
|
void |
SeriesPrint.add(Print[] items)
Adds the given prints to this SeriesPrint.
|
void |
LayerPrint.add(Print print,
int align)
Adds the given Print to this LayerPrint using the specified alignment.
|
Constructor and Description |
---|
AlignPrint(Print target,
int hAlign,
int vAlign)
Constructs a new AlignPrint.
|
BackgroundPrint(Print target,
org.eclipse.swt.graphics.RGB background)
Constructs a BackgroundPrint with the given target and background color.
|
BigIterator(Print target,
org.eclipse.swt.graphics.Device device,
org.eclipse.swt.graphics.GC gc) |
BigPrint(Print target)
Constructs a BigPrint.
|
ColumnPrint(Print target,
int columns,
int spacing)
Constructs a ColumnPrint with the given target, number of columns, and
column spacing (expressed in points).
|
ColumnPrint(Print target,
int columns,
int spacing,
boolean compressed)
Constructs a ColumnPrint with the given target, column count, column
spacing, and compression.
|
DebugPrint(Print target)
Deprecated.
|
NoBreakPrint(Print target)
Constructs a NoBreakPrint with the given target.
|
PrintJob(java.lang.String name,
Print document)
Constructs a PrintJob for the given document.
|
RotateIterator(Print target,
int angle,
org.eclipse.swt.graphics.Device device,
org.eclipse.swt.graphics.GC gc) |
RotatePrint(Print target)
Constructs a RotatePrint that rotates it's target 90 degrees
counter-clockwise.
|
RotatePrint(Print target,
int angle)
Constructs a RotatePrint.
|
ScalePrint(Print target)
Constructs a ScalePrint which scales down it's target to print at it's
preferred size.
|
ScalePrint(Print target,
java.lang.Double scale)
Constructs a ScalePrint which scales it's target by the given factor.
|
SidewaysIterator(Print target,
int angle,
org.eclipse.swt.graphics.Device device,
org.eclipse.swt.graphics.GC gc) |
SidewaysPrint(Print target)
Constructs a SidewaysPrint that rotates it's target 90 degrees
counter-clockwise.
|
SidewaysPrint(Print target,
int angle)
Constructs a SidewaysPrint.
|
Modifier and Type | Class and Description |
---|---|
class |
BorderPrint
A decorator that draws a border around the target print.
|
Modifier and Type | Field and Description |
---|---|
(package private) Print |
BorderPrint.target |
Modifier and Type | Method and Description |
---|---|
Print |
BorderPrint.getTarget()
Returns the wrapped print to which the border is being applied.
|
Constructor and Description |
---|
BorderPrint(Print target,
Border border)
Constructs a BorderPrint with the given target and border.
|
Modifier and Type | Class and Description |
---|---|
class |
GridPrint
A Print which arranges child prints into a grid.
|
Modifier and Type | Method and Description |
---|---|
Print |
GridCell.getContent()
Returns the content print of the cell.
|
Modifier and Type | Method and Description |
---|---|
void |
GridPrint.add(int hAlignment,
int vAlignment,
Print cell)
Adds the Print to the grid body, using the given colspan and alignment.
|
void |
GridPrint.add(int hAlignment,
int vAlignment,
Print cell,
int colspan)
Adds the Print to the grid body, using the given colspan and alignment.
|
void |
GridPrint.add(int hAlignment,
Print cell)
Adds the Print to the grid body, using the given colspan and alignment.
|
void |
GridPrint.add(int hAlignment,
Print cell,
int colspan)
Adds the Print to the grid body, using the given colspan and alignment.
|
void |
GridPrint.add(Print cell)
Adds the Print to the grid body, with the default alignment and a colspan
of 1.
|
void |
GridPrint.add(Print cell,
int colspan)
Adds the Print to the grid body, with the given colspan and the default
alignment.
|
void |
GridPrint.addFooter(int hAlignment,
int vAlignment,
Print cell)
Adds the Print to the grid footer, using the given colspan and alignment.
|
void |
GridPrint.addFooter(int hAlignment,
int vAlignment,
Print cell,
int colspan)
Adds the Print to the grid footer, using the given colspan and alignment.
|
void |
GridPrint.addFooter(int hAlignment,
Print cell)
Adds the Print to the grid footer, using the given colspan and alignment.
|
void |
GridPrint.addFooter(int hAlignment,
Print cell,
int colspan)
Adds the Print to the grid footer, using the given colspan and alignment.
|
void |
GridPrint.addFooter(Print cell)
Adds the Print to the grid footer, with the default alignment and a
colspan of 1.
|
void |
GridPrint.addFooter(Print cell,
int colspan)
Adds the Print to the grid footer, with the given colspan and the default
alignment.
|
void |
GridPrint.addHeader(int hAlignment,
int vAlignment,
Print cell)
Adds the Print to the grid header, using the given alignment.
|
void |
GridPrint.addHeader(int hAlignment,
int vAlignment,
Print cell,
int colspan)
Adds the Print to the grid header, using the given colspan and alignment.
|
void |
GridPrint.addHeader(int hAlignment,
Print cell)
Adds the Print to the grid header, using the given alignment.
|
void |
GridPrint.addHeader(int hAlignment,
Print cell,
int colspan)
Adds the Print to the grid header, using the given colspan and alignment.
|
void |
GridPrint.addHeader(Print cell)
Adds the Print to the grid header, with default alignment and a colspan
of 1.
|
void |
GridPrint.addHeader(Print cell,
int colspan)
Adds the Print to the grid header, with the given colspan and the default
alignment.
|
Modifier and Type | Method and Description |
---|---|
Print |
GridCellImpl.getContent() |
Constructor and Description |
---|
GridCellImpl(int hAlignment,
int vAlignment,
Print target,
int colspan)
This constructor is only here for compatibility reasons and is not
intented to be used by clients.
|
Modifier and Type | Method and Description |
---|---|
Print |
LayerEntryImpl.getTarget() |
Constructor and Description |
---|
LayerEntryImpl(Print target,
int align)
Create a new layer entry.
|
Modifier and Type | Class and Description |
---|---|
class |
PageNumberPrint
Displays the page number and page count within the context of a
PagePrint . |
class |
PagePrint
A decorator Print which displays page headers and footers around a document
body, with page numbering capabilities.
|
Modifier and Type | Field and Description |
---|---|
(package private) Print |
PagePrint.body |
Modifier and Type | Method and Description |
---|---|
Print |
SimplePageDecoration.createPrint(PageNumber pageNumber) |
Print |
PageNumberPageDecoration.createPrint(PageNumber pageNumber) |
Print |
PageDecoration.createPrint(PageNumber pageNumber)
Returns a decorator Print for the page with the given page number, or
null if no decoration is provided for the given page.
|
Print |
PagePrint.getBody()
Returns the page body.
|
Modifier and Type | Method and Description |
---|---|
void |
PagePrint.setBody(Print body)
Sets the page body to the argument.
|
Constructor and Description |
---|
PagePrint(PageDecoration header,
int headerGap,
Print body)
Constructs a PagePrint with the given header and body.
|
PagePrint(PageDecoration header,
int headerGap,
Print body,
int footerGap,
PageDecoration footer)
Constructs a PagePrint with the given body, header and footer.
|
PagePrint(PageDecoration header,
Print body)
Constructs a PagePrint with the given header and body.
|
PagePrint(PageDecoration header,
Print body,
PageDecoration footer)
Constructs a PagePrint with the given body, header and footer.
|
PagePrint(Print body)
Constructs a PagePrint with the given body.
|
PagePrint(Print body,
int footerGap,
PageDecoration footer)
Constructs a PagePrint with the given body, header and footer.
|
PagePrint(Print body,
PageDecoration footer)
Constructs a PagePrint with the given body and footer.
|
SimplePageDecoration(Print print)
Constructs a BasicPageDecoration.
|
Modifier and Type | Class and Description |
---|---|
class |
LineBreakPrint
A class for adding line breaks corresponding to a particular font size.
|
class |
StyledTextPrint
A class for printing styled text.
|
class |
TextPrint
A Print for displaying text.
|
Modifier and Type | Method and Description |
---|---|
StyledTextPrint |
StyledTextPrint.append(Print element)
Appends the given element to the document.
|
Constructor and Description |
---|
StyledTextIterator(Print[] elements,
org.eclipse.swt.graphics.Device device,
org.eclipse.swt.graphics.GC gc) |