public interface TextWithSymbolsBuilder extends TaggedObject, IComponentBuilder
TextWithSymbolsBuilder
which collects
internationalized text strings from the user for processing on an annotation object.
Modifier and Type | Interface and Description |
---|---|
static class |
TextWithSymbolsBuilder.SymbolAlignmentType
Enum for the symbol alignment
|
static class |
TextWithSymbolsBuilder.SymbolPreferencesType
Enum for the symbol preferences
|
static class |
TextWithSymbolsBuilder.SymbolSizingMethod
sizing method for embedded user-defined symbols
|
Modifier and Type | Method and Description |
---|---|
void |
addAttributeReference(NXObject ownerTag,
String title,
boolean displayTokens,
int lineNo,
int cursorPos)
Adds an attribute reference
License requirements: drafting ("DRAFTING") . |
void |
addExpressionReference(String expName,
String format,
int lineNo,
int cursorPos)
Adds an expression reference
License requirements: drafting ("DRAFTING") . |
void |
addSymbol(NXObject newObject,
String name,
int lineNo,
int cursorPos)
Adds a symbol
License requirements: drafting ("DRAFTING") . |
double |
customSymbolScale()
Returns the scale of the custom symbols
License requirements: None. |
BaseCustomSymbol[] |
getEmbeddedCustomSymbols()
Retrieves the embedded custom symbols
License requirements: None. |
TextWithSymbolsBuilder.SymbolAlignmentType |
getSymbolAlignment(String symbolName)
Get the alignement of embedded symbol correspoding to symbol name
License requirements: None. |
String[] |
getText()
Returns the text of the annotation
License requirements: None. |
void |
removeSymbol(String path)
Removes specified symbol
License requirements: drafting ("DRAFTING") . |
void |
setCustomSymbolScale(double customSymbolScale)
License requirements: drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setSymbolAlignment(String symbolName,
TextWithSymbolsBuilder.SymbolAlignmentType symbolAlignment)
Set the alignement on embedded symbol correspoding to symbol name
License requirements: drafting ("DRAFTING") . |
void |
setSymbolAspectRatio(double symbolAspectRatio)
License requirements: drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setSymbolHeight(double symbolHeight)
License requirements: drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setSymbolLength(double symbolLength)
License requirements: drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setSymbolPreferences(TextWithSymbolsBuilder.SymbolPreferencesType symbolPreferences)
License requirements: drafting ("DRAFTING") . |
void |
setSymbolScale(double symbolScale)
License requirements: drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setSymbolSizeMethod(TextWithSymbolsBuilder.SymbolSizingMethod symbolSizeMethod)
License requirements: drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setText(String[] text)
Sets the text of the annotation
License requirements: drafting ("DRAFTING") OR geometric_tol ("GDT") . |
double |
symbolAspectRatio()
Returns the aspect ratio of the embedded user-defined symbols if the symbol size method is
TextWithSymbolsBuilder.SymbolSizingMethod.SCALE_AND_ASPECT_RATIO
License requirements: None. |
double |
symbolHeight()
Returns the height of the embedded user-defined symbols if the symbol size method is
TextWithSymbolsBuilder.SymbolSizingMethod.LENGTH_AND_HEIGHT
License requirements: None. |
double |
symbolLength()
Returns the length of the embedded user-defined symbols if the symbol size method is
TextWithSymbolsBuilder.SymbolSizingMethod.LENGTH_AND_HEIGHT
License requirements: None. |
TextWithSymbolsBuilder.SymbolPreferencesType |
symbolPreferences()
Returns the symbol preferences
License requirements: None. |
double |
symbolScale()
Returns the scale of the embedded user-defined symbols if the symbol size method is
TextWithSymbolsBuilder.SymbolSizingMethod.SCALE_AND_ASPECT_RATIO
License requirements: None. |
TextWithSymbolsBuilder.SymbolSizingMethod |
symbolSizeMethod()
Returns the method in which embedded user-defined symbols are scaled
License requirements: None. |
printTestData, printTestData, tag, tagValue
validate
String[] getText() throws NXException, RemoteException
NXException
RemoteException
void setText(String[] text) throws NXException, RemoteException
text
- NXException
RemoteException
TextWithSymbolsBuilder.SymbolSizingMethod symbolSizeMethod() throws NXException, RemoteException
NXException
RemoteException
void setSymbolSizeMethod(TextWithSymbolsBuilder.SymbolSizingMethod symbolSizeMethod) throws NXException, RemoteException
symbolSizeMethod
- NXException
RemoteException
double symbolScale() throws NXException, RemoteException
TextWithSymbolsBuilder.SymbolSizingMethod.SCALE_AND_ASPECT_RATIO
NXException
RemoteException
void setSymbolScale(double symbolScale) throws NXException, RemoteException
symbolScale
- NXException
RemoteException
double symbolAspectRatio() throws NXException, RemoteException
TextWithSymbolsBuilder.SymbolSizingMethod.SCALE_AND_ASPECT_RATIO
NXException
RemoteException
void setSymbolAspectRatio(double symbolAspectRatio) throws NXException, RemoteException
symbolAspectRatio
- NXException
RemoteException
double symbolLength() throws NXException, RemoteException
TextWithSymbolsBuilder.SymbolSizingMethod.LENGTH_AND_HEIGHT
NXException
RemoteException
void setSymbolLength(double symbolLength) throws NXException, RemoteException
symbolLength
- NXException
RemoteException
double symbolHeight() throws NXException, RemoteException
TextWithSymbolsBuilder.SymbolSizingMethod.LENGTH_AND_HEIGHT
NXException
RemoteException
void setSymbolHeight(double symbolHeight) throws NXException, RemoteException
symbolHeight
- NXException
RemoteException
double customSymbolScale() throws NXException, RemoteException
NXException
RemoteException
void setCustomSymbolScale(double customSymbolScale) throws NXException, RemoteException
customSymbolScale
- NXException
RemoteException
void addSymbol(NXObject newObject, String name, int lineNo, int cursorPos) throws NXException, RemoteException
newObject
- symbol instance objectname
- symbol namelineNo
- line number to insert token with index from 1cursorPos
- cursor position in the line with index from 1NXException
RemoteException
void removeSymbol(String path) throws NXException, RemoteException
path
- Symbol nameNXException
RemoteException
BaseCustomSymbol[] getEmbeddedCustomSymbols() throws NXException, RemoteException
NXException
RemoteException
TextWithSymbolsBuilder.SymbolPreferencesType symbolPreferences() throws NXException, RemoteException
NXException
RemoteException
void setSymbolPreferences(TextWithSymbolsBuilder.SymbolPreferencesType symbolPreferences) throws NXException, RemoteException
symbolPreferences
- NXException
RemoteException
TextWithSymbolsBuilder.SymbolAlignmentType getSymbolAlignment(String symbolName) throws NXException, RemoteException
symbolName
- Symbol NameNXException
RemoteException
void setSymbolAlignment(String symbolName, TextWithSymbolsBuilder.SymbolAlignmentType symbolAlignment) throws NXException, RemoteException
symbolName
- Symbol NamesymbolAlignment
- Symbol AlignmentNXException
RemoteException
void addAttributeReference(NXObject ownerTag, String title, boolean displayTokens, int lineNo, int cursorPos) throws NXException, RemoteException
ownerTag
- object that owns the attribute. If we are trying to reference a part attribute
then this should be the part objecttitle
- title of attributedisplayTokens
- True to display using TC tokens.
False to display as plain text.lineNo
- line number to insert token with index from 1cursorPos
- cursor position in the line with index from 1NXException
RemoteException
void addExpressionReference(String expName, String format, int lineNo, int cursorPos) throws NXException, RemoteException
expName
- expression nameformat
- format to use for displaying an expression.
'A' for displaying the expression formula, or
'm.n' where 'm' is the minimum number of characters displayed
and 'n' is the number of decimal places to displaylineNo
- line number to insert token with index from 1cursorPos
- cursor position in the line with index from 1NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.