|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.crystaldecisions.sdk.occa.report.definition.NumericFieldFormat
public class NumericFieldFormat
This object describes how a NumericFormat property shown by a FieldObject
object should be formatted if the FieldObject object is being
used to display numeric data. When possible, use the INumericFieldFormat interface.
| Constructor Summary | |
|---|---|
NumericFieldFormat()
|
|
NumericFieldFormat(INumericFieldFormat src)
|
|
NumericFieldFormat(java.util.Locale locale)
|
|
| Method Summary | |
|---|---|
java.lang.Object |
clone(boolean deepClone)
|
void |
copyTo(java.lang.Object destObject,
boolean deepCopy)
|
java.lang.Object |
createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only. |
void |
endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only. |
boolean |
getAllowFieldClipping()
For internal use only |
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()
For internal use only |
java.lang.String |
getZeroValueString()
Returns the zero value that will be displayed. |
boolean |
hasContent(java.lang.Object srcNumericFieldFormat)
|
void |
readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only. |
void |
save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
For internal use only. |
void |
save(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
For internal use only. |
void |
setAllowFieldClipping(boolean bAllowFieldClipping)
For internal use only |
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)
For internal use only |
void |
setZeroValueString(java.lang.String zeroValueString)
Sets the zero value that will be displayed. |
boolean |
skipWritingIdenticalObject()
For internal use only. |
void |
startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public NumericFieldFormat(INumericFieldFormat src)
public NumericFieldFormat()
public NumericFieldFormat(java.util.Locale locale)
| Method Detail |
|---|
public java.lang.Object clone(boolean deepClone)
public void copyTo(java.lang.Object destObject,
boolean deepCopy)
public java.lang.Object createMember(java.lang.String eleName,
org.xml.sax.Attributes attrs,
XMLSerializationContext ctxt,
java.util.Map objState,
boolean[] bLoaded)
For internal use only.
public void endElement(java.lang.String eleName,
java.util.Map objState)
For internal use only.
public NumericFieldFormatConditionFormulas getConditionFormulas()
INumericFieldFormatReturns the condition formulas used to override the numeric field's format settings.
getConditionFormulas in interface INumericFieldFormatNumericFieldFormatConditionFormulas object containing
the condition formulas used to override the numeric field's format settings.public CurrencyPositionFormat getCurrencyPosition()
INumericFieldFormatReturns the position of the currency symbol.
getCurrencyPosition in interface INumericFieldFormatCurrencyPositionFormat that specifies the position of
the currency symbol.public java.lang.String getCurrencySymbol()
INumericFieldFormatReturns the currency symbol.
getCurrencySymbol in interface INumericFieldFormatString that specifies the currency symbol.public CurrencySymbolType getCurrencySymbolFormat()
INumericFieldFormatReturns the format of the currency symbol.
getCurrencySymbolFormat in interface INumericFieldFormatCurrencySymbolType that specifies the format of the currency symbol.public java.lang.String getDecimalSymbol()
INumericFieldFormatReturns the symbol of the decimal operator.
getDecimalSymbol in interface INumericFieldFormatString that specifies the symbol of the decimal operator.public boolean getDisplayReverseSign()
INumericFieldFormat
Returns true if the sign is reversed for display, false otherwise.
getDisplayReverseSign in interface INumericFieldFormattrue if the sign is reversed for display, false otherwise.public boolean getEnableSuppressIfZero()
INumericFieldFormat
Returns true if nothing is printed when the value is zero, false if
when the number is zero, zero is printed.
getEnableSuppressIfZero in interface INumericFieldFormattrue if nothing is printed when the value is zero, false if
when the number is zero, zero is printed.public boolean getEnableUseLeadZero()
INumericFieldFormat
Returns true if a zero will be included before the decimal point, false
otherwise.
getEnableUseLeadZero in interface INumericFieldFormattrue if a zero will be included before the decimal point, false
otherwise.public int getNDecimalPlaces()
INumericFieldFormatReturns the number of decimal places.
getNDecimalPlaces in interface INumericFieldFormatint that specifies the number of decimal places.public NegativeType getNegativeFormat()
INumericFieldFormatReturns the manner in which negative values appear.
getNegativeFormat in interface INumericFieldFormatNegativeType object that specifies the manner in which negative
values appear.public boolean getOneCurrencySymbolPerPage()
INumericFieldFormat
Returns true if a currency symbol is displayed only once per page, false
if a currency is displayed for every instance on the page.
getOneCurrencySymbolPerPage in interface INumericFieldFormattrue if a currency symbol is displayed only once per page, false
if a currency is displayed for every instance on the page.public RoundingType getRoundingFormat()
INumericFieldFormatReturns the number of decimal places to round the number to.
getRoundingFormat in interface INumericFieldFormatRoundingType object that specifies the number of decimal places to
round the number to.public boolean getThousandsSeparator()
INumericFieldFormat
Returns true if a thousandths separator is inserted for numbers over 999,
false otherwise.
getThousandsSeparator in interface INumericFieldFormattrue if a thousandths separator is inserted for numbers over 999,
false otherwise.public java.lang.String getThousandSymbol()
INumericFieldFormatReturns the symbol of the thousandths separator.
getThousandSymbol in interface INumericFieldFormatString that specifies the symbol of the thousandths separator.public java.lang.String getZeroValueString()
INumericFieldFormatReturns the zero value that will be displayed.
getZeroValueString in interface INumericFieldFormatString containing the zero value.public boolean getAllowFieldClipping()
INumericFieldFormat
getAllowFieldClipping in interface INumericFieldFormatpublic boolean getUseAccountingFormat()
INumericFieldFormat
getUseAccountingFormat in interface INumericFieldFormatpublic boolean hasContent(java.lang.Object srcNumericFieldFormat)
public void readElement(java.lang.String eleName,
java.lang.String sVal,
org.xml.sax.Attributes attrs,
java.util.Map objState)
For internal use only.
public void save(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOException
public void save(XMLWriter writer,
java.lang.String sTag,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOException
public void saveContents(XMLWriter writer,
XMLSerializationContext ctxt)
throws java.io.IOException
For internal use only.
java.io.IOExceptionpublic void setConditionFormulas(NumericFieldFormatConditionFormulas conditionFormulas)
INumericFieldFormatSets the condition formulas used to override the numeric field's format settings.
setConditionFormulas in interface INumericFieldFormatconditionFormulas - A NumericFieldFormatConditionFormulas object containing
the condition formulas used to override the numeric field's format settings.public void setCurrencyPosition(CurrencyPositionFormat currencyPosition)
INumericFieldFormatSets the position of the currency symbol.
setCurrencyPosition in interface INumericFieldFormatcurrencyPosition - A CurrencyPositionFormat that specifies the position of
the currency symbol.public void setCurrencySymbol(java.lang.String currencySymbol)
INumericFieldFormatSets the currency symbol.
setCurrencySymbol in interface INumericFieldFormatcurrencySymbol - A String that specifies the currency symbol.public void setCurrencySymbolFormat(CurrencySymbolType currencySymbolFormat)
INumericFieldFormatSets the format of the currency symbol.
setCurrencySymbolFormat in interface INumericFieldFormatcurrencySymbolFormat - A CurrencySymbolType that specifies the format of the
currency symbol.public void setDecimalSymbol(java.lang.String decimalSymbol)
INumericFieldFormatSets the symbol of the decimal operator.
setDecimalSymbol in interface INumericFieldFormatdecimalSymbol - A String that specifies the symbol of the decimal operator.public void setDisplayReverseSign(boolean displayReverseSign)
INumericFieldFormatSets whether the sign is reversed for display.
setDisplayReverseSign in interface INumericFieldFormatdisplayReverseSign - true if the sign is reversed for display,
false otherwise.public void setEnableSuppressIfZero(boolean enableSuppressIfZero)
INumericFieldFormatSets whether nothing is printed when the value is zero.
setEnableSuppressIfZero in interface INumericFieldFormatenableSuppressIfZero - true if nothing is printed when the value is zero,
false if when the number is zero, zero is printed.public void setEnableUseLeadZero(boolean enableUseLeadZero)
INumericFieldFormatSets whether a zero will be included before the decimal point.
setEnableUseLeadZero in interface INumericFieldFormatenableUseLeadZero - true if a zero will be included before the decimal
point, false otherwise.public void setNDecimalPlaces(int nDecimalPlaces)
INumericFieldFormatSets the number of decimal places.
setNDecimalPlaces in interface INumericFieldFormatnDecimalPlaces - An int that specifies the number of decimal places.public void setNegativeFormat(NegativeType negativeFormat)
INumericFieldFormatSets the manner in which negative values appear.
setNegativeFormat in interface INumericFieldFormatnegativeFormat - A NegativeType object that specifies the manner in which
negative values appear.public void setOneCurrencySymbolPerPage(boolean oneCurrencySymbolPerPage)
INumericFieldFormatSets whether a currency symbol is displayed only once per page.
setOneCurrencySymbolPerPage in interface INumericFieldFormatoneCurrencySymbolPerPage - true if a currency symbol is displayed only once per page, false
if a currency is displayed for every instance on the page.public void setRoundingFormat(RoundingType roundingFormat)
INumericFieldFormatSets the number of decimal places to round the number to.
setRoundingFormat in interface INumericFieldFormatroundingFormat - A RoundingType object that specifies the number of decimal places to
round the number to.public void setThousandsSeparator(boolean thousandsSeparator)
INumericFieldFormatSets whether a thousandths separator is inserted for numbers over 999.
setThousandsSeparator in interface INumericFieldFormatthousandsSeparator - true if a thousandths separator is inserted for numbers over 999,
false otherwise.public void setThousandSymbol(java.lang.String thousandSymbol)
INumericFieldFormatSets the symbol of the thousandths separator.
setThousandSymbol in interface INumericFieldFormatthousandSymbol - A String that specifies the symbol of the thousandths separator.public void setZeroValueString(java.lang.String zeroValueString)
INumericFieldFormatSets the zero value that will be displayed.
setZeroValueString in interface INumericFieldFormatzeroValueString - A String containing the zero value.public void setAllowFieldClipping(boolean bAllowFieldClipping)
INumericFieldFormat
setAllowFieldClipping in interface INumericFieldFormatpublic void setUseAccountingFormat(boolean bUseAccountingFormat)
INumericFieldFormat
setUseAccountingFormat in interface INumericFieldFormatpublic boolean skipWritingIdenticalObject()
For internal use only.
public void startElement(java.lang.String eleName,
java.util.Map objState,
org.xml.sax.Attributes attrs)
For internal use only.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||