public interface PartsListBuilder extends TaggedObject, IComponentBuilder
PartsListBuilder
.
This class queries and sets settings specific to parts list when creating or
editing parts list settings.
Modifier and Type | Interface and Description |
---|---|
static class |
PartsListBuilder.PartsListGrowDirectionOptions
Grow direction options
The options specify the direction of growth for the parts list
|
static class |
PartsListBuilder.PartsListMainSymbolText
Main Symbol Text Types
Specifies the text to display in the main callout symbol
|
static class |
PartsListBuilder.PartsListReferenceSymbolText
Reference Symbol Text Types
Specifies the text to display in the reference callout symbol
|
static class |
PartsListBuilder.PartsListShowLockedDeletedRows
Locked deleted rows options
The options specify how to show rows that are locked, but reference components that have been removed from the assembly
|
static class |
PartsListBuilder.PartsListSymbolType
Symbol Types
The types specify the balloon type used to call out members
|
static class |
PartsListBuilder.PartsListVerticalGroupLeaderAttachment
Represents leader attachment for vertical callout groups.
|
Modifier and Type | Method and Description |
---|---|
boolean |
allowManualRows()
Returns the allow manual rows option that determines whether or not manual rows are allowed to be inserted into a parts list
License requirements: None. |
boolean |
automaticUpdate()
Returns the automatic update option to determine whether or not the parts list updates automatically whenever a change occurs to a referenced object in the model
License requirements: None. |
String |
calloutSuffix()
Returns the callout suffix specifies the suffix to be used for reference symbol text
License requirements: None. |
String |
charToSkip()
Returns the characters to skip specifies the characters to be skipped for callouts
License requirements: None. |
boolean |
createNewRowAsLocked()
Returns the create new row as locked option that determines whether new rows in the parts list are locked automatically on creation
License requirements: None. |
PartsListBuilder.PartsListGrowDirectionOptions |
growDirectionOptions()
Returns the grow direction options that specify the direction of growth for the parts list
License requirements: None. |
NXColor |
highlightColor()
Returns the highlight color specifies the color used for the delimiters that highlight manual cell text
License requirements: None. |
boolean |
highlightManualText()
Returns the highlight manual text specifies whether manual cell text is to be highlighted by delimiters
License requirements: None. |
int |
increment()
Returns the increment specifies the value by which consecutive callout values are be incremented
License requirements: None. |
String |
initialCallout()
Returns the initial callout specifies the text string used to represent the first callout in the parts list
License requirements: None. |
boolean |
lockPartsListSetup()
Returns the Lock Parts List Setup option that determines Is the parts list setup protected/locked
License requirements: None. |
String |
mainSymbolCustomText()
Returns the main symbol custom text specifies the custom text to display in the main callout symbol
License requirements: None. |
PartsListBuilder.PartsListMainSymbolText |
mainSymbolText()
Returns the main symbol text specifies the text to display in the main callout symbol
License requirements: None. |
String |
referenceSymbolCustomText()
Returns the reference symbol custom text specifies the custom text to display in the main callout symbol
License requirements: None. |
PartsListBuilder.PartsListReferenceSymbolText |
referenceSymbolText()
Returns the reference symbol text specifies the text to display in the reference callout symbol
License requirements: None. |
void |
setAllowManualRows(boolean allowManualRows)
License requirements: None. |
void |
setAutomaticUpdate(boolean automaticUpdate)
License requirements: None. |
void |
setCalloutSuffix(String calloutSuffix)
License requirements: None. |
void |
setCharToSkip(String charsToSkip)
License requirements: None. |
void |
setCreateNewRowAsLocked(boolean createNewRowAsLocked)
License requirements: None. |
void |
setGrowDirectionOptions(PartsListBuilder.PartsListGrowDirectionOptions growDirectionOptions)
License requirements: None. |
void |
setHighlightColor(NXColor highlightColor)
License requirements: None. |
void |
setHighlightManualText(boolean highlightManualText)
License requirements: None. |
void |
setIncrement(int increment)
License requirements: None. |
void |
setInitialCallout(String initialCallout)
License requirements: None. |
void |
setLockPartsListSetup(boolean lockPartsListSetup)
License requirements: None. |
void |
setMainSymbolCustomText(String mainSymbolCustomText)
License requirements: None. |
void |
setMainSymbolText(PartsListBuilder.PartsListMainSymbolText mainSymbolText)
License requirements: None. |
void |
setReferenceSymbolCustomText(String referenceSymbolCustomText)
License requirements: None. |
void |
setReferenceSymbolText(PartsListBuilder.PartsListReferenceSymbolText referenceSymbolText)
License requirements: None. |
void |
setShowLockedDeletedRows(PartsListBuilder.PartsListShowLockedDeletedRows showLockedDeletedRows)
License requirements: None. |
void |
setShowReferenceCalloutSuffix(boolean showReferenceCalloutSuffix)
License requirements: None. |
void |
setSortOnUpdate(boolean sortOnUpdate)
License requirements: None. |
void |
setSymbol(PartsListBuilder.PartsListSymbolType symbol)
License requirements: None. |
void |
setVerticalGroupAttachment(PartsListBuilder.PartsListVerticalGroupLeaderAttachment position)
License requirements: drafting ("DRAFTING") . |
PartsListBuilder.PartsListShowLockedDeletedRows |
showLockedDeletedRows()
Returns the show locked deleted rows option to show rows that are locked, but reference components that have been removed from the assembly
License requirements: None. |
boolean |
showReferenceCalloutSuffix()
Returns the flag indicating whether the reference callout suffix will be displayed.
|
boolean |
sortOnUpdate()
Returns the sort on update option that determines whether or not the parts list sorts automatically during update
License requirements: None. |
PartsListBuilder.PartsListSymbolType |
symbol()
Returns the symbol type specifies the balloon type used to call out members
License requirements: None. |
PartsListBuilder.PartsListVerticalGroupLeaderAttachment |
verticalGroupAttachment()
Returns the leader attachment to vertical callout groups
License requirements: None. |
printTestData, printTestData, tag, tagValue
validate
PartsListBuilder.PartsListGrowDirectionOptions growDirectionOptions() throws NXException, RemoteException
NXException
RemoteException
void setGrowDirectionOptions(PartsListBuilder.PartsListGrowDirectionOptions growDirectionOptions) throws NXException, RemoteException
growDirectionOptions
- NXException
RemoteException
PartsListBuilder.PartsListShowLockedDeletedRows showLockedDeletedRows() throws NXException, RemoteException
NXException
RemoteException
void setShowLockedDeletedRows(PartsListBuilder.PartsListShowLockedDeletedRows showLockedDeletedRows) throws NXException, RemoteException
showLockedDeletedRows
- NXException
RemoteException
boolean automaticUpdate() throws NXException, RemoteException
NXException
RemoteException
void setAutomaticUpdate(boolean automaticUpdate) throws NXException, RemoteException
automaticUpdate
- NXException
RemoteException
boolean sortOnUpdate() throws NXException, RemoteException
NXException
RemoteException
void setSortOnUpdate(boolean sortOnUpdate) throws NXException, RemoteException
sortOnUpdate
- NXException
RemoteException
boolean lockPartsListSetup() throws NXException, RemoteException
NXException
RemoteException
void setLockPartsListSetup(boolean lockPartsListSetup) throws NXException, RemoteException
lockPartsListSetup
- NXException
RemoteException
boolean createNewRowAsLocked() throws NXException, RemoteException
NXException
RemoteException
void setCreateNewRowAsLocked(boolean createNewRowAsLocked) throws NXException, RemoteException
createNewRowAsLocked
- NXException
RemoteException
boolean allowManualRows() throws NXException, RemoteException
NXException
RemoteException
void setAllowManualRows(boolean allowManualRows) throws NXException, RemoteException
allowManualRows
- NXException
RemoteException
PartsListBuilder.PartsListSymbolType symbol() throws NXException, RemoteException
NXException
RemoteException
void setSymbol(PartsListBuilder.PartsListSymbolType symbol) throws NXException, RemoteException
symbol
- NXException
RemoteException
PartsListBuilder.PartsListMainSymbolText mainSymbolText() throws NXException, RemoteException
NXException
RemoteException
void setMainSymbolText(PartsListBuilder.PartsListMainSymbolText mainSymbolText) throws NXException, RemoteException
mainSymbolText
- NXException
RemoteException
String mainSymbolCustomText() throws NXException, RemoteException
NXException
RemoteException
void setMainSymbolCustomText(String mainSymbolCustomText) throws NXException, RemoteException
mainSymbolCustomText
- NXException
RemoteException
PartsListBuilder.PartsListReferenceSymbolText referenceSymbolText() throws NXException, RemoteException
NXException
RemoteException
void setReferenceSymbolText(PartsListBuilder.PartsListReferenceSymbolText referenceSymbolText) throws NXException, RemoteException
referenceSymbolText
- NXException
RemoteException
String referenceSymbolCustomText() throws NXException, RemoteException
NXException
RemoteException
void setReferenceSymbolCustomText(String referenceSymbolCustomText) throws NXException, RemoteException
referenceSymbolCustomText
- NXException
RemoteException
String initialCallout() throws NXException, RemoteException
NXException
RemoteException
void setInitialCallout(String initialCallout) throws NXException, RemoteException
initialCallout
- NXException
RemoteException
int increment() throws NXException, RemoteException
NXException
RemoteException
void setIncrement(int increment) throws NXException, RemoteException
increment
- NXException
RemoteException
String charToSkip() throws NXException, RemoteException
NXException
RemoteException
void setCharToSkip(String charsToSkip) throws NXException, RemoteException
charsToSkip
- NXException
RemoteException
String calloutSuffix() throws NXException, RemoteException
NXException
RemoteException
void setCalloutSuffix(String calloutSuffix) throws NXException, RemoteException
calloutSuffix
- NXException
RemoteException
boolean highlightManualText() throws NXException, RemoteException
NXException
RemoteException
void setHighlightManualText(boolean highlightManualText) throws NXException, RemoteException
highlightManualText
- NXException
RemoteException
NXColor highlightColor() throws NXException, RemoteException
NXException
RemoteException
void setHighlightColor(NXColor highlightColor) throws NXException, RemoteException
highlightColor
- NXException
RemoteException
boolean showReferenceCalloutSuffix() throws NXException, RemoteException
NXException
RemoteException
void setShowReferenceCalloutSuffix(boolean showReferenceCalloutSuffix) throws NXException, RemoteException
showReferenceCalloutSuffix
- NXException
RemoteException
PartsListBuilder.PartsListVerticalGroupLeaderAttachment verticalGroupAttachment() throws NXException, RemoteException
NXException
RemoteException
void setVerticalGroupAttachment(PartsListBuilder.PartsListVerticalGroupLeaderAttachment position) throws NXException, RemoteException
position
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.