public interface PrintBuilder extends Builder
PrintBuilder
. This class is for use on Windows only and
contains all information relating to printing. It is created using PlotManager
.
All sheets provided must be in the displayed part.
The user must specify the sheets to be printed by setting the appropriate fields
through the PlotSourceBuilder
. The printer text and copies fields must be
set in order to successfully print the provided sheets. The printer text is the path of the
desired printer and the copies field represents the number of copies to be printed. This class
also allows for the line widths to be scaled by setting the appropriate thin, normal, or thick
scale factors.
PlotManager.createPrintBuilder()
Property | Value |
---|---|
Orientation | Landscape |
Width1ScaleFactor | 1.0 |
Width2ScaleFactor | 2.0 |
Width3ScaleFactor | 3.0 |
Width4ScaleFactor | 4.0 |
Width5ScaleFactor | 5.0 |
Width6ScaleFactor | 6.0 |
Width7ScaleFactor | 7.0 |
Width8ScaleFactor | 8.0 |
Width9ScaleFactor | 9.0 |
Modifier and Type | Interface and Description |
---|---|
static class |
PrintBuilder.ImageResolutionOption
Specifies the print image resolution
|
static class |
PrintBuilder.OrientationOption
Specifies the orientation of the printed sheet
|
static class |
PrintBuilder.OutputOption
Specifies the output option when printing Current Display
|
static class |
PrintBuilder.PaperSize
Specifies the paper size of the printed sheet
|
Modifier and Type | Method and Description |
---|---|
int |
copies()
Returns the number of copies.
|
int |
customPaper()
Returns the custom paper.
|
boolean |
customSymbolsInForeground()
Returns the plotting custom symbols in the foreground option.
|
PrintBuilder.ImageResolutionOption |
imageResolution()
Returns the resolution of images created for printing shaded views.
|
double |
normalWidth()
Returns the normal width scale factor.
|
PrintBuilder.OrientationOption |
orientation()
Returns the orientation.
|
PrintBuilder.OutputOption |
output()
Returns the shaded image option.
|
PrintBuilder.PaperSize |
paper()
Returns the paper.
|
String |
printerText()
Returns the printer text.
|
boolean |
rasterImages()
Returns the raster images option.
|
void |
setCopies(int copies)
License requirements: None. |
void |
setCustomPaper(int customPaper)
License requirements: None. |
void |
setCustomSymbolsInForeground(boolean customSymbolsInForeground)
License requirements: None. |
void |
setImageResolution(PrintBuilder.ImageResolutionOption imageResolution)
License requirements: None. |
void |
setNormalWidth(double normalWidth)
License requirements: None. |
void |
setOrientation(PrintBuilder.OrientationOption orientationOption)
License requirements: None. |
void |
setOutput(PrintBuilder.OutputOption outputOption)
License requirements: None. |
void |
setPaper(PrintBuilder.PaperSize paper)
License requirements: None. |
void |
setPrinterText(String printer)
License requirements: None. |
void |
setRasterImages(boolean rasterImages)
License requirements: None. |
void |
setShadedGeometry(boolean shadedGeometry)
License requirements: None. |
void |
setThickWidth(double thickWidth)
License requirements: None. |
void |
setThinWidth(double thinWidth)
License requirements: None. |
void |
setWhiteBackground(boolean whiteBackground)
License requirements: None. |
void |
setWidth1ScaleFactor(double width1ScaleFactor)
License requirements: None. |
void |
setWidth2ScaleFactor(double width2ScaleFactor)
License requirements: None. |
void |
setWidth3ScaleFactor(double width3ScaleFactor)
License requirements: None. |
void |
setWidth4ScaleFactor(double width4ScaleFactor)
License requirements: None. |
void |
setWidth5ScaleFactor(double width5ScaleFactor)
License requirements: None. |
void |
setWidth6ScaleFactor(double width6ScaleFactor)
License requirements: None. |
void |
setWidth7ScaleFactor(double width7ScaleFactor)
License requirements: None. |
void |
setWidth8ScaleFactor(double width8ScaleFactor)
License requirements: None. |
void |
setWidth9ScaleFactor(double width9ScaleFactor)
License requirements: None. |
boolean |
shadedGeometry()
Returns the shaded geometry as wireframe option.
|
PlotSourceBuilder |
sourceBuilder()
Returns the Source builder.
|
double |
thickWidth()
Returns the thick width scale factor.
|
double |
thinWidth()
Returns the thin width scale factor.
|
boolean |
whiteBackground()
Returns the white background option.
|
double |
width1ScaleFactor()
Returns the width1 scale factor.
|
double |
width2ScaleFactor()
Returns the width2 scale factor.
|
double |
width3ScaleFactor()
Returns the width3 scale factor.
|
double |
width4ScaleFactor()
Returns the width4 scale factor.
|
double |
width5ScaleFactor()
Returns the width5 scale factor.
|
double |
width6ScaleFactor()
Returns the width6 scale factor.
|
double |
width7ScaleFactor()
Returns the width7 scale factor.
|
double |
width8ScaleFactor()
Returns the width8 scale factor.
|
double |
width9ScaleFactor()
Returns the width9 scale factor.
|
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
int copies() throws NXException, RemoteException
NXException
RemoteException
void setCopies(int copies) throws NXException, RemoteException
copies
- NXException
RemoteException
double thinWidth() throws NXException, RemoteException
NXException
RemoteException
void setThinWidth(double thinWidth) throws NXException, RemoteException
thinWidth
- NXException
RemoteException
double normalWidth() throws NXException, RemoteException
NXException
RemoteException
void setNormalWidth(double normalWidth) throws NXException, RemoteException
normalWidth
- NXException
RemoteException
double thickWidth() throws NXException, RemoteException
NXException
RemoteException
void setThickWidth(double thickWidth) throws NXException, RemoteException
thickWidth
- NXException
RemoteException
double width1ScaleFactor() throws NXException, RemoteException
NXException
RemoteException
void setWidth1ScaleFactor(double width1ScaleFactor) throws NXException, RemoteException
width1ScaleFactor
- NXException
RemoteException
double width2ScaleFactor() throws NXException, RemoteException
NXException
RemoteException
void setWidth2ScaleFactor(double width2ScaleFactor) throws NXException, RemoteException
width2ScaleFactor
- NXException
RemoteException
double width3ScaleFactor() throws NXException, RemoteException
NXException
RemoteException
void setWidth3ScaleFactor(double width3ScaleFactor) throws NXException, RemoteException
width3ScaleFactor
- NXException
RemoteException
double width4ScaleFactor() throws NXException, RemoteException
NXException
RemoteException
void setWidth4ScaleFactor(double width4ScaleFactor) throws NXException, RemoteException
width4ScaleFactor
- NXException
RemoteException
double width5ScaleFactor() throws NXException, RemoteException
NXException
RemoteException
void setWidth5ScaleFactor(double width5ScaleFactor) throws NXException, RemoteException
width5ScaleFactor
- NXException
RemoteException
double width6ScaleFactor() throws NXException, RemoteException
NXException
RemoteException
void setWidth6ScaleFactor(double width6ScaleFactor) throws NXException, RemoteException
width6ScaleFactor
- NXException
RemoteException
double width7ScaleFactor() throws NXException, RemoteException
NXException
RemoteException
void setWidth7ScaleFactor(double width7ScaleFactor) throws NXException, RemoteException
width7ScaleFactor
- NXException
RemoteException
double width8ScaleFactor() throws NXException, RemoteException
NXException
RemoteException
void setWidth8ScaleFactor(double width8ScaleFactor) throws NXException, RemoteException
width8ScaleFactor
- NXException
RemoteException
double width9ScaleFactor() throws NXException, RemoteException
NXException
RemoteException
void setWidth9ScaleFactor(double width9ScaleFactor) throws NXException, RemoteException
width9ScaleFactor
- NXException
RemoteException
PrintBuilder.OutputOption output() throws NXException, RemoteException
NXException
RemoteException
void setOutput(PrintBuilder.OutputOption outputOption) throws NXException, RemoteException
outputOption
- NXException
RemoteException
boolean whiteBackground() throws NXException, RemoteException
NXException
RemoteException
void setWhiteBackground(boolean whiteBackground) throws NXException, RemoteException
whiteBackground
- NXException
RemoteException
PlotSourceBuilder sourceBuilder() throws NXException, RemoteException
NXException
RemoteException
String printerText() throws NXException, RemoteException
NXException
RemoteException
void setPrinterText(String printer) throws NXException, RemoteException
printer
- NXException
RemoteException
boolean rasterImages() throws NXException, RemoteException
NXException
RemoteException
void setRasterImages(boolean rasterImages) throws NXException, RemoteException
rasterImages
- NXException
RemoteException
boolean shadedGeometry() throws NXException, RemoteException
NXException
RemoteException
void setShadedGeometry(boolean shadedGeometry) throws NXException, RemoteException
shadedGeometry
- NXException
RemoteException
boolean customSymbolsInForeground() throws NXException, RemoteException
NXException
RemoteException
void setCustomSymbolsInForeground(boolean customSymbolsInForeground) throws NXException, RemoteException
customSymbolsInForeground
- NXException
RemoteException
PrintBuilder.ImageResolutionOption imageResolution() throws NXException, RemoteException
NXException
RemoteException
void setImageResolution(PrintBuilder.ImageResolutionOption imageResolution) throws NXException, RemoteException
imageResolution
- NXException
RemoteException
PrintBuilder.OrientationOption orientation() throws NXException, RemoteException
NXException
RemoteException
void setOrientation(PrintBuilder.OrientationOption orientationOption) throws NXException, RemoteException
orientationOption
- NXException
RemoteException
PrintBuilder.PaperSize paper() throws NXException, RemoteException
NXException
RemoteException
void setPaper(PrintBuilder.PaperSize paper) throws NXException, RemoteException
paper
- NXException
RemoteException
int customPaper() throws NXException, RemoteException
NXException
RemoteException
void setCustomPaper(int customPaper) throws NXException, RemoteException
customPaper
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.