|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface INumericFieldFormat
This interface describes how a NumericFormat property shown by a FieldObject
object should be formatted if the FieldObject
object is being
used to display numeric data. To access this object, use the following method:
If the field is not being used to represent a NumericFormat property, and you
modify this object, your changes will be ignored and discarded.
FieldFormat fieldFormat = fieldObject.getFieldFormat();
INumericFieldFormat numericFormat = fieldFormat.getNumericFormat();
Method Summary | |
---|---|
boolean |
getAllowFieldClipping()
|
NumericFieldFormatConditionFormulas |
getConditionFormulas()
Returns the condition formulas used to override the numeric field's format settings. |
CurrencyPositionFormat |
getCurrencyPosition()
Returns the position of the currency symbol. |
java.lang.String |
getCurrencySymbol()
Returns the currency symbol. |
CurrencySymbolType |
getCurrencySymbolFormat()
Returns the format of the currency symbol. |
java.lang.String |
getDecimalSymbol()
Returns the symbol of the decimal operator. |
boolean |
getDisplayReverseSign()
Returns true if the sign is reversed for display, false otherwise. |
boolean |
getEnableSuppressIfZero()
Returns true if nothing is printed when the value is zero, false if
when the number is zero, zero is printed. |
boolean |
getEnableUseLeadZero()
Returns true if a zero will be included before the decimal point, false
otherwise. |
int |
getNDecimalPlaces()
Returns the number of decimal places. |
NegativeType |
getNegativeFormat()
Returns the manner in which negative values appear. |
boolean |
getOneCurrencySymbolPerPage()
Returns true if a currency symbol is displayed only once per page, false
if a currency is displayed for every instance on the page. |
RoundingType |
getRoundingFormat()
Returns the number of decimal places to round the number to. |
boolean |
getThousandsSeparator()
Returns true if a thousandths separator is inserted for numbers over 999,
false otherwise. |
java.lang.String |
getThousandSymbol()
Returns the symbol of the thousandths separator. |
boolean |
getUseAccountingFormat()
|
java.lang.String |
getZeroValueString()
Returns the zero value that will be displayed. |
void |
setAllowFieldClipping(boolean bAllowFieldClipping)
|
void |
setConditionFormulas(NumericFieldFormatConditionFormulas conditionFormulas)
Sets the condition formulas used to override the numeric field's format settings. |
void |
setCurrencyPosition(CurrencyPositionFormat currencyPosition)
Sets the position of the currency symbol. |
void |
setCurrencySymbol(java.lang.String currencySymbol)
Sets the currency symbol. |
void |
setCurrencySymbolFormat(CurrencySymbolType currencySymbolFormat)
Sets the format of the currency symbol. |
void |
setDecimalSymbol(java.lang.String decimalSymbol)
Sets the symbol of the decimal operator. |
void |
setDisplayReverseSign(boolean displayReverseSign)
Sets whether the sign is reversed for display. |
void |
setEnableSuppressIfZero(boolean enableSuppressIfZero)
Sets whether nothing is printed when the value is zero. |
void |
setEnableUseLeadZero(boolean enableUseLeadZero)
Sets whether a zero will be included before the decimal point. |
void |
setNDecimalPlaces(int nDecimalPlaces)
Sets the number of decimal places. |
void |
setNegativeFormat(NegativeType negativeFormat)
Sets the manner in which negative values appear. |
void |
setOneCurrencySymbolPerPage(boolean oneCurrencySymbolPerPage)
Sets whether a currency symbol is displayed only once per page. |
void |
setRoundingFormat(RoundingType roundingFormat)
Sets the number of decimal places to round the number to. |
void |
setThousandsSeparator(boolean thousandsSeparator)
Sets whether a thousandths separator is inserted for numbers over 999. |
void |
setThousandSymbol(java.lang.String thousandSymbol)
Sets the symbol of the thousandths separator. |
void |
setUseAccountingFormat(boolean bUseAccountingFormat)
|
void |
setZeroValueString(java.lang.String zeroValueString)
Sets the zero value that will be displayed. |
Method Detail |
---|
NumericFieldFormatConditionFormulas getConditionFormulas()
Returns the condition formulas used to override the numeric field's format settings.
NumericFieldFormatConditionFormulas
object containing
the condition formulas used to override the numeric field's format settings.CurrencyPositionFormat getCurrencyPosition()
Returns the position of the currency symbol.
CurrencyPositionFormat
that specifies the position of
the currency symbol.java.lang.String getCurrencySymbol()
Returns the currency symbol.
String
that specifies the currency symbol.CurrencySymbolType getCurrencySymbolFormat()
Returns the format of the currency symbol.
CurrencySymbolType
that specifies the format of the currency symbol.java.lang.String getDecimalSymbol()
Returns the symbol of the decimal operator.
String
that specifies the symbol of the decimal operator.boolean getDisplayReverseSign()
Returns true
if the sign is reversed for display, false
otherwise.
true
if the sign is reversed for display, false
otherwise.boolean getEnableSuppressIfZero()
Returns true
if nothing is printed when the value is zero, false
if
when the number is zero, zero is printed.
true
if nothing is printed when the value is zero, false
if
when the number is zero, zero is printed.boolean getEnableUseLeadZero()
Returns true
if a zero will be included before the decimal point, false
otherwise.
true
if a zero will be included before the decimal point, false
otherwise.boolean getOneCurrencySymbolPerPage()
Returns true
if a currency symbol is displayed only once per page, false
if a currency is displayed for every instance on the page.
true
if a currency symbol is displayed only once per page, false
if a currency is displayed for every instance on the page.int getNDecimalPlaces()
Returns the number of decimal places.
int
that specifies the number of decimal places.NegativeType getNegativeFormat()
Returns the manner in which negative values appear.
NegativeType
object that specifies the manner in which negative
values appear.RoundingType getRoundingFormat()
Returns the number of decimal places to round the number to.
RoundingType
object that specifies the number of decimal places to
round the number to.boolean getThousandsSeparator()
Returns true
if a thousandths separator is inserted for numbers over 999,
false
otherwise.
true
if a thousandths separator is inserted for numbers over 999,
false
otherwise.java.lang.String getThousandSymbol()
Returns the symbol of the thousandths separator.
String
that specifies the symbol of the thousandths separator.java.lang.String getZeroValueString()
Returns the zero value that will be displayed.
String
containing the zero value.boolean getAllowFieldClipping()
boolean getUseAccountingFormat()
void setConditionFormulas(NumericFieldFormatConditionFormulas conditionFormulas)
Sets the condition formulas used to override the numeric field's format settings.
conditionFormulas
- A NumericFieldFormatConditionFormulas
object containing
the condition formulas used to override the numeric field's format settings.void setCurrencyPosition(CurrencyPositionFormat currencyPosition)
Sets the position of the currency symbol.
currencyPosition
- A CurrencyPositionFormat
that specifies the position of
the currency symbol.void setCurrencySymbol(java.lang.String currencySymbol)
Sets the currency symbol.
currencySymbol
- A String
that specifies the currency symbol.void setCurrencySymbolFormat(CurrencySymbolType currencySymbolFormat)
Sets the format of the currency symbol.
currencySymbolFormat
- A CurrencySymbolType
that specifies the format of the
currency symbol.void setDecimalSymbol(java.lang.String decimalSymbol)
Sets the symbol of the decimal operator.
decimalSymbol
- A String
that specifies the symbol of the decimal operator.void setDisplayReverseSign(boolean displayReverseSign)
Sets whether the sign is reversed for display.
displayReverseSign
- true
if the sign is reversed for display,
false
otherwise.void setEnableSuppressIfZero(boolean enableSuppressIfZero)
Sets whether nothing is printed when the value is zero.
enableSuppressIfZero
- true
if nothing is printed when the value is zero,
false
if when the number is zero, zero is printed.void setEnableUseLeadZero(boolean enableUseLeadZero)
Sets whether a zero will be included before the decimal point.
enableUseLeadZero
- true
if a zero will be included before the decimal
point, false
otherwise.void setOneCurrencySymbolPerPage(boolean oneCurrencySymbolPerPage)
Sets whether a currency symbol is displayed only once per page.
oneCurrencySymbolPerPage
- true
if a currency symbol is displayed only once per page, false
if a currency is displayed for every instance on the page.void setNDecimalPlaces(int nDecimalPlaces)
Sets the number of decimal places.
nDecimalPlaces
- An int
that specifies the number of decimal places.void setNegativeFormat(NegativeType negativeFormat)
Sets the manner in which negative values appear.
negativeFormat
- A NegativeType
object that specifies the manner in which
negative values appear.void setRoundingFormat(RoundingType roundingFormat)
Sets the number of decimal places to round the number to.
roundingFormat
- A RoundingType
object that specifies the number of decimal places to
round the number to.void setThousandsSeparator(boolean thousandsSeparator)
Sets whether a thousandths separator is inserted for numbers over 999.
thousandsSeparator
- true
if a thousandths separator is inserted for numbers over 999,
false
otherwise.void setThousandSymbol(java.lang.String thousandSymbol)
Sets the symbol of the thousandths separator.
thousandSymbol
- A String
that specifies the symbol of the thousandths separator.void setZeroValueString(java.lang.String zeroValueString)
Sets the zero value that will be displayed.
zeroValueString
- A String
containing the zero value.void setAllowFieldClipping(boolean bAllowFieldClipping)
void setUseAccountingFormat(boolean bUseAccountingFormat)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |