nxopen

Interface PrintPDFBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface PrintPDFBuilder
extends Builder

Represents a 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 . All sheets provided must be in the displayed part.
To create a new instance of this class, use PlotManager.createPrintPdfbuilder()
Default values.

Property	Value
Relation	Undefined

Created in NX5.0.0

Nested Class Summary

Nested Classes

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.

Method Summary

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.
boolean	customSymbolsInForeground() Returns the plotting custom symbols in the foreground option.
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	setCustomSymbolsInForeground(boolean customSymbolsInForeground) 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.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

action

PrintPDFBuilder.ActionOption action()
                             throws NXException,
                                    RemoteException

Returns the action option to be used when saving the PDF file in a Teamcenter environment. This can be set to Create New, Overwrite Existing PDF, or Append to Existing PDF.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setAction

void setAction(PrintPDFBuilder.ActionOption action)
        throws NXException,
               RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

action -

Throws:

NXException

RemoteException

datasetName

String datasetName()
            throws NXException,
                   RemoteException

Returns the dataset name to be used when Creating a New PDF document in a Teamcenter environment. The dataset name will be used if Create New, Overwrite Existing PDF, or Append to Existing PDF are selected as the Action.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setDatasetName

void setDatasetName(String datasetName)
             throws NXException,
                    RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

datasetName -

Throws:

NXException

RemoteException

assign

void assign()
     throws NXException,
            RemoteException

The Assign button will assign an appropriate name to the Dataset field if Create New is chosen as the Action.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

colors

PrintPDFBuilder.Color colors()
                      throws NXException,
                             RemoteException

Returns the color option to be used when creating the PDF document. If the color option is set to Custom Palette or Colors By Width then the PDF document will be created with the user defined color attributes belonging to the CDF object.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setColors

void setColors(PrintPDFBuilder.Color colors)
        throws NXException,
               RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

colors -

Throws:

NXException

RemoteException

definePalette

void definePalette()
            throws NXException,
                   RemoteException

Initialize the Color Palette. This allows the user to change the attributes of any color. These changed colors will be used if Custom Palette or Colors By Width is selected as the color option.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

widths

PrintPDFBuilder.Width widths()
                      throws NXException,
                             RemoteException

Returns the width option. If the width option is set to Single Width, Custom Three Widths, or Custom Palette then the PDF document will be created with the user defined width attributes belonging to the WidthDefinition object.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setWidths

void setWidths(PrintPDFBuilder.Width widths)
        throws NXException,
               RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

widths -

Throws:

NXException

RemoteException

defineWidths

void defineWidths()
           throws NXException,
                  RemoteException

Initialize the Width dialog. This allows the user to change the attributes of Single Width, Custom Three Widths, or Custom Palette. These changed width values will be used depending on the width option selected.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

size

PrintPDFBuilder.SizeOption size()
                         throws NXException,
                                RemoteException

Returns the size of the PDF document. If the size is set to Scale, then the PDF will use the user-defined Scale Factor. If the size is set to dimension, then the PDF will use the user-defined X and Y dimensions.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setSize

void setSize(PrintPDFBuilder.SizeOption size)
      throws NXException,
             RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

size -

Throws:

NXException

RemoteException

scale

double scale()
      throws NXException,
             RemoteException

Returns the scale factor to be used when creating a PDF document. This value ranges from 0.00 to 1.00 and will only be used if the Size option is set to Scale.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setScale

void setScale(double scale)
       throws NXException,
              RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

scale -

Throws:

NXException

RemoteException

units

PrintPDFBuilder.UnitsOption units()
                           throws NXException,
                                  RemoteException

Returns the units of the X and Y dimensions to be used when Dimension has been selected from the Size option.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setUnits

void setUnits(PrintPDFBuilder.UnitsOption units)
       throws NXException,
              RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

units -

Throws:

NXException

RemoteException

xdimension

double xdimension()
           throws NXException,
                  RemoteException

Returns the x dimension to be used when Dimension has been selected from the Size option.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setXDimension

void setXDimension(double xDimension)
            throws NXException,
                   RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

xDimension -

Throws:

NXException

RemoteException

ydimension

double ydimension()
           throws NXException,
                  RemoteException

Returns the y dimension to be used when Dimension has been selected from the Size option.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setYDimension

void setYDimension(double yDimension)
            throws NXException,
                   RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

yDimension -

Throws:

NXException

RemoteException

append

boolean append()
        throws NXException,
               RemoteException

Returns the Append option. If Append is set to false, a new PDF document will be created and will overwrite an existing PDF document. If Append is set to true, the selected sheets will be appended to the existing PDF document.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setAppend

void setAppend(boolean append)
        throws NXException,
               RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

append -

Throws:

NXException

RemoteException

addWatermark

boolean addWatermark()
              throws NXException,
                     RemoteException

Returns the Add Watermark option. If Add Watermark is set to false, no Watermark will be added to the PDF document. If Add Watermark is set to true, the user defined watermark text will be added as a watermark to the PDF document.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setAddWatermark

void setAddWatermark(boolean addWatermark)
              throws NXException,
                     RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

addWatermark -

Throws:

NXException

RemoteException

watermark

String watermark()
          throws NXException,
                 RemoteException

Returns the watermark text. This user-defined text will appear as a watermark to the PDF document only if Add Watermark is set to true.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setWatermark

void setWatermark(String watermark)
           throws NXException,
                  RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

watermark -

Throws:

NXException

RemoteException

filename

String filename()
         throws NXException,
                RemoteException

Returns the filename to be used upon creation of the PDF document.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setFilename

void setFilename(String filename)
          throws NXException,
                 RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

filename -

Throws:

NXException

RemoteException

createCdf

CDF createCdf()
       throws NXException,
              RemoteException

Creates and returns a 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.
License requirements: None.

Created in NX5.0.0

Returns:

CDF object

Throws:

NXException

RemoteException

getCdf

CDF getCdf()
    throws NXException,
           RemoteException

Returns a 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.
License requirements: None.

Created in NX5.0.0

Returns:

CDF object

Throws:

NXException

RemoteException

createWidthDefinition

WidthDefinition createWidthDefinition()
                               throws NXException,
                                      RemoteException

Creates and returns a 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.
License requirements: None.

Created in NX5.0.0

Returns:

WidthDefinition object

Throws:

NXException

RemoteException

getWidthDefinition

WidthDefinition getWidthDefinition()
                            throws NXException,
                                   RemoteException

Returns a 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.
License requirements: None.

Created in NX5.0.0

Returns:

WidthDefinition object

Throws:

NXException

RemoteException

rasterImages

boolean rasterImages()
              throws NXException,
                     RemoteException

Returns the Raster Images option. This option determines whether or not raster images will be exported to the PDF document.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setRasterImages

void setRasterImages(boolean rasterImages)
              throws NXException,
                     RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

rasterImages -

Throws:

NXException

RemoteException

shadedGeometry

boolean shadedGeometry()
                throws NXException,
                       RemoteException

Returns the Shaded Geometry as Wireframe option. If set to true, this option will show shaded objects as wireframes. The shaded objects will be represented as shaded if this option is set to false.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setShadedGeometry

void setShadedGeometry(boolean shadedGeometry)
                throws NXException,
                       RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

shadedGeometry -

Throws:

NXException

RemoteException

customSymbolsInForeground

boolean customSymbolsInForeground()
                           throws NXException,
                                  RemoteException

Returns the plotting custom symbols in the foreground option. Setting this option on will cause custom symbols to be plotted in the foreground. When this option is off, geometry may overlap custom symbols when plotted.
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException

setCustomSymbolsInForeground

void setCustomSymbolsInForeground(boolean customSymbolsInForeground)
                           throws NXException,
                                  RemoteException

License requirements: None.

Created in NX11.0.0

Parameters:

customSymbolsInForeground -

Throws:

NXException

RemoteException

imageResolution

PrintPDFBuilder.ImageResolutionOption imageResolution()
                                               throws NXException,
                                                      RemoteException

Returns the resolution of images created for export of shaded views.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setImageResolution

void setImageResolution(PrintPDFBuilder.ImageResolutionOption imageResolution)
                 throws NXException,
                        RemoteException

License requirements: None.

Created in NX5.0.0

Parameters:

imageResolution -

Throws:

NXException

RemoteException

sourceBuilder

PlotSourceBuilder sourceBuilder()
                         throws NXException,
                                RemoteException

Returns the Source builder. The Source builder contains all data involving the selected sheets.
License requirements: None.

Created in NX5.0.1

Returns:

New SourceBuilder object

Throws:

NXException

RemoteException

outputText

PrintPDFBuilder.OutputTextOption outputText()
                                     throws NXException,
                                            RemoteException

Returns the output text of the PDF. This will determine whether the drawing text will be exported as text or as polylines.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setOutputText

void setOutputText(PrintPDFBuilder.OutputTextOption outputText)
            throws NXException,
                   RemoteException

License requirements: None.

Created in NX6.0.0

Parameters:

outputText -

Throws:

NXException

RemoteException

relation

PrintPDFBuilder.RelationOption relation()
                                 throws NXException,
                                        RemoteException

Returns the relation to be used when exporting a PDF to Teamcenter
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setRelation

void setRelation(PrintPDFBuilder.RelationOption relation)
          throws NXException,
                 RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

relation -

Throws:

NXException

RemoteException

datasetType

String datasetType()
            throws NXException,
                   RemoteException

Returns the dataset type to be used when exporting a PDF to Teamcenter
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setDatasetType

void setDatasetType(String datasetType)
             throws NXException,
                    RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

datasetType -

Throws:

NXException

RemoteException

namedReferenceType

String namedReferenceType()
                   throws NXException,
                          RemoteException

Returns the named reference type to be used when exporting a PDF to Teamcenter
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setNamedReferenceType

void setNamedReferenceType(String namedReferenceType)
                    throws NXException,
                           RemoteException

License requirements: None.

Created in NX7.5.0

Parameters:

namedReferenceType -

Throws:

NXException

RemoteException