com.openinventor.meshviz.graph

Class PbNumericDisplayFormat

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.meshviz.graph.PbBase

com.openinventor.meshviz.graph.PbNumericDisplayFormat

All Implemented Interfaces:

java.lang.Cloneable

public class PbNumericDisplayFormat
extends PbBase
implements java.lang.Cloneable

Class to define a numeric display format. This class is used to define a numerical display format for numerical values to be displayed. There are three formats available: automatic format, floating point format, integer format. The default format is the automatic format. The automatic format selects the best format adapted to the domain of values to be displayed. The floating point format and the integer format divide the numerical value to be displayed by the power of ten, and then display it in the selected format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PbNumericDisplayFormat.Format
static class	PbNumericDisplayFormat.FormatTypes

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_FORMAT Deprecated. Use PbNumericDisplayFormat.FormatTypes.AUTO_FORMAT instead.
static int	FLOAT_FORMAT Deprecated. Use PbNumericDisplayFormat.FormatTypes.FLOAT_FORMAT instead.
static int	INTEGER_FORMAT Deprecated. Use PbNumericDisplayFormat.FormatTypes.INTEGER_FORMAT instead.

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
PbNumericDisplayFormat() Calls PbNumericDisplayFormat(PbNumericDisplayFormat.FormatTypes.valueOf( PbNumericDisplayFormat.FormatTypes.AUTO_FORMAT.getValue() ), (int)0, (int)0).
PbNumericDisplayFormat(PbNumericDisplayFormat.FormatTypes type) Calls PbNumericDisplayFormat(type, (int)0, (int)0).
PbNumericDisplayFormat(PbNumericDisplayFormat.FormatTypes type, int tenPower) Calls PbNumericDisplayFormat(type, tenPower, (int)0).
PbNumericDisplayFormat(PbNumericDisplayFormat.FormatTypes type, int tenPower, int numDecimal) Constructor.
PbNumericDisplayFormat(PbNumericDisplayFormat format) Copy constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
PbNumericDisplayFormat.Format	getFormat() Gets the numerical display format.
void	setFormat() Calls setFormat(PbNumericDisplayFormat.FormatTypes.valueOf( PbNumericDisplayFormat.FormatTypes.AUTO_FORMAT.getValue() ), (int)0, (int)0).
void	setFormat(PbNumericDisplayFormat.FormatTypes type) Calls setFormat(type, (int)0, (int)0).
void	setFormat(PbNumericDisplayFormat.FormatTypes type, int tenPower) Calls setFormat(type, tenPower, (int)0).
void	setFormat(PbNumericDisplayFormat.FormatTypes type, int tenPower, int numDecimal) Sets the numerical display format.

Methods inherited from class com.openinventor.meshviz.graph.PbBase

enableConnection, isConnectionEnabled, touch

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AUTO_FORMAT

@Deprecated
public static final int AUTO_FORMAT

Deprecated. Use PbNumericDisplayFormat.FormatTypes.AUTO_FORMAT instead.

FLOAT_FORMAT

@Deprecated
public static final int FLOAT_FORMAT

Deprecated. Use PbNumericDisplayFormat.FormatTypes.FLOAT_FORMAT instead.

INTEGER_FORMAT

@Deprecated
public static final int INTEGER_FORMAT

Deprecated. Use PbNumericDisplayFormat.FormatTypes.INTEGER_FORMAT instead.

Constructor Detail

PbNumericDisplayFormat

public PbNumericDisplayFormat(PbNumericDisplayFormat.FormatTypes type)

Calls PbNumericDisplayFormat(type, (int)0, (int)0).

PbNumericDisplayFormat

public PbNumericDisplayFormat(PbNumericDisplayFormat.FormatTypes type,
                              int tenPower)

Calls PbNumericDisplayFormat(type, tenPower, (int)0).

PbNumericDisplayFormat

public PbNumericDisplayFormat()

Calls PbNumericDisplayFormat(PbNumericDisplayFormat.FormatTypes.valueOf( PbNumericDisplayFormat.FormatTypes.AUTO_FORMAT.getValue() ), (int)0, (int)0).

PbNumericDisplayFormat

public PbNumericDisplayFormat(PbNumericDisplayFormat format)

Copy constructor.

PbNumericDisplayFormat

public PbNumericDisplayFormat(PbNumericDisplayFormat.FormatTypes type,
                              int tenPower,
                              int numDecimal)

Constructor.

Method Detail

setFormat

public void setFormat(PbNumericDisplayFormat.FormatTypes type,
                      int tenPower)

Calls setFormat(type, tenPower, (int)0).

setFormat

public void setFormat(PbNumericDisplayFormat.FormatTypes type)

Calls setFormat(type, (int)0, (int)0).

setFormat

public void setFormat()

Calls setFormat(PbNumericDisplayFormat.FormatTypes.valueOf( PbNumericDisplayFormat.FormatTypes.AUTO_FORMAT.getValue() ), (int)0, (int)0).

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

getFormat

public PbNumericDisplayFormat.Format getFormat()

Gets the numerical display format.

setFormat

public void setFormat(PbNumericDisplayFormat.FormatTypes type,
                      int tenPower,
                      int numDecimal)

Sets the numerical display format. If the format is AUTO_FORMAT, numDecimal and tenPower are useless. If the format is FLOAT_FORMAT, numDecimal indicates the number of decimals placed after the decimal point and tenPower is the power of ten divisor. If the format is INTEGER_FORMAT, numDecimal is useless.