public interface PlotBuilder extends Builder
PlotBuilder
. This class contains all information relating to
plotting. The user must specify the sheets to be plotted by setting the appropriate fields
through the PlotSourceBuilder
. For each sheet selected, a temporary CGM
file name must be supplied. Once the sheets are selected, the user must set the plotter and
profile fields. If the plotter selected is an image file (JPEG, TIFF, EMF, CGM, or PNG), then
a graphic filename must also be supplied for each sheet selected. The PlotBuilder class also
handles all Banner data and Manufacturing data to be used during plotting. This class is created
using PlotManager
.
PlotManager.createPlotBuilder()
Modifier and Type | Interface and Description |
---|---|
static class |
PlotBuilder.ImageResolutionOption
Specifies the plot image resolution
|
static class |
PlotBuilder.JustificationOption
Specifies the justification of the banner
|
static class |
PlotBuilder.PlotTypes
Specifies the type of plot
|
static class |
PlotBuilder.RotationOption
Specifies the rotation of the banner
|
static class |
PlotBuilder.UnitsOption
Specifies which units are associated to the dimensions
|
static class |
PlotBuilder.XdisplayOption
Specifies the x-coordinate for the banner location
|
static class |
PlotBuilder.YdisplayOption
Specifies the y-coordinate for the banner location
|
Modifier and Type | Method and Description |
---|---|
void |
addToPlotLayout()
Add Plot to Layout.
|
void |
advancedPlot()
Initialize the SDI dialog.
|
String |
bannerMessage()
Returns the banner message.
|
double |
characterSize()
Returns the character size of the banner.
|
void |
clearPlotLayout()
Clear Plot from Layout.
|
boolean |
clsfData()
Returns the option to plot clsf data.
|
PlotColorsWidthsBuilder |
colorsWidthsBuilder()
Returns the Colors Widths builder.
|
int |
copies()
Returns the number of copies to be plotted.
|
boolean |
displayBanner()
Returns the display banner.
|
String[] |
getFilenames()
Gets all the temporary CGM filenames to be plotted.
|
String[] |
getGraphicFilenames()
Gets all the Graphic filenames to be saved.
|
PlotBuilder.ImageResolutionOption |
imageResolution()
Returns the resolution of images created for plotting shaded views.
|
String |
jobName()
Returns the job name to be used for plotting.
|
PlotBuilder.JustificationOption |
justification()
Returns the justification of the banner text.
|
String |
plotterText()
Returns the plotter text.
|
PlotBuilder.PlotTypes |
plotType()
Returns the type of plot.
|
String |
printerGroupText()
Returns the printer group text.
|
String |
profileText()
Returns the profile text.
|
boolean |
rasterImages()
Returns the raster images option.
|
PlotBuilder.RotationOption |
rotation()
Returns the rotation of the banner.
|
void |
saveCgm()
Saves the selected sheets as CGM files.
|
void |
setBannerMessage(String bannerMessage)
License requirements: None. |
void |
setCharacterSize(double characterSize)
License requirements: None. |
void |
setClsfData(boolean clsfData)
License requirements: None. |
void |
setCopies(int copies)
License requirements: None. |
void |
setDisplayBanner(boolean displayBanner)
License requirements: None. |
void |
setFilenames(String[] filenames)
Sets all the temporary CGM filenames to be plotted.
|
void |
setGraphicFilenames(String[] filenames)
Sets all the Graphic filenames to be saved.
|
void |
setImageResolution(PlotBuilder.ImageResolutionOption imageResolution)
License requirements: None. |
void |
setJobName(String jobName)
License requirements: None. |
void |
setJustification(PlotBuilder.JustificationOption justification)
License requirements: None. |
void |
setPlotterText(String plotter)
License requirements: None. |
void |
setPlotType(PlotBuilder.PlotTypes plotType)
License requirements: None. |
void |
setPrinterGroupText(String printerGroup)
License requirements: None. |
void |
setProfileText(String profile)
License requirements: None. |
void |
setRasterImages(boolean rasterImages)
License requirements: None. |
void |
setRotation(PlotBuilder.RotationOption rotation)
License requirements: None. |
void |
setShadedGeometry(boolean shadedGeometry)
License requirements: None. |
void |
setTolerance(double tolerance)
License requirements: None. |
void |
setUnits(PlotBuilder.UnitsOption units)
License requirements: None. |
void |
setXDisplay(PlotBuilder.XdisplayOption xDisplay)
License requirements: None. |
void |
setXOffset(double xOffset)
License requirements: None. |
void |
setYDisplay(PlotBuilder.YdisplayOption yDisplay)
License requirements: None. |
void |
setYOffset(double yOffset)
License requirements: None. |
boolean |
shadedGeometry()
Returns the shaded geometry as wireframe option.
|
PlotSourceBuilder |
sourceBuilder()
Returns the Source builder.
|
double |
tolerance()
Returns the plotting tolerance.
|
PlotBuilder.UnitsOption |
units()
Returns the units used to create the banner.
|
PlotBuilder.XdisplayOption |
xdisplay()
Returns the X coordinate of a banner.
|
double |
xoffset()
Returns the X coordinate offset of a banner.
|
PlotBuilder.YdisplayOption |
ydisplay()
Returns the Y coordinate of a banner.
|
double |
yoffset()
Returns the Y coordinate offset of a banner.
|
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
PlotBuilder.PlotTypes plotType() throws NXException, RemoteException
NXException
RemoteException
void setPlotType(PlotBuilder.PlotTypes plotType) throws NXException, RemoteException
plotType
- NXException
RemoteException
void addToPlotLayout() throws NXException, RemoteException
NXException
RemoteException
void clearPlotLayout() throws NXException, RemoteException
NXException
RemoteException
boolean displayBanner() throws NXException, RemoteException
NXException
RemoteException
void setDisplayBanner(boolean displayBanner) throws NXException, RemoteException
displayBanner
- NXException
RemoteException
String bannerMessage() throws NXException, RemoteException
NXException
RemoteException
void setBannerMessage(String bannerMessage) throws NXException, RemoteException
bannerMessage
- NXException
RemoteException
PlotBuilder.UnitsOption units() throws NXException, RemoteException
NXException
RemoteException
void setUnits(PlotBuilder.UnitsOption units) throws NXException, RemoteException
units
- NXException
RemoteException
PlotBuilder.XdisplayOption xdisplay() throws NXException, RemoteException
NXException
RemoteException
void setXDisplay(PlotBuilder.XdisplayOption xDisplay) throws NXException, RemoteException
xDisplay
- NXException
RemoteException
double xoffset() throws NXException, RemoteException
NXException
RemoteException
void setXOffset(double xOffset) throws NXException, RemoteException
xOffset
- NXException
RemoteException
PlotBuilder.YdisplayOption ydisplay() throws NXException, RemoteException
NXException
RemoteException
void setYDisplay(PlotBuilder.YdisplayOption yDisplay) throws NXException, RemoteException
yDisplay
- NXException
RemoteException
double yoffset() throws NXException, RemoteException
NXException
RemoteException
void setYOffset(double yOffset) throws NXException, RemoteException
yOffset
- NXException
RemoteException
double characterSize() throws NXException, RemoteException
NXException
RemoteException
void setCharacterSize(double characterSize) throws NXException, RemoteException
characterSize
- NXException
RemoteException
PlotBuilder.RotationOption rotation() throws NXException, RemoteException
NXException
RemoteException
void setRotation(PlotBuilder.RotationOption rotation) throws NXException, RemoteException
rotation
- NXException
RemoteException
PlotBuilder.JustificationOption justification() throws NXException, RemoteException
NXException
RemoteException
void setJustification(PlotBuilder.JustificationOption justification) throws NXException, RemoteException
justification
- NXException
RemoteException
void saveCgm() throws NXException, RemoteException
NXException
RemoteException
void advancedPlot() throws NXException, RemoteException
NXException
RemoteException
int copies() throws NXException, RemoteException
NXException
RemoteException
void setCopies(int copies) throws NXException, RemoteException
copies
- NXException
RemoteException
String jobName() throws NXException, RemoteException
NXException
RemoteException
void setJobName(String jobName) throws NXException, RemoteException
jobName
- NXException
RemoteException
double tolerance() throws NXException, RemoteException
NXException
RemoteException
void setTolerance(double tolerance) throws NXException, RemoteException
tolerance
- NXException
RemoteException
boolean clsfData() throws NXException, RemoteException
NXException
RemoteException
void setClsfData(boolean clsfData) throws NXException, RemoteException
clsfData
- 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
PlotColorsWidthsBuilder colorsWidthsBuilder() throws NXException, RemoteException
NXException
RemoteException
PlotSourceBuilder sourceBuilder() throws NXException, RemoteException
NXException
RemoteException
String[] getFilenames() throws NXException, RemoteException
NXException
RemoteException
void setFilenames(String[] filenames) throws NXException, RemoteException
filenames
- NXException
RemoteException
String[] getGraphicFilenames() throws NXException, RemoteException
NXException
RemoteException
void setGraphicFilenames(String[] filenames) throws NXException, RemoteException
filenames
- NXException
RemoteException
String plotterText() throws NXException, RemoteException
NXException
RemoteException
void setPlotterText(String plotter) throws NXException, RemoteException
plotter
- NXException
RemoteException
String profileText() throws NXException, RemoteException
NXException
RemoteException
void setProfileText(String profile) throws NXException, RemoteException
profile
- NXException
RemoteException
String printerGroupText() throws NXException, RemoteException
NXException
RemoteException
void setPrinterGroupText(String printerGroup) throws NXException, RemoteException
printerGroup
- NXException
RemoteException
PlotBuilder.ImageResolutionOption imageResolution() throws NXException, RemoteException
NXException
RemoteException
void setImageResolution(PlotBuilder.ImageResolutionOption imageResolution) throws NXException, RemoteException
imageResolution
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.