com.crystaldecisions.sdk.occa.report.definition
Interface INumericFieldFormat

All Superinterfaces:
IClone
All Known Implementing Classes:
NumericFieldFormat

public interface INumericFieldFormat
extends IClone

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:

 FieldFormat fieldFormat = fieldObject.getFieldFormat();
 INumericFieldFormat numericFormat = fieldFormat.getNumericFormat();
 
If the field is not being used to represent a NumericFormat property, and you modify this object, your changes will be ignored and discarded.


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

getConditionFormulas

NumericFieldFormatConditionFormulas getConditionFormulas()

Returns the condition formulas used to override the numeric field's format settings.

Returns:
A NumericFieldFormatConditionFormulas object containing the condition formulas used to override the numeric field's format settings.

getCurrencyPosition

CurrencyPositionFormat getCurrencyPosition()

Returns the position of the currency symbol.

Returns:
A CurrencyPositionFormat that specifies the position of the currency symbol.

getCurrencySymbol

java.lang.String getCurrencySymbol()

Returns the currency symbol.

Returns:
A String that specifies the currency symbol.

getCurrencySymbolFormat

CurrencySymbolType getCurrencySymbolFormat()

Returns the format of the currency symbol.

Returns:
A CurrencySymbolType that specifies the format of the currency symbol.

getDecimalSymbol

java.lang.String getDecimalSymbol()

Returns the symbol of the decimal operator.

Returns:
A String that specifies the symbol of the decimal operator.

getDisplayReverseSign

boolean getDisplayReverseSign()

Returns true if the sign is reversed for display, false otherwise.

Returns:
true if the sign is reversed for display, false otherwise.

getEnableSuppressIfZero

boolean getEnableSuppressIfZero()

Returns true if nothing is printed when the value is zero, false if when the number is zero, zero is printed.

Returns:
true if nothing is printed when the value is zero, false if when the number is zero, zero is printed.

getEnableUseLeadZero

boolean getEnableUseLeadZero()

Returns true if a zero will be included before the decimal point, false otherwise.

Returns:
true if a zero will be included before the decimal point, false otherwise.

getOneCurrencySymbolPerPage

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.

Returns:
true if a currency symbol is displayed only once per page, false if a currency is displayed for every instance on the page.

getNDecimalPlaces

int getNDecimalPlaces()

Returns the number of decimal places.

Returns:
An int that specifies the number of decimal places.

getNegativeFormat

NegativeType getNegativeFormat()

Returns the manner in which negative values appear.

Returns:
A NegativeType object that specifies the manner in which negative values appear.

getRoundingFormat

RoundingType getRoundingFormat()

Returns the number of decimal places to round the number to.

Returns:
A RoundingType object that specifies the number of decimal places to round the number to.

getThousandsSeparator

boolean getThousandsSeparator()

Returns true if a thousandths separator is inserted for numbers over 999, false otherwise.

Returns:
true if a thousandths separator is inserted for numbers over 999, false otherwise.

getThousandSymbol

java.lang.String getThousandSymbol()

Returns the symbol of the thousandths separator.

Returns:
A String that specifies the symbol of the thousandths separator.

getZeroValueString

java.lang.String getZeroValueString()

Returns the zero value that will be displayed.

Returns:
A String containing the zero value.

getAllowFieldClipping

boolean getAllowFieldClipping()

getUseAccountingFormat

boolean getUseAccountingFormat()

setConditionFormulas

void setConditionFormulas(NumericFieldFormatConditionFormulas conditionFormulas)

Sets the condition formulas used to override the numeric field's format settings.

Parameters:
conditionFormulas - A NumericFieldFormatConditionFormulas object containing the condition formulas used to override the numeric field's format settings.

setCurrencyPosition

void setCurrencyPosition(CurrencyPositionFormat currencyPosition)

Sets the position of the currency symbol.

Parameters:
currencyPosition - A CurrencyPositionFormat that specifies the position of the currency symbol.

setCurrencySymbol

void setCurrencySymbol(java.lang.String currencySymbol)

Sets the currency symbol.

Parameters:
currencySymbol - A String that specifies the currency symbol.

setCurrencySymbolFormat

void setCurrencySymbolFormat(CurrencySymbolType currencySymbolFormat)

Sets the format of the currency symbol.

Parameters:
currencySymbolFormat - A CurrencySymbolType that specifies the format of the currency symbol.

setDecimalSymbol

void setDecimalSymbol(java.lang.String decimalSymbol)

Sets the symbol of the decimal operator.

Parameters:
decimalSymbol - A String that specifies the symbol of the decimal operator.

setDisplayReverseSign

void setDisplayReverseSign(boolean displayReverseSign)

Sets whether the sign is reversed for display.

Parameters:
displayReverseSign - true if the sign is reversed for display, false otherwise.

setEnableSuppressIfZero

void setEnableSuppressIfZero(boolean enableSuppressIfZero)

Sets whether nothing is printed when the value is zero.

Parameters:
enableSuppressIfZero - true if nothing is printed when the value is zero, false if when the number is zero, zero is printed.

setEnableUseLeadZero

void setEnableUseLeadZero(boolean enableUseLeadZero)

Sets whether a zero will be included before the decimal point.

Parameters:
enableUseLeadZero - true if a zero will be included before the decimal point, false otherwise.

setOneCurrencySymbolPerPage

void setOneCurrencySymbolPerPage(boolean oneCurrencySymbolPerPage)

Sets whether a currency symbol is displayed only once per page.

Parameters:
oneCurrencySymbolPerPage - true if a currency symbol is displayed only once per page, false if a currency is displayed for every instance on the page.

setNDecimalPlaces

void setNDecimalPlaces(int nDecimalPlaces)

Sets the number of decimal places.

Parameters:
nDecimalPlaces - An int that specifies the number of decimal places.

setNegativeFormat

void setNegativeFormat(NegativeType negativeFormat)

Sets the manner in which negative values appear.

Parameters:
negativeFormat - A NegativeType object that specifies the manner in which negative values appear.

setRoundingFormat

void setRoundingFormat(RoundingType roundingFormat)

Sets the number of decimal places to round the number to.

Parameters:
roundingFormat - A RoundingType object that specifies the number of decimal places to round the number to.

setThousandsSeparator

void setThousandsSeparator(boolean thousandsSeparator)

Sets whether a thousandths separator is inserted for numbers over 999.

Parameters:
thousandsSeparator - true if a thousandths separator is inserted for numbers over 999, false otherwise.

setThousandSymbol

void setThousandSymbol(java.lang.String thousandSymbol)

Sets the symbol of the thousandths separator.

Parameters:
thousandSymbol - A String that specifies the symbol of the thousandths separator.

setZeroValueString

void setZeroValueString(java.lang.String zeroValueString)

Sets the zero value that will be displayed.

Parameters:
zeroValueString - A String containing the zero value.

setAllowFieldClipping

void setAllowFieldClipping(boolean bAllowFieldClipping)

setUseAccountingFormat

void setUseAccountingFormat(boolean bUseAccountingFormat)