public interface HoleCalloutSettingsBuilder extends TaggedObject, IComponentBuilder
HoleCalloutSettingsBuilder
, this builder contains list(s) of parameter(s) for feature(s).
Each feature is categorized under a feature type, indicated by HoleCalloutSettingsBuilder.Featuretype
.
For each feature, parameter(s) are arranged in an array, with a starting index of zero. Modifier and Type | Interface and Description |
---|---|
static class |
HoleCalloutSettingsBuilder.Featuretype
This reprensent the option that indicates a type of hole features.
|
static class |
HoleCalloutSettingsBuilder.LeaderAttachment
This reprensent the option that indicates the position for the leader to attach to.
|
static class |
HoleCalloutSettingsBuilder.Parametertype
This reprensent the option that indicates a type of hole feature parameters.
|
Modifier and Type | Method and Description |
---|---|
void |
deleteLineBreak(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth)
If the nth hole feature parameter of feature type is a line break and it can be deleted, deletes it.
|
HoleCalloutSettingsBuilder.LeaderAttachment |
getLeaderAttachment()
Gets the leader attachment, which decides where the leader is attached to the call out.
|
double |
getLineSpaceFactor()
Gets the line space factor, which defines the vertical space between parameters.
|
HoleCalloutSettingsBuilder.Featuretype[] |
getListOfFeatures()
Gets the list of features.
|
HoleCalloutSettingsBuilder.Parametertype[] |
getListOfParameters(HoleCalloutSettingsBuilder.Featuretype featureType)
Gets the list of parameters for feature type.
|
boolean |
getNthParameterDisplay(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth)
Gets the display status of the nth hole feature parameter of feature type.
|
String[] |
getNthParameterPrefix(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth)
If the nth hole feature parameter of feature type can have prefix, gets its prefix.
|
StyleBuilder |
getNthParameterStyle(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth)
Gets the parameter style of the nth hole feature parameter of feature type.
|
String[] |
getNthParameterSuffix(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth)
If the nth hole feature parameter of feature type can have suffix, gets its suffix.
|
String |
getNthParameterValue(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth)
Gets the parameter expression of the nth hole feature parameter of feature type.
|
double |
getParameterSpaceFactor()
Gets the parameter space factor, which defines the horizontal space between parameters.
|
void |
insertLineBreak(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth)
If a line break can be inserted immediately after the nth hole feature parameter of feature type, inserts a line break at that position.
|
boolean |
reorderParameters(HoleCalloutSettingsBuilder.Featuretype featureType,
HoleCalloutSettingsBuilder.Parametertype[] parameters)
Reorder the parameters based on the input.
|
void |
resetFromFeature(nxopen.features.Feature feature,
Component partOccurrence,
View view,
Point3d pickPoint)
Reset the builder data based on a feature if the feature is a hole feature.
|
void |
setLeaderAttachment(HoleCalloutSettingsBuilder.LeaderAttachment leaderAttachment)
Sets the leader attachment, which decides where the leader is attached to the call out.
|
void |
setLineSpaceFactor(double lineSpaceFactor)
Sets the line space factor, which defines the vertical space between parameters.
|
void |
setNthParameterDisplay(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth,
boolean parameterDisplay)
Sets the display status of the nth hole feature parameter of feature type.
|
void |
setNthParameterPrefix(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth,
String[] lines)
If the prefix of the nth hole feature parameter of feature type can be edited, sets its prefix.
|
void |
setNthParameterSuffix(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth,
String[] lines)
If the suffix of the nth hole feature parameter of feature type can be edited, sets its suffix.
|
void |
setNthParameterValue(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth,
String value)
Sets the parameter expression of the nth hole feature parameter of feature type.
|
void |
setParameterSpaceFactor(double parameterSpaceFactor)
Sets the parameter space factor, which defines the horizontal space between parameters.
|
void |
shiftDown(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth)
If the position of the nth hole feature parameter of feature type can be shifted down, shifts it down by one.
|
void |
shiftUp(HoleCalloutSettingsBuilder.Featuretype featureType,
int nth)
If the position of the nth hole feature parameter of feature type can be shifted up, shifts it up by one.
|
printTestData, printTestData, tag, tagValue
validate
HoleCalloutSettingsBuilder.Featuretype[] getListOfFeatures() throws NXException, RemoteException
NXException
RemoteException
HoleCalloutSettingsBuilder.Parametertype[] getListOfParameters(HoleCalloutSettingsBuilder.Featuretype featureType) throws NXException, RemoteException
featureType
- NXException
RemoteException
boolean reorderParameters(HoleCalloutSettingsBuilder.Featuretype featureType, HoleCalloutSettingsBuilder.Parametertype[] parameters) throws NXException, RemoteException
featureType
- parameters
- NXException
RemoteException
void shiftUp(HoleCalloutSettingsBuilder.Featuretype featureType, int nth) throws NXException, RemoteException
HoleCalloutSettingsBuilder.Featuretype.GENERAL_HOLE
, for instance, use the API:
shiftUp(nxopen.annotations.HoleCalloutSettingsBuilder.Featuretype, int)
(HoleCalloutSettingsBuilder.Featuretype.GENERAL_HOLE
, 2)
featureType
- nth
- NXException
RemoteException
void shiftDown(HoleCalloutSettingsBuilder.Featuretype featureType, int nth) throws NXException, RemoteException
HoleCalloutSettingsBuilder.Featuretype.GENERAL_HOLE
, for instance, use the API:
shiftDown(nxopen.annotations.HoleCalloutSettingsBuilder.Featuretype, int)
(HoleCalloutSettingsBuilder.Featuretype.GENERAL_HOLE
, 0)
featureType
- nth
- NXException
RemoteException
void insertLineBreak(HoleCalloutSettingsBuilder.Featuretype featureType, int nth) throws NXException, RemoteException
HoleCalloutSettingsBuilder.Featuretype.GENERAL_HOLE
, for instance, use the API:
insertLineBreak(nxopen.annotations.HoleCalloutSettingsBuilder.Featuretype, int)
(HoleCalloutSettingsBuilder.Featuretype.GENERAL_HOLE
, 3)
featureType
- nth
- NXException
RemoteException
void deleteLineBreak(HoleCalloutSettingsBuilder.Featuretype featureType, int nth) throws NXException, RemoteException
HoleCalloutSettingsBuilder.Featuretype.GENERAL_HOLE
, for instance, use the API:
deleteLineBreak(nxopen.annotations.HoleCalloutSettingsBuilder.Featuretype, int)
(HoleCalloutSettingsBuilder.Featuretype.GENERAL_HOLE
, 1)
featureType
- nth
- NXException
RemoteException
boolean getNthParameterDisplay(HoleCalloutSettingsBuilder.Featuretype featureType, int nth) throws NXException, RemoteException
featureType
- nth
- NXException
RemoteException
void setNthParameterDisplay(HoleCalloutSettingsBuilder.Featuretype featureType, int nth, boolean parameterDisplay) throws NXException, RemoteException
featureType
- nth
- parameterDisplay
- NXException
RemoteException
void setNthParameterValue(HoleCalloutSettingsBuilder.Featuretype featureType, int nth, String value) throws NXException, RemoteException
featureType
- nth
- value
- NXException
RemoteException
String getNthParameterValue(HoleCalloutSettingsBuilder.Featuretype featureType, int nth) throws NXException, RemoteException
featureType
- nth
- NXException
RemoteException
void setNthParameterPrefix(HoleCalloutSettingsBuilder.Featuretype featureType, int nth, String[] lines) throws NXException, RemoteException
featureType
- nth
- lines
- List of new linesNXException
RemoteException
String[] getNthParameterPrefix(HoleCalloutSettingsBuilder.Featuretype featureType, int nth) throws NXException, RemoteException
featureType
- nth
- NXException
RemoteException
void setNthParameterSuffix(HoleCalloutSettingsBuilder.Featuretype featureType, int nth, String[] lines) throws NXException, RemoteException
featureType
- nth
- lines
- List of new linesNXException
RemoteException
String[] getNthParameterSuffix(HoleCalloutSettingsBuilder.Featuretype featureType, int nth) throws NXException, RemoteException
featureType
- nth
- NXException
RemoteException
StyleBuilder getNthParameterStyle(HoleCalloutSettingsBuilder.Featuretype featureType, int nth) throws NXException, RemoteException
featureType
- nth
- NXException
RemoteException
void resetFromFeature(nxopen.features.Feature feature, Component partOccurrence, View view, Point3d pickPoint) throws NXException, RemoteException
feature
- partOccurrence
- view
- pickPoint
- selected object pointNXException
RemoteException
double getParameterSpaceFactor() throws NXException, RemoteException
NXException
RemoteException
void setParameterSpaceFactor(double parameterSpaceFactor) throws NXException, RemoteException
parameterSpaceFactor
- NXException
RemoteException
double getLineSpaceFactor() throws NXException, RemoteException
NXException
RemoteException
void setLineSpaceFactor(double lineSpaceFactor) throws NXException, RemoteException
lineSpaceFactor
- NXException
RemoteException
HoleCalloutSettingsBuilder.LeaderAttachment getLeaderAttachment() throws NXException, RemoteException
NXException
RemoteException
void setLeaderAttachment(HoleCalloutSettingsBuilder.LeaderAttachment leaderAttachment) throws NXException, RemoteException
leaderAttachment
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.