public interface SheetBuilder extends BaseObjectBuilder
SheetCollection.createSheetBuilder(nxopen.diagramming.Sheet)
Modifier and Type | Interface and Description |
---|---|
static class |
SheetBuilder.SizeData
This class holds the data returned from
getSize() |
Modifier and Type | Method and Description |
---|---|
boolean |
allowJumpers()
Returns the flag if jumpers are allowed to use where connections cross.
|
String |
description()
Returns the description that will be visible when a template is selected in the Item Rev dialog.
|
SheetElement[] |
getFeatures()
Gets all features.
|
SheetElement[] |
getSheetElements()
Gets all sheet elements.
|
SheetBuilder.SizeData |
getSize()
Gets the height and width of this sheet.
|
DiagrammingJumpertype |
jumperType()
Returns the jumper type of the sheet.
|
double |
opacity()
Returns the opacity of sheet. 0.0 is completely transparent and 1.0 is completely opaque
License requirements: None. |
String |
paxFileName()
Returns the path name of the PAX file to which the template will be written to.
|
String |
presentationName()
Returns the presentation name that will be visible in the "Presentation" column of the Item Rev dialog.
|
void |
setAllowJumpers(boolean allowJumper)
License requirements: None. |
void |
setDescription(String description)
License requirements: None. |
void |
setJumperType(DiagrammingJumpertype jumperType)
License requirements: None. |
void |
setOpacity(double opacity)
License requirements: None. |
void |
setPaxFileName(String paxFileName)
License requirements: None. |
void |
setPresentationName(String presentationName)
License requirements: None. |
void |
setSize(double height,
double width)
Sets the height and width of this sheet.
|
void |
setToolTip(String toolTip)
License requirements: None. |
void |
setUnits(Unit unit)
License requirements: None. |
void |
setUpdatePAXFile(boolean updatePAXFile)
License requirements: None. |
String |
toolTip()
Returns the tooltip that will be visible when a template is selected in the Item Rev dialog.
|
Unit |
units()
Returns the units of the sheet.
|
boolean |
updatePAXFile()
Returns the flag to update pax file or not.
|
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
boolean allowJumpers() throws NXException, RemoteException
NXException
RemoteException
void setAllowJumpers(boolean allowJumper) throws NXException, RemoteException
allowJumper
- NXException
RemoteException
DiagrammingJumpertype jumperType() throws NXException, RemoteException
NXException
RemoteException
void setJumperType(DiagrammingJumpertype jumperType) throws NXException, RemoteException
jumperType
- NXException
RemoteException
SheetElement[] getFeatures() throws NXException, RemoteException
NXException
RemoteException
double opacity() throws NXException, RemoteException
NXException
RemoteException
void setOpacity(double opacity) throws NXException, RemoteException
opacity
- NXException
RemoteException
SheetElement[] getSheetElements() throws NXException, RemoteException
NXException
RemoteException
SheetBuilder.SizeData getSize() throws NXException, RemoteException
NXException
RemoteException
void setSize(double height, double width) throws NXException, RemoteException
height
- width
- NXException
RemoteException
Unit units() throws NXException, RemoteException
NXException
RemoteException
void setUnits(Unit unit) throws NXException, RemoteException
unit
- NXException
RemoteException
boolean updatePAXFile() throws NXException, RemoteException
NXException
RemoteException
void setUpdatePAXFile(boolean updatePAXFile) throws NXException, RemoteException
updatePAXFile
- NXException
RemoteException
String presentationName() throws NXException, RemoteException
NXException
RemoteException
void setPresentationName(String presentationName) throws NXException, RemoteException
presentationName
- NXException
RemoteException
String description() throws NXException, RemoteException
NXException
RemoteException
void setDescription(String description) throws NXException, RemoteException
description
- NXException
RemoteException
String toolTip() throws NXException, RemoteException
NXException
RemoteException
void setToolTip(String toolTip) throws NXException, RemoteException
toolTip
- NXException
RemoteException
String paxFileName() throws NXException, RemoteException
NXException
RemoteException
void setPaxFileName(String paxFileName) throws NXException, RemoteException
paxFileName
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.