Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.2.0)

E17492-03


oracle.adf.view.faces.bi.component.util
Class NumberFormat

java.lang.Object
  extended by oracle.adf.view.faces.bi.component.BIComplexAttributeBase
      extended by oracle.adf.view.faces.bi.component.util.NumberFormat

All Implemented Interfaces:
javax.faces.component.StateHolder

Deprecated. The NumberFormat class can be used to format number. It is designed to support oracle patterns. It is recommended that you use org.apache.myfaces.trinidad.convert.NumberConverter which supports java format patterns.

public class NumberFormat
extends BIComplexAttributeBase

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey CONVERTER_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey CUR_CODE_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey CUR_SYM_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey DEC_SEP_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey DECIMAL_DIGIT_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey LEADING_ZERO_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey NEG_CUR_FMT_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey NEG_NUM_FMT_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey NUMBER_FORMAT_STRING_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey NUMBER_FORMAT_TYPE_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey NUMBER_TYPE_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey POS_CUR_FMT_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey POS_NUM_FMT_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey SCALE_DOWN_BILL_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey SCALE_DOWN_MILL_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey SCALE_DOWN_QUADRILL_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey SCALE_DOWN_THOU_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey SCALE_DOWN_TRILL_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey SCALE_FACTOR_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.PropertyKey THOU_SEP_KEY
          Deprecated.  
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
          Deprecated.  

 

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
ID_KEY, m_parent, TRANSIENT_KEY

 

Constructor Summary
NumberFormat()
          Deprecated.  
NumberFormat(ViewFormat viewFormat)
          Deprecated.  

 

Method Summary
 void copyProperties(ViewFormat viewFormat, UIDataView view)
          Deprecated.  
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
          Deprecated.  
 javax.faces.convert.Converter getConverter()
          Deprecated. use related numberFormat attributes instead
 java.lang.String getCurrencyCode()
          Deprecated. Retrieves the ISOCurrency code string that indicates a currency value.
 java.lang.String getCurrencySymbol()
          Deprecated. Retrieves the character or String that indicates a currency value.
 int getDecimalDigit()
          Deprecated. Retrieves the number of digits that appear to the right of the decimal in a number.
 char getDecimalSeparator()
          Deprecated. Retrieves the character or String that separates the integer and decimal parts of numbers.
 int getNegCurFmt()
          Deprecated. Retrieves the character or String that indicates a negative currency value.
 int getNegNumFmt()
          Deprecated. Retrieves the character or String that indicates a negative number value.
 java.lang.String getNumberFormatString()
          Deprecated. Retrieves the number format string.
 int getNumberFormatType()
          Deprecated. Retrieves the number format type associated with the NumberFormatString property.
 int getNumberType()
          Deprecated. Retrieves the type of the number, such as general, currency, or percent.
 int getPosCurFmt()
          Deprecated. Retrieves the character or String that indicates a positive currency value.
 int getPosNumFmt()
          Deprecated. Retrieves the character or String that indicates a positive number value.
 java.lang.String getScaleDownBillions()
          Deprecated. Retrieves the character or String that represents the abbreviation for billions.
 java.lang.String getScaleDownMillions()
          Deprecated. Retrieves the character or String that represents the abbreviation for millions.
 java.lang.String getScaleDownQuadrillions()
          Deprecated. Retrieves the character or String that represents the abbreviation for quadrillions.
 java.lang.String getScaleDownThousands()
          Deprecated. Retrieves the character or String that represents the abbreviation for thousands.
 java.lang.String getScaleDownTrillions()
          Deprecated. Retrieves the character or String that represents the abbreviation for trillions.
 int getScaleFactor()
          Deprecated. Retrieves the amount that a number is abbreviated.
 char getThousandSeparator()
          Deprecated. Retrieves the character or String that separates thousands in number values.
 boolean isLeadingZero()
          Deprecated. Indicates whether numbers that fall between 1.0 and -1.0 are displayed with leading zeros.
 void setConverter(javax.faces.convert.Converter converter)
          Deprecated. use related numberFormat attributes instead
 void setCurrencyCode(java.lang.String sCurrencyCode)
          Deprecated. Specifies ISOCurrency code string that indicates a currency value.
 void setCurrencySymbol(java.lang.String sCurrencySymbol)
          Deprecated. Specifies the character or String that indicates a currency value.
 void setDecimalDigit(int iDecimalDigit)
          Deprecated. Specifies the number of digits that appear to the right of the decimal in a number.
 void setDecimalSeparator(char cDecimalSeparator)
          Deprecated. Specifies the character or String that separates the integer and decimal parts of numbers.
 void setLeadingZero(boolean bLeadingZero)
          Deprecated. Specifies whether numbers that fall between 1.0 and -1.0 are displayed with leading zeros.
 void setNegCurFmt(int iNegCurFmt)
          Deprecated. Specifies the character or String that indicates a negative currency value.
 void setNegCurFmt(java.lang.String iNegCurFmt)
          Deprecated. Specifies the character or String that indicates a negative currency value.
 void setNegNumFmt(int iNegNumFmt)
          Deprecated. Specifies the character or String that indicates a negative number value.
 void setNegNumFmt(java.lang.String iNegNumFmt)
          Deprecated. Specifies the format for negative numbers.
 void setNumberFormatString(java.lang.String strNumberFormatString)
          Deprecated. Specifies the number format string of type specified in NumberFormatType property.
 void setNumberFormatType(int nNumberFormatType)
          Deprecated. Specifies the number format type associated with the NumberFormatString property.
 void setNumberType(int iNumberType)
          Deprecated. Specifies the type of the number, such as general, currency, or percent.
 void setNumberType(java.lang.String iNumberType)
          Deprecated. Specifies the kind of number to be formatted.
 void setPosCurFmt(int iPosCurFmt)
          Deprecated. Specifies the character or String that indicates a positive currency value.
 void setPosCurFmt(java.lang.String iPosCurFmt)
          Deprecated. Specifies the character or String that indicates a positive currency value.
 void setPosNumFmt(int iPosNumFmt)
          Deprecated. Specifies the character or String that indicates a positive number value.
 void setPosNumFmt(java.lang.String iPosNumFmt)
          Deprecated. Specifies the format for positive numbers.
 void setScaleDownBillions(java.lang.String sValue)
          Deprecated. Specifies the character or String that represents the abbreviation for billions.
 void setScaleDownMillions(java.lang.String sValue)
          Deprecated. Specifies the character or String that represents the abbreviation for million.
 void setScaleDownQuadrillions(java.lang.String sValue)
          Deprecated. Specifies the character or String that represents the abbreviation for quadrillions.
 void setScaleDownThousands(java.lang.String sValue)
          Deprecated. Specifies the character or String that represents the abbreviation for thousands.
 void setScaleDownTrillions(java.lang.String sValue)
          Deprecated. Specifies the character or String that represents the abbreviation for trillions.
 void setScaleFactor(int iScaleFactor)
          Deprecated. Specifies how much to abbreviate a number.
 void setScaleFactor(java.lang.String iScaleFactor)
          Deprecated. Specifies how much to abbreviate a number.
 void setThousandSeparator(char cThousandSeparator)
          Deprecated. Specifies the character or String that separates thousands in number values.
 ViewFormat toViewFormat(UIDataView view)
          Deprecated.  

 

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, restoreState, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
Deprecated. 

NUMBER_TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey NUMBER_TYPE_KEY
Deprecated. 

THOU_SEP_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey THOU_SEP_KEY
Deprecated. 

DEC_SEP_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DEC_SEP_KEY
Deprecated. 

CUR_SYM_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CUR_SYM_KEY
Deprecated. 

CUR_CODE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CUR_CODE_KEY
Deprecated. 

LEADING_ZERO_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LEADING_ZERO_KEY
Deprecated. 

DECIMAL_DIGIT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DECIMAL_DIGIT_KEY
Deprecated. 

POS_NUM_FMT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey POS_NUM_FMT_KEY
Deprecated. 

NEG_NUM_FMT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey NEG_NUM_FMT_KEY
Deprecated. 

POS_CUR_FMT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey POS_CUR_FMT_KEY
Deprecated. 

NEG_CUR_FMT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey NEG_CUR_FMT_KEY
Deprecated. 

SCALE_FACTOR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCALE_FACTOR_KEY
Deprecated. 

SCALE_DOWN_THOU_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCALE_DOWN_THOU_KEY
Deprecated. 

SCALE_DOWN_MILL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCALE_DOWN_MILL_KEY
Deprecated. 

SCALE_DOWN_BILL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCALE_DOWN_BILL_KEY
Deprecated. 

SCALE_DOWN_TRILL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCALE_DOWN_TRILL_KEY
Deprecated. 

SCALE_DOWN_QUADRILL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCALE_DOWN_QUADRILL_KEY
Deprecated. 

NUMBER_FORMAT_TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey NUMBER_FORMAT_TYPE_KEY
Deprecated. 

NUMBER_FORMAT_STRING_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey NUMBER_FORMAT_STRING_KEY
Deprecated. 

CONVERTER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONVERTER_KEY
Deprecated. 

Constructor Detail

NumberFormat

public NumberFormat()
Deprecated. 

NumberFormat

public NumberFormat(ViewFormat viewFormat)
Deprecated. 
For internal use only. Application developers should not use this
Construct a NumberFormat from a ViewFormat

Method Detail

getNumberType

public int getNumberType()
Deprecated. 
Retrieves the type of the number, such as general, currency, or percent. The default type is a general number, NUMTYPE_GENERAL. The default value is used when no value has been specified.
Returns:
The constant that represents the type of the number, such as general, currency, or percent.
See Also:
BaseViewFormat.NUMTYPE_GENERAL, BaseViewFormat.NUMTYPE_CURRENCY, BaseViewFormat.NUMTYPE_PERCENT

setNumberType

public void setNumberType(int iNumberType)
Deprecated. 
Specifies the type of the number, such as general, currency, or percent. The default type is a general number, NUMTYPE_GENERAL. The default value is used when no value has been specified.
Parameters:
iNumberType - The constant that represents the type of the number, such as general, currency, or percent. Valid constants are listed in the See Also section.
See Also:
BaseViewFormat.NUMTYPE_GENERAL, BaseViewFormat.NUMTYPE_CURRENCY, BaseViewFormat.NUMTYPE_PERCENT

setNumberType

public void setNumberType(java.lang.String iNumberType)
Deprecated. 
Specifies the kind of number to be formatted.
Parameters:
iNumberType - Valid values are:
  • NUMTYPE_GENERAL - (Default) specifies the value as a numerical value.
  • NUMTYPE_CURRENCY - specifies the value as a currency.
  • NUMTYPE_PERCENT - specifies the value as a percentage.

setThousandSeparator

public void setThousandSeparator(char cThousandSeparator)
Deprecated. 
Specifies the character or String that separates thousands in number values. The default is THOU_SEP_BY_LOCALE, which means that the thousands separator is based on the locale.
Parameters:
cThousandSeparator - The character or String that separates thousands in number values.
See Also:
BaseViewFormat.THOU_SEP_BY_LOCALE

getThousandSeparator

public char getThousandSeparator()
Deprecated. 
Retrieves the character or String that separates thousands in number values. The default is THOU_SEP_BY_LOCALE, which means that the thousands separator is based on the locale.
Returns:
The character or String that separates thousands in number values.
See Also:
BaseViewFormat.THOU_SEP_BY_LOCALE

getDecimalSeparator

public char getDecimalSeparator()
Deprecated. 
Retrieves the character or String that separates the integer and decimal parts of numbers. The default is DEC_SEP_BY_LOCALE, which means the decimal separator is based on the locale.
Returns:
The character or String that separates the integer and decimal parts of numbers.

setDecimalSeparator

public void setDecimalSeparator(char cDecimalSeparator)
Deprecated. 
Specifies the character or String that separates the integer and decimal parts of numbers. The default is DEC_SEP_BY_LOCALE, which means that the decimal separator is based on the locale.
Parameters:
cDecimalSeparator - The character or String that separates the integer and decimal parts of numbers.

getCurrencySymbol

public java.lang.String getCurrencySymbol()
Deprecated. 
Retrieves the character or String that indicates a currency value.
Returns:
The character or String that indicates a currency value.

setCurrencySymbol

public void setCurrencySymbol(java.lang.String sCurrencySymbol)
Deprecated. 
Specifies the character or String that indicates a currency value.
Parameters:
sCurrencySymbol - The character or String that indicates a currency value

getCurrencyCode

public java.lang.String getCurrencyCode()
Deprecated. 
Retrieves the ISOCurrency code string that indicates a currency value.
Returns:
The ISOCurrency code string that indicates a currency value.

setCurrencyCode

public void setCurrencyCode(java.lang.String sCurrencyCode)
Deprecated. 
Specifies ISOCurrency code string that indicates a currency value.
Parameters:
sCurrencyCode - The ISOCurrency code string that indicates a currency value

isLeadingZero

public boolean isLeadingZero()
Deprecated. 
Indicates whether numbers that fall between 1.0 and -1.0 are displayed with leading zeros. The default return value for this method is true. The default value is used when no value has been explicitly set.
Returns:
true if the numbers that fall between 1.0 and -1.0 are displayed with leading zeros, false if they are not displayed with leading zeros.

setLeadingZero

public void setLeadingZero(boolean bLeadingZero)
Deprecated. 
Specifies whether numbers that fall between 1.0 and -1.0 are displayed with leading zeros. The default return value for this method is true. The default value is used when no value has been explicitly set. This method also sets the LeadingZeroUsed property to true.
Parameters:
bLeadingZero - true to display leading zeros in front of the numbers that fall between 1.0 and -1.0, false to display them without leading zeros.

setDecimalDigit

public void setDecimalDigit(int iDecimalDigit)
Deprecated. 
Specifies the number of digits that appear to the right of the decimal in a number.
Parameters:
iDecimalDigit - The number of digits that appear to the right of the decimal in a number.

getDecimalDigit

public int getDecimalDigit()
Deprecated. 
Retrieves the number of digits that appear to the right of the decimal in a number.
Returns:
The number of digits that appear to the right of the decimal in a number.

getPosNumFmt

public int getPosNumFmt()
Deprecated. 
Retrieves the character or String that indicates a positive number value. The default value is POS_NUMFMT_BY_LOCALE, which means that the positive number format is based on locale.
Returns:
The constant that represents a positive number format.
See Also:
BaseViewFormat.POS_NUMFMT_BY_LOCALE, BaseViewFormat.POS_NUMFMT_NUM, BaseViewFormat.POS_NUMFMT_NUM_POS, BaseViewFormat.POS_NUMFMT_POS_NUM

setPosNumFmt

public void setPosNumFmt(int iPosNumFmt)
Deprecated. 
Specifies the character or String that indicates a positive number value. The default value is POS_NUMFMT_BY_LOCALE, which means that the positive number format is based on locale.
Parameters:
iPosNumFmt - The constant that represents a positive number format. Valid constants are listed in the See Also section.
See Also:
BaseViewFormat.POS_NUMFMT_BY_LOCALE, BaseViewFormat.POS_NUMFMT_NUM, BaseViewFormat.POS_NUMFMT_NUM_POS, BaseViewFormat.POS_NUMFMT_POS_NUM

setPosNumFmt

public void setPosNumFmt(java.lang.String iPosNumFmt)
Deprecated. 
Specifies the format for positive numbers. Valid values are:
Parameters:
iPosNumFmt - The constant that represents a positive number format. Valid constants are listed in the See Also section.
  • POS_NUMFMT_BY_LOCALE - (Default) Uses locale formatting.
  • POS_NUMFMT_NUM - Displays number without a sign.
  • POS_NUMFMT_NUM_POS - Displays the number followed by a sign.
  • POS_NUMFMT_POS_NUM - Displays a sign followed by the number.

setNegNumFmt

public void setNegNumFmt(int iNegNumFmt)
Deprecated. 
Specifies the character or String that indicates a negative number value. The default value is NEG_NUMFMT_BY_LOCALE, which means that the positive number format is based on locale.
Parameters:
iNegNumFmt - The constant that represents a negative number format. Valid constants are listed in the See Also section.
See Also:
BaseViewFormat.NEG_NUMFMT_BY_LOCALE, BaseViewFormat.NEG_NUMFMT_NEG_NUM, BaseViewFormat.NEG_NUMFMT_NUM_NEG, BaseViewFormat.NEG_NUMFMT_OP_NUM_CP

setNegNumFmt

public void setNegNumFmt(java.lang.String iNegNumFmt)
Deprecated. 
Specifies the format for negative numbers.
Parameters:
iNegNumFmt - Valid values are:
  • NEG_NUMFMT_BY_LOCALE - (Default) Uses locale formatting.
  • NEG_NUMFMT_NEG_NUM - Displays number without a sign.
  • NEG_NUMFMT_NUM_NEG - Displays the number followed by a sign.
  • NEG_NUMFMT_OP_NUM_CP - Displays in the format (1)

getNegNumFmt

public int getNegNumFmt()
Deprecated. 
Retrieves the character or String that indicates a negative number value. The default value is NEG_NUMFMT_BY_LOCALE, which means that the negative number format is based on locale.
Returns:
The constant that represents a negative number format.
See Also:
BaseViewFormat.NEG_NUMFMT_BY_LOCALE, BaseViewFormat.NEG_NUMFMT_NEG_NUM, BaseViewFormat.NEG_NUMFMT_NUM_NEG, BaseViewFormat.NEG_NUMFMT_OP_NUM_CP

getPosCurFmt

public int getPosCurFmt()
Deprecated. 
Retrieves the character or String that indicates a positive currency value. The default value is POS_CURFMT_BY_LOCALE, which means that the positive currency format is based on locale.
Returns:
The constant that represents a positive currency format.
See Also:
BaseViewFormat.POS_CURFMT_BY_LOCALE, BaseViewFormat.POS_CURFMT_CUR_NUM, BaseViewFormat.POS_CURFMT_CUR_NUM_POS, BaseViewFormat.POS_CURFMT_CUR_SPAC_NUM, BaseViewFormat.POS_CURFMT_NUM_CUR, BaseViewFormat.POS_CURFMT_NUM_CUR_POS, BaseViewFormat.POS_CURFMT_NUM_POS_CUR, BaseViewFormat.POS_CURFMT_NUM_SPAC_CUR, BaseViewFormat.POS_CURFMT_NUM_SPAC_CUR_POS, BaseViewFormat.POS_CURFMT_POS_CUR_NUM, BaseViewFormat.POS_CURFMT_POS_CUR_SPAC_NUM, BaseViewFormat.POS_CURFMT_POS_NUM_CUR, BaseViewFormat.POS_CURFMT_POS_NUM_SPAC_CUR

setPosCurFmt

public void setPosCurFmt(int iPosCurFmt)
Deprecated. 
Specifies the character or String that indicates a positive currency value. The default value is POS_CURFMT_BY_LOCALE, which means that the positive currency format is based on locale.
Parameters:
iPosCurFmt - The constant that represents a positive currency format. Valid constants are listed in the See Also section.
See Also:
BaseViewFormat.POS_CURFMT_BY_LOCALE, BaseViewFormat.POS_CURFMT_CUR_NUM, BaseViewFormat.POS_CURFMT_CUR_NUM_POS, BaseViewFormat.POS_CURFMT_CUR_SPAC_NUM, BaseViewFormat.POS_CURFMT_NUM_CUR, BaseViewFormat.POS_CURFMT_NUM_CUR_POS, BaseViewFormat.POS_CURFMT_NUM_POS_CUR, BaseViewFormat.POS_CURFMT_NUM_SPAC_CUR, BaseViewFormat.POS_CURFMT_NUM_SPAC_CUR_POS, BaseViewFormat.POS_CURFMT_POS_CUR_NUM, BaseViewFormat.POS_CURFMT_POS_CUR_SPAC_NUM, BaseViewFormat.POS_CURFMT_POS_NUM_CUR, BaseViewFormat.POS_CURFMT_POS_NUM_SPAC_CUR

setPosCurFmt

public void setPosCurFmt(java.lang.String iPosCurFmt)
Deprecated. 
Specifies the character or String that indicates a positive currency value. The default value is POS_CURFMT_BY_LOCALE, which means that the positive currency format is based on locale.
Parameters:
iPosCurFmt - The constant that represents a positive currency format. Valid constants are listed in the See Also section.
  • POS_CURFMT_BY_LOCALE - (Default) Uses locale formatting.
  • POS_CURFMT_CUR_NUM - Displays the currency symbol followed by the number.
  • POS_CURFMT_CUR_NUM_POS - Displays the number followed by a sign.
  • POS_CURFMT_CUR_SPAC_NUM - Displays the currency symbol, a space, and the number.
  • POS_CURFMT_NUM_CUR - Displays the number followed by a currency symbol.
  • POS_CURFMT_NUM_CUR_POS - Displays the number, a currency symbol, and a sign.
  • POS_CURFMT_NUM_POS_CUR - Displays the number, a sign, and the currency symbol.
  • POS_CURFMT_NUM_SPAC_CUR - Displays the number, a space, and the currency symbol.
  • POS_CURFMT_NUM_SPAC_CUR_POS - Displays the number, a space, the currency symbol, and a sign.
  • POS_CURFMT_POS_CUR_NUM - Displays the currency symbol followed by the number.
  • POS_CURFMT_POS_CUR_SPAC_NUM - Displays the currency symbol, a space, and the number.
  • POS_CURFMT_POS_NUM_CUR - Displays the sign, the number, and a currency symbol.
  • POS_CURFMT_POS_NUM_SPAC_CUR - Displays the number, a space, and the currency symbol.

getNegCurFmt

public int getNegCurFmt()
Deprecated. 
Retrieves the character or String that indicates a negative currency value. The default value is NEG_CURFMT_BY_LOCALE, which means that the negative currency format is based on locale.
Returns:
The constant that represents a negative currency format.
See Also:
BaseViewFormat.NEG_CURFMT_BY_LOCALE, BaseViewFormat.NEG_CURFMT_CUR_NEG_NUM, BaseViewFormat.NEG_CURFMT_CUR_NUM_NEG, BaseViewFormat.NEG_CURFMT_NEG_CUR_NUM, BaseViewFormat.NEG_CURFMT_NEG_NUM_CUR, BaseViewFormat.NEG_CURFMT_NUM_CUR_NEG, BaseViewFormat.NEG_CURFMT_NUM_NEG_CUR, BaseViewFormat.NEG_CURFMT_OP_CUR_NUM_CP, BaseViewFormat.NEG_CURFMT_OP_NUM_CUR_CP, BaseViewFormat.NEG_CURFMT_NEG_CUR_SPAC_NUM, BaseViewFormat.NEG_CURFMT_NEG_NUM_SPAC_CUR, BaseViewFormat.NEG_CURFMT_NUM_SPAC_CUR_NEG

setNegCurFmt

public void setNegCurFmt(int iNegCurFmt)
Deprecated. 
Specifies the character or String that indicates a negative currency value. The default value is NEG_CURFMT_BY_LOCALE, which means that the negative currency format is based on locale.
Parameters:
iNegCurFmt - The constant that represents a negative currency format.
See Also:
BaseViewFormat.NEG_CURFMT_BY_LOCALE, BaseViewFormat.NEG_CURFMT_CUR_NEG_NUM, BaseViewFormat.NEG_CURFMT_CUR_NUM_NEG, BaseViewFormat.NEG_CURFMT_NEG_CUR_NUM, BaseViewFormat.NEG_CURFMT_NEG_NUM_CUR, BaseViewFormat.NEG_CURFMT_NUM_CUR_NEG, BaseViewFormat.NEG_CURFMT_NUM_NEG_CUR, BaseViewFormat.NEG_CURFMT_OP_CUR_NUM_CP, BaseViewFormat.NEG_CURFMT_OP_NUM_CUR_CP, BaseViewFormat.NEG_CURFMT_NEG_CUR_SPAC_NUM, BaseViewFormat.NEG_CURFMT_NEG_NUM_SPAC_CUR, BaseViewFormat.NEG_CURFMT_NUM_SPAC_CUR_NEG

setNegCurFmt

public void setNegCurFmt(java.lang.String iNegCurFmt)
Deprecated. 
Specifies the character or String that indicates a negative currency value. The default value is NEG_CURFMT_BY_LOCALE, which means that the negative currency format is based on locale.
Parameters:
iNegCurFmt - The constant that represents a negative currency format.
  • NEG_CURFMT_BY_LOCALE - (Default) Uses locale formatting.
  • NEG_CURFMT_CUR_NEG_NUM - Displays the currency symbol followed by the number.
  • NEG_CURFMT_CUR_NUM_NEG - Displays the currency symbol, the number, and a sign.
  • NEG_CURFMT_NEG_CUR_NUM - Displays a sign, the currency symbol, and the number.
  • NEG_CURFMT_NEG_NUM_CUR - Displays the number followed by a currency symbol.
  • NEG_CURFMT_NUM_CUR_NEG - Displays the number, a currency symbol, and a sign.
  • NEG_CURFMT_NUM_NEG_CUR - Displays the number, a sign, and the currency symbol.
  • NEG_CURFMT_OP_CUR_NUM_CP - Displays in the format ($1)
  • NEG_CURFMT_OP_NUM_CUR_CP - Displays in the format (1$)
  • NEG_CURFMT_NEG_CUR_SPAC_NUM - Displays the currency symbol, a space, and the number.
  • NEG_CURFMT_NEG_NUM_SPAC_CUR - Displays the number, a space, and the currency symbol.
  • NEG_CURFMT_NUM_SPAC_CUR_NEG - Displays the number, a space, the currency symbol, and a sign.

getScaleFactor

public int getScaleFactor()
Deprecated. 
Retrieves the amount that a number is abbreviated. For example, if the data is 153,000, but the view displays it as 153K, then the ScaleFactor property is set to SCALEFACTOR_THOUSANDS.

The default is DEFAULT_SCALE_FACTOR, which returns no scaling. The decimal point is not moved. The default value is used when no scale factor value has been specified.

Returns:
A constant that represents the scale by which to abbreviate a number. Constants are listed in the See Also section.
See Also:
BaseViewFormat.DEFAULT_SCALE_FACTOR, BaseViewFormat.SCALEFACTOR_NONE, BaseViewFormat.SCALEFACTOR_THOUSANDS, BaseViewFormat.SCALEFACTOR_MILLIONS, BaseViewFormat.SCALEFACTOR_BILLIONS, BaseViewFormat.SCALEFACTOR_TRILLIONS, BaseViewFormat.SCALEFACTOR_QUADRILLIONS

setScaleFactor

public void setScaleFactor(int iScaleFactor)
Deprecated. 
Specifies how much to abbreviate a number. For example, if you set ScaleFactor to SCALEFACTOR_THOUSANDS, the view displays the number as thousands, and a number such as 153,000 appears as 153K (assuming the default value of the ScaleDownThousands property).

The default is DEFAULT_SCALE_FACTOR, which specifies no scaling. The default value is used when no scale factor value has been specified. This method also sets the ScaleFactorUsed property to true.

Parameters:
iScaleFactor - A constant that represents the scale by which to abbreviate a number. Valid constants are listed in the See Also section.
See Also:
BaseViewFormat.DEFAULT_SCALE_FACTOR, BaseViewFormat.SCALEFACTOR_NONE, BaseViewFormat.SCALEFACTOR_THOUSANDS, BaseViewFormat.SCALEFACTOR_MILLIONS, BaseViewFormat.SCALEFACTOR_BILLIONS, BaseViewFormat.SCALEFACTOR_TRILLIONS, BaseViewFormat.SCALEFACTOR_QUADRILLIONS

setScaleFactor

public void setScaleFactor(java.lang.String iScaleFactor)
Deprecated. 
Specifies how much to abbreviate a number. For example, if you set ScaleFactor to SCALEFACTOR_THOUSANDS, the view displays the number as thousands, and a number such as 153,000 appears as 153K (assuming the default value of the ScaleDownThousands property).

The default is DEFAULT_SCALE_FACTOR, which specifies no scaling. The default value is used when no scale factor value has been specified. This method also sets the ScaleFactorUsed property to true.

Parameters:
iScaleFactor - A constant that represents the scale by which to abbreviate a number. Valid constants are
  • SCALEFACTOR_NONE - Performs no scaling.
  • SCALEFACTOR_THOUSANDS - Scales by thousands.
  • SCALEFACTOR_MILLIONS - Scales by millions.
  • SCALEFACTOR_BILLIONS - Scales by billions.
  • SCALEFACTOR_TRILLIONS - Scales by trillions.
  • SCALEFACTOR_QUADRILLIONS - Scales by quadrillions.

setScaleDownThousands

public void setScaleDownThousands(java.lang.String sValue)
Deprecated. 
Specifies the character or String that represents the abbreviation for thousands. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for thousands is based on locale.
Parameters:
sValue - The the character or String that represents the abbreviation for thousands.
See Also:
BaseViewFormat.SCALE_DOWN_SYMBOL_BY_LOCALE

getScaleDownThousands

public java.lang.String getScaleDownThousands()
Deprecated. 
Retrieves the character or String that represents the abbreviation for thousands. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for thousands is based on locale.
Returns:
The character or String that represents the abbreviation for thousands.
See Also:
BaseViewFormat.SCALE_DOWN_SYMBOL_BY_LOCALE

setScaleDownMillions

public void setScaleDownMillions(java.lang.String sValue)
Deprecated. 
Specifies the character or String that represents the abbreviation for million. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for millions is based on locale.
Parameters:
sValue - The the character or String that represents the abbreviation for millions.
See Also:
BaseViewFormat.SCALE_DOWN_SYMBOL_BY_LOCALE

getScaleDownMillions

public java.lang.String getScaleDownMillions()
Deprecated. 
Retrieves the character or String that represents the abbreviation for millions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for millions is based on locale.
Returns:
The character or String that represents the abbreviation for millions.
See Also:
BaseViewFormat.SCALE_DOWN_SYMBOL_BY_LOCALE

getScaleDownBillions

public java.lang.String getScaleDownBillions()
Deprecated. 
Retrieves the character or String that represents the abbreviation for billions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for billions is based on locale.
Returns:
The character or String that represents the abbreviation for billions.
See Also:
BaseViewFormat.SCALE_DOWN_SYMBOL_BY_LOCALE

setScaleDownBillions

public void setScaleDownBillions(java.lang.String sValue)
Deprecated. 
Specifies the character or String that represents the abbreviation for billions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for billions is based on locale.
Parameters:
sValue - The the character or String that represents the abbreviation for billions.
See Also:
BaseViewFormat.SCALE_DOWN_SYMBOL_BY_LOCALE

getScaleDownTrillions

public java.lang.String getScaleDownTrillions()
Deprecated. 
Retrieves the character or String that represents the abbreviation for trillions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for trillions is based on locale.
Returns:
The character or String that represents the abbreviation for trillions.
See Also:
BaseViewFormat.SCALE_DOWN_SYMBOL_BY_LOCALE

setScaleDownTrillions

public void setScaleDownTrillions(java.lang.String sValue)
Deprecated. 
Specifies the character or String that represents the abbreviation for trillions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for trillions is based on locale.
Parameters:
sValue - The the character or String that represents the abbreviation for trillions.
See Also:
BaseViewFormat.SCALE_DOWN_SYMBOL_BY_LOCALE

getScaleDownQuadrillions

public java.lang.String getScaleDownQuadrillions()
Deprecated. 
Retrieves the character or String that represents the abbreviation for quadrillions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for quadrillions is based on locale.
Returns:
The character or String that represents the abbreviation for quadrillions.
See Also:
BaseViewFormat.SCALE_DOWN_SYMBOL_BY_LOCALE

setScaleDownQuadrillions

public void setScaleDownQuadrillions(java.lang.String sValue)
Deprecated. 
Specifies the character or String that represents the abbreviation for quadrillions. The default value is SCALE_DOWN_SYMBOL_BY_LOCALE, which means that the abbreviation for quadrillion is based on locale.
Parameters:
sValue - The the character or String that represents the abbreviation for quadrillions.
See Also:
BaseViewFormat.SCALE_DOWN_SYMBOL_BY_LOCALE

setNumberFormatType

public void setNumberFormatType(int nNumberFormatType)
Deprecated. 
Specifies the number format type associated with the NumberFormatString property. The valid values are OEO_PATTERN_STR and ORACLE_PATTERN_STR.
Parameters:
nNumberFormatType - A int which contains the number format type.
See Also:
BaseViewFormat.OEO_PATTERN_STR, BaseViewFormat.ORACLE_PATTERN_STR

getNumberFormatType

public int getNumberFormatType()
Deprecated. 
Retrieves the number format type associated with the NumberFormatString property.
Returns:
the number format type

setNumberFormatString

public void setNumberFormatString(java.lang.String strNumberFormatString)
Deprecated. 
Specifies the number format string of type specified in NumberFormatType property.
Parameters:
strNumberFormatString - A String which contains the number format string associated with the ViewFormat.
See Also:
setNumberFormatType(int)

getNumberFormatString

public java.lang.String getNumberFormatString()
Deprecated. 
Retrieves the number format string.
Returns:
String value which represents the number format string.

setConverter

public void setConverter(javax.faces.convert.Converter converter)
Deprecated. use related numberFormat attributes instead
Specifies the Converter that can be used for number formatting instead of specifying other properties on this class.
See Also:
setNumberFormatType(int)

getConverter

public javax.faces.convert.Converter getConverter()
Deprecated. use related numberFormat attributes instead
Retrieves the Converter that is used for number formatting.

toViewFormat

public ViewFormat toViewFormat(UIDataView view)
Deprecated. 
For internal use only. Application developers should not use this

copyProperties

public void copyProperties(ViewFormat viewFormat,
                           UIDataView view)
Deprecated. 
For internal use only. Application developers should not use this
Copy properties from a NumberFormat to a ViewFormat

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Deprecated. 
Specified by:
getBeanType in class BIComplexAttributeBase

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.2.0)

E17492-03


Copyright © 1997, 2012, Oracle. All rights reserved.