public interface TransientText extends TransientObject
Modifier and Type | Interface and Description |
---|---|
static class |
TransientText.AbsoluteTextSizeData
This class holds the data returned from
getAbsoluteTextSize() |
static class |
TransientText.StandardTextRef
This enumerated type specifies the type of reference point used in the text box
for standard_text methods.
|
static class |
TransientText.TextSize
Provides a way to specify the size of the desired text, as small,
medium or large (normal is a synonym for medium).
|
static class |
TransientText.ViewType
the view or views in which the transient text is to be displayed.
|
Modifier and Type | Method and Description |
---|---|
void |
addTextString(String textString)
Adds a text string to the TransientText object.
|
int |
color()
Returns the index of the color to be used to display the transient text.
|
void |
displayTemporaryAbsoluteGeometry(int fontIndex,
View view,
TransientText.ViewType viewType,
DisplayableObject object,
Point3d position)
Displays text as temporary display using absolute geometry.
|
void |
displayTemporaryAbsRotScreenSizeGeometry(int fontIndex,
View view,
TransientText.ViewType viewType,
DisplayableObject object,
Point3d position)
Displays text as temporary display using screen geometry but with rotation
defined in absolute space.
|
void |
displayTemporaryScreenGeometry(int fontIndex,
View view,
TransientText.ViewType viewType,
DisplayableObject object,
Point3d position)
Displays text as temporary display using screen geometry.
|
String |
fontStyle()
Returns the style of font to be used to display the transient text.
|
TransientText.AbsoluteTextSizeData |
getAbsoluteTextSize()
Returns the size of the text, in absolute coordinate, in units of the displayed part.
|
TransientText.StandardTextRef |
referencePositionType()
Returns the position of the text relative to positions on the text box
License requirements: None. |
TransientText.TextSize |
screenTextSize()
Returns the approximate size of the text (small, mendium, large) as measured on
the graphics screen.
|
void |
setAbsoluteTextSize(double glyphWidth,
double glyphHeight)
Sets the size of the text, in absolute coordinates, in units of the displayed part.
|
void |
setColor(int colorIndex)
Sets the index of the color to be used to display the transient text.
|
void |
setFontStyle(String fontStyle)
Sets the style of font to be used to display the transient text.
|
void |
setReferencePositionType(TransientText.StandardTextRef referencePositionType)
Sets the position of the text relative to positions on the text box
License requirements: None. |
void |
setScreenTextSize(TransientText.TextSize textSize)
Sets the approximate size of the text (small, mendium, large) as measured on
the graphics screen.
|
_value, dispose, printTestData, printTestData
void displayTemporaryAbsoluteGeometry(int fontIndex, View view, TransientText.ViewType viewType, DisplayableObject object, Point3d position) throws NXException, RemoteException
fontIndex
- The index of the font to be used. This may
be 0, which means to use the default font.view
- The view in which to display the text.
This may be null, in which case the
viewType argument is used.viewType
- Used only when view is null.object
- May be null, in which case the
text will be drawn at the given position.
If not null, draw the text at the
attention point of object.position
- In Absolute CoordinatesNXException
RemoteException
void displayTemporaryScreenGeometry(int fontIndex, View view, TransientText.ViewType viewType, DisplayableObject object, Point3d position) throws NXException, RemoteException
fontIndex
- The index of the font to be used. This may
be 0, which means to use the default font.view
- The view in which to display the text.
This may be null, in which case the
viewType argument is used.viewType
- Used only when view is null.object
- May be null, in which case the
text will be drawn at the given position.
If not null, draw the text at the
attention point of object.position
- In Absolute CoordinatesNXException
RemoteException
void displayTemporaryAbsRotScreenSizeGeometry(int fontIndex, View view, TransientText.ViewType viewType, DisplayableObject object, Point3d position) throws NXException, RemoteException
fontIndex
- The index of the font to be used. This may
be 0, which means to use the default font.view
- The view in which to display the text.
This may be null, in which case the
viewType argument is used.viewType
- Used only when view is null.object
- May be null, in which case the
text will be drawn at the given position.
If not null, draw the text at the
attention point of object.position
- In Absolute CoordinatesNXException
RemoteException
void addTextString(String textString) throws NXException, RemoteException
textString
- NXException
RemoteException
String fontStyle() throws NXException, RemoteException
NXException
RemoteException
void setFontStyle(String fontStyle) throws NXException, RemoteException
fontStyle
- NXException
RemoteException
int color() throws NXException, RemoteException
NXException
RemoteException
void setColor(int colorIndex) throws NXException, RemoteException
colorIndex
- NXException
RemoteException
TransientText.StandardTextRef referencePositionType() throws NXException, RemoteException
NXException
RemoteException
void setReferencePositionType(TransientText.StandardTextRef referencePositionType) throws NXException, RemoteException
referencePositionType
- NXException
RemoteException
TransientText.TextSize screenTextSize() throws NXException, RemoteException
Display.TransientText#displayTemporaryAbsoluteGeometry
.
NXException
RemoteException
void setScreenTextSize(TransientText.TextSize textSize) throws NXException, RemoteException
Display.TransientText#displayTemporaryAbsoluteGeometry
.
textSize
- NXException
RemoteException
TransientText.AbsoluteTextSizeData getAbsoluteTextSize() throws NXException, RemoteException
Display.TransientText#displayTemporaryAbsoluteGeometry
.
NXException
RemoteException
void setAbsoluteTextSize(double glyphWidth, double glyphHeight) throws NXException, RemoteException
Display.TransientText#displayTemporaryAbsoluteGeometry
.
glyphWidth
- glyphHeight
- NXException
RemoteException
Copyright 2016 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.