public interface PrintPDFBuilder extends Builder
PrintPDFBuilder
to be used when exporting the Current Display
or selected sheets to a PDF document. This class is for use on Windows only and is created
using PlotManager
.
PlotManager.createPrintPdfbuilder()
Property | Value |
---|---|
Relation | Undefined |
Modifier and Type | Interface and Description |
---|---|
static class |
PrintPDFBuilder.ActionOption
Specifies the action option to be used when running Teamcenter
|
static class |
PrintPDFBuilder.Color
Specifies the color option to use when creating the PDF document
|
static class |
PrintPDFBuilder.ImageResolutionOption
Specifies the image resolution when exporting a raster image
|
static class |
PrintPDFBuilder.OutputTextOption
Specifies the output text option, as either text or polylines
|
static class |
PrintPDFBuilder.RelationOption
Specifies the relation to use when exporting a PDF to Teamcenter
|
static class |
PrintPDFBuilder.SizeOption
Specifies the size option of the PDF document.
|
static class |
PrintPDFBuilder.UnitsOption
Specifies which units are associated to the dimensions
|
static class |
PrintPDFBuilder.Width
Specifies the primary selection of which type of width assignment to use.
|
Modifier and Type | Method and Description |
---|---|
PrintPDFBuilder.ActionOption |
action()
Returns the action option to be used when saving the PDF file in a Teamcenter environment.
|
boolean |
addWatermark()
Returns the Add Watermark option.
|
boolean |
append()
Returns the Append option.
|
void |
assign()
The Assign button will assign an appropriate name to the Dataset field if
Create New is chosen as the Action.
|
PrintPDFBuilder.Color |
colors()
Returns the color option to be used when creating the PDF document.
|
CDF |
createCdf()
Creates and returns a
CDF object representing the Color Palette. |
WidthDefinition |
createWidthDefinition()
Creates and returns a
WidthDefinition object representing
the Width Palette. |
String |
datasetName()
Returns the dataset name to be used when Creating a New PDF document in a Teamcenter
environment.
|
String |
datasetType()
Returns the dataset type to be used when exporting a PDF to Teamcenter
License requirements: None. |
void |
definePalette()
Initialize the Color Palette.
|
void |
defineWidths()
Initialize the Width dialog.
|
String |
filename()
Returns the filename to be used upon creation of the PDF document.
|
CDF |
getCdf()
Returns a
CDF object representing the Color Palette. |
WidthDefinition |
getWidthDefinition()
Returns a
WidthDefinition object representing the Width Palette. |
PrintPDFBuilder.ImageResolutionOption |
imageResolution()
Returns the resolution of images created for export of shaded views.
|
String |
namedReferenceType()
Returns the named reference type to be used when exporting a PDF to Teamcenter
License requirements: None. |
PrintPDFBuilder.OutputTextOption |
outputText()
Returns the output text of the PDF.
|
boolean |
rasterImages()
Returns the Raster Images option.
|
PrintPDFBuilder.RelationOption |
relation()
Returns the relation to be used when exporting a PDF to Teamcenter
License requirements: None. |
double |
scale()
Returns the scale factor to be used when creating a PDF document.
|
void |
setAction(PrintPDFBuilder.ActionOption action)
License requirements: None. |
void |
setAddWatermark(boolean addWatermark)
License requirements: None. |
void |
setAppend(boolean append)
License requirements: None. |
void |
setColors(PrintPDFBuilder.Color colors)
License requirements: None. |
void |
setDatasetName(String datasetName)
License requirements: None. |
void |
setDatasetType(String datasetType)
License requirements: None. |
void |
setFilename(String filename)
License requirements: None. |
void |
setImageResolution(PrintPDFBuilder.ImageResolutionOption imageResolution)
License requirements: None. |
void |
setNamedReferenceType(String namedReferenceType)
License requirements: None. |
void |
setOutputText(PrintPDFBuilder.OutputTextOption outputText)
License requirements: None. |
void |
setRasterImages(boolean rasterImages)
License requirements: None. |
void |
setRelation(PrintPDFBuilder.RelationOption relation)
License requirements: None. |
void |
setScale(double scale)
License requirements: None. |
void |
setShadedGeometry(boolean shadedGeometry)
License requirements: None. |
void |
setSize(PrintPDFBuilder.SizeOption size)
License requirements: None. |
void |
setUnits(PrintPDFBuilder.UnitsOption units)
License requirements: None. |
void |
setWatermark(String watermark)
License requirements: None. |
void |
setWidths(PrintPDFBuilder.Width widths)
License requirements: None. |
void |
setXDimension(double xDimension)
License requirements: None. |
void |
setYDimension(double yDimension)
License requirements: None. |
boolean |
shadedGeometry()
Returns the Shaded Geometry as Wireframe option.
|
PrintPDFBuilder.SizeOption |
size()
Returns the size of the PDF document.
|
PlotSourceBuilder |
sourceBuilder()
Returns the Source builder.
|
PrintPDFBuilder.UnitsOption |
units()
Returns the units of the X and Y dimensions to be used when Dimension has been selected
from the Size option.
|
String |
watermark()
Returns the watermark text.
|
PrintPDFBuilder.Width |
widths()
Returns the width option.
|
double |
xdimension()
Returns the x dimension to be used when Dimension has been selected from the Size option.
|
double |
ydimension()
Returns the y dimension to be used when Dimension has been selected from the Size option.
|
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
PrintPDFBuilder.ActionOption action() throws NXException, RemoteException
NXException
RemoteException
void setAction(PrintPDFBuilder.ActionOption action) throws NXException, RemoteException
action
- NXException
RemoteException
String datasetName() throws NXException, RemoteException
NXException
RemoteException
void setDatasetName(String datasetName) throws NXException, RemoteException
datasetName
- NXException
RemoteException
void assign() throws NXException, RemoteException
NXException
RemoteException
PrintPDFBuilder.Color colors() throws NXException, RemoteException
NXException
RemoteException
void setColors(PrintPDFBuilder.Color colors) throws NXException, RemoteException
colors
- NXException
RemoteException
void definePalette() throws NXException, RemoteException
NXException
RemoteException
PrintPDFBuilder.Width widths() throws NXException, RemoteException
NXException
RemoteException
void setWidths(PrintPDFBuilder.Width widths) throws NXException, RemoteException
widths
- NXException
RemoteException
void defineWidths() throws NXException, RemoteException
NXException
RemoteException
PrintPDFBuilder.SizeOption size() throws NXException, RemoteException
NXException
RemoteException
void setSize(PrintPDFBuilder.SizeOption size) throws NXException, RemoteException
size
- NXException
RemoteException
double scale() throws NXException, RemoteException
NXException
RemoteException
void setScale(double scale) throws NXException, RemoteException
scale
- NXException
RemoteException
PrintPDFBuilder.UnitsOption units() throws NXException, RemoteException
NXException
RemoteException
void setUnits(PrintPDFBuilder.UnitsOption units) throws NXException, RemoteException
units
- NXException
RemoteException
double xdimension() throws NXException, RemoteException
NXException
RemoteException
void setXDimension(double xDimension) throws NXException, RemoteException
xDimension
- NXException
RemoteException
double ydimension() throws NXException, RemoteException
NXException
RemoteException
void setYDimension(double yDimension) throws NXException, RemoteException
yDimension
- NXException
RemoteException
boolean append() throws NXException, RemoteException
NXException
RemoteException
void setAppend(boolean append) throws NXException, RemoteException
append
- NXException
RemoteException
boolean addWatermark() throws NXException, RemoteException
NXException
RemoteException
void setAddWatermark(boolean addWatermark) throws NXException, RemoteException
addWatermark
- NXException
RemoteException
String watermark() throws NXException, RemoteException
NXException
RemoteException
void setWatermark(String watermark) throws NXException, RemoteException
watermark
- NXException
RemoteException
String filename() throws NXException, RemoteException
NXException
RemoteException
void setFilename(String filename) throws NXException, RemoteException
filename
- NXException
RemoteException
CDF createCdf() throws NXException, RemoteException
CDF
object representing the Color Palette.
This object contains all custom color information to be used when Custom Palette or
Colors By Width is selected from the Color option.
NXException
RemoteException
CDF getCdf() throws NXException, RemoteException
CDF
object representing the Color Palette.
This object contains all custom color information to be used when Custom Palette or
Colors By Width is selected from the Color option.
NXException
RemoteException
WidthDefinition createWidthDefinition() throws NXException, RemoteException
WidthDefinition
object representing
the Width Palette. This object contains all custom width information to be used
when Single Width, Custom Three Widths, or Custom Palette is selected from the
Width option.
NXException
RemoteException
WidthDefinition getWidthDefinition() throws NXException, RemoteException
WidthDefinition
object representing the Width Palette.
This object contains all custom width information to be used when Single Width, Custom
Three Widths, or Custom Palette is selected from the Width option.
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
PrintPDFBuilder.ImageResolutionOption imageResolution() throws NXException, RemoteException
NXException
RemoteException
void setImageResolution(PrintPDFBuilder.ImageResolutionOption imageResolution) throws NXException, RemoteException
imageResolution
- NXException
RemoteException
PlotSourceBuilder sourceBuilder() throws NXException, RemoteException
NXException
RemoteException
PrintPDFBuilder.OutputTextOption outputText() throws NXException, RemoteException
NXException
RemoteException
void setOutputText(PrintPDFBuilder.OutputTextOption outputText) throws NXException, RemoteException
outputText
- NXException
RemoteException
PrintPDFBuilder.RelationOption relation() throws NXException, RemoteException
NXException
RemoteException
void setRelation(PrintPDFBuilder.RelationOption relation) throws NXException, RemoteException
relation
- NXException
RemoteException
String datasetType() throws NXException, RemoteException
NXException
RemoteException
void setDatasetType(String datasetType) throws NXException, RemoteException
datasetType
- NXException
RemoteException
String namedReferenceType() throws NXException, RemoteException
NXException
RemoteException
void setNamedReferenceType(String namedReferenceType) throws NXException, RemoteException
namedReferenceType
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.