com.crystaldecisions.sdk.occa.report.definition
Class NumericFieldFormat

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.definition.NumericFieldFormat
All Implemented Interfaces:
INumericFieldFormat, IClone

public class NumericFieldFormat
extends java.lang.Object
implements INumericFieldFormat, IClone

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 doControllerModification(java.lang.Object newObject)
           
 void endElement(java.lang.String eleName, java.util.Map objState)
           For internal use only.
 void enumerateMembers(IMemberVisitor visitor)
           
 boolean getAllowFieldClipping()
           
 NumericFieldFormatConditionFormulas getConditionFormulas()
           Returns the condition formulas used to override the numeric field's format settings.
 ControllableMixin getControllableMixin()
           
 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.
 boolean hasContent(java.lang.Object srcNumericFieldFormat)
           
 boolean isDirectlyControllable()
           
 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)
           
 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.
 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

NumericFieldFormat

public NumericFieldFormat(INumericFieldFormat src)

NumericFieldFormat

public NumericFieldFormat()

NumericFieldFormat

public NumericFieldFormat(java.util.Locale locale)
Method Detail

clone

public java.lang.Object clone(boolean deepClone)

copyTo

public void copyTo(java.lang.Object destObject,
                   boolean deepCopy)

createMember

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.


endElement

public void endElement(java.lang.String eleName,
                       java.util.Map objState)

For internal use only.


getConditionFormulas

public NumericFieldFormatConditionFormulas getConditionFormulas()
Description copied from interface: INumericFieldFormat

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

Specified by:
getConditionFormulas in interface INumericFieldFormat
Returns:
A NumericFieldFormatConditionFormulas object containing the condition formulas used to override the numeric field's format settings.

getCurrencyPosition

public CurrencyPositionFormat getCurrencyPosition()
Description copied from interface: INumericFieldFormat

Returns the position of the currency symbol.

Specified by:
getCurrencyPosition in interface INumericFieldFormat
Returns:
A CurrencyPositionFormat that specifies the position of the currency symbol.

getCurrencySymbol

public java.lang.String getCurrencySymbol()
Description copied from interface: INumericFieldFormat

Returns the currency symbol.

Specified by:
getCurrencySymbol in interface INumericFieldFormat
Returns:
A String that specifies the currency symbol.

getCurrencySymbolFormat

public CurrencySymbolType getCurrencySymbolFormat()
Description copied from interface: INumericFieldFormat

Returns the format of the currency symbol.

Specified by:
getCurrencySymbolFormat in interface INumericFieldFormat
Returns:
A CurrencySymbolType that specifies the format of the currency symbol.

getDecimalSymbol

public java.lang.String getDecimalSymbol()
Description copied from interface: INumericFieldFormat

Returns the symbol of the decimal operator.

Specified by:
getDecimalSymbol in interface INumericFieldFormat
Returns:
A String that specifies the symbol of the decimal operator.

getDisplayReverseSign

public boolean getDisplayReverseSign()
Description copied from interface: INumericFieldFormat

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

Specified by:
getDisplayReverseSign in interface INumericFieldFormat
Returns:
true if the sign is reversed for display, false otherwise.

getEnableSuppressIfZero

public boolean getEnableSuppressIfZero()
Description copied from interface: INumericFieldFormat

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

Specified by:
getEnableSuppressIfZero in interface INumericFieldFormat
Returns:
true if nothing is printed when the value is zero, false if when the number is zero, zero is printed.

getEnableUseLeadZero

public boolean getEnableUseLeadZero()
Description copied from interface: INumericFieldFormat

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

Specified by:
getEnableUseLeadZero in interface INumericFieldFormat
Returns:
true if a zero will be included before the decimal point, false otherwise.

getNDecimalPlaces

public int getNDecimalPlaces()
Description copied from interface: INumericFieldFormat

Returns the number of decimal places.

Specified by:
getNDecimalPlaces in interface INumericFieldFormat
Returns:
An int that specifies the number of decimal places.

getNegativeFormat

public NegativeType getNegativeFormat()
Description copied from interface: INumericFieldFormat

Returns the manner in which negative values appear.

Specified by:
getNegativeFormat in interface INumericFieldFormat
Returns:
A NegativeType object that specifies the manner in which negative values appear.

getOneCurrencySymbolPerPage

public boolean getOneCurrencySymbolPerPage()
Description copied from interface: 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.

Specified by:
getOneCurrencySymbolPerPage in interface 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.

getRoundingFormat

public RoundingType getRoundingFormat()
Description copied from interface: INumericFieldFormat

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

Specified by:
getRoundingFormat in interface INumericFieldFormat
Returns:
A RoundingType object that specifies the number of decimal places to round the number to.

getThousandsSeparator

public boolean getThousandsSeparator()
Description copied from interface: INumericFieldFormat

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

Specified by:
getThousandsSeparator in interface INumericFieldFormat
Returns:
true if a thousandths separator is inserted for numbers over 999, false otherwise.

getThousandSymbol

public java.lang.String getThousandSymbol()
Description copied from interface: INumericFieldFormat

Returns the symbol of the thousandths separator.

Specified by:
getThousandSymbol in interface INumericFieldFormat
Returns:
A String that specifies the symbol of the thousandths separator.

getZeroValueString

public java.lang.String getZeroValueString()
Description copied from interface: INumericFieldFormat

Returns the zero value that will be displayed.

Specified by:
getZeroValueString in interface INumericFieldFormat
Returns:
A String containing the zero value.

getAllowFieldClipping

public boolean getAllowFieldClipping()
Specified by:
getAllowFieldClipping in interface INumericFieldFormat

getUseAccountingFormat

public boolean getUseAccountingFormat()
Specified by:
getUseAccountingFormat in interface INumericFieldFormat

hasContent

public boolean hasContent(java.lang.Object srcNumericFieldFormat)

readElement

public void readElement(java.lang.String eleName,
                        java.lang.String sVal,
                        org.xml.sax.Attributes attrs,
                        java.util.Map objState)

For internal use only.


save

public void save(XMLWriter writer,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

save

public void save(XMLWriter writer,
                 java.lang.String sTag,
                 XMLSerializationContext ctxt)
          throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

saveContents

public void saveContents(XMLWriter writer,
                         XMLSerializationContext ctxt)
                  throws java.io.IOException

For internal use only.

Throws:
java.io.IOException

setConditionFormulas

public void setConditionFormulas(NumericFieldFormatConditionFormulas conditionFormulas)
Description copied from interface: INumericFieldFormat

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

Specified by:
setConditionFormulas in interface INumericFieldFormat
Parameters:
conditionFormulas - A NumericFieldFormatConditionFormulas object containing the condition formulas used to override the numeric field's format settings.

setCurrencyPosition

public void setCurrencyPosition(CurrencyPositionFormat currencyPosition)
Description copied from interface: INumericFieldFormat

Sets the position of the currency symbol.

Specified by:
setCurrencyPosition in interface INumericFieldFormat
Parameters:
currencyPosition - A CurrencyPositionFormat that specifies the position of the currency symbol.

setCurrencySymbol

public void setCurrencySymbol(java.lang.String currencySymbol)
Description copied from interface: INumericFieldFormat

Sets the currency symbol.

Specified by:
setCurrencySymbol in interface INumericFieldFormat
Parameters:
currencySymbol - A String that specifies the currency symbol.

setCurrencySymbolFormat

public void setCurrencySymbolFormat(CurrencySymbolType currencySymbolFormat)
Description copied from interface: INumericFieldFormat

Sets the format of the currency symbol.

Specified by:
setCurrencySymbolFormat in interface INumericFieldFormat
Parameters:
currencySymbolFormat - A CurrencySymbolType that specifies the format of the currency symbol.

setDecimalSymbol

public void setDecimalSymbol(java.lang.String decimalSymbol)
Description copied from interface: INumericFieldFormat

Sets the symbol of the decimal operator.

Specified by:
setDecimalSymbol in interface INumericFieldFormat
Parameters:
decimalSymbol - A String that specifies the symbol of the decimal operator.

setDisplayReverseSign

public void setDisplayReverseSign(boolean displayReverseSign)
Description copied from interface: INumericFieldFormat

Sets whether the sign is reversed for display.

Specified by:
setDisplayReverseSign in interface INumericFieldFormat
Parameters:
displayReverseSign - true if the sign is reversed for display, false otherwise.

setEnableSuppressIfZero

public void setEnableSuppressIfZero(boolean enableSuppressIfZero)
Description copied from interface: INumericFieldFormat

Sets whether nothing is printed when the value is zero.

Specified by:
setEnableSuppressIfZero in interface INumericFieldFormat
Parameters:
enableSuppressIfZero - true if nothing is printed when the value is zero, false if when the number is zero, zero is printed.

setEnableUseLeadZero

public void setEnableUseLeadZero(boolean enableUseLeadZero)
Description copied from interface: INumericFieldFormat

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

Specified by:
setEnableUseLeadZero in interface INumericFieldFormat
Parameters:
enableUseLeadZero - true if a zero will be included before the decimal point, false otherwise.

setNDecimalPlaces

public void setNDecimalPlaces(int nDecimalPlaces)
Description copied from interface: INumericFieldFormat

Sets the number of decimal places.

Specified by:
setNDecimalPlaces in interface INumericFieldFormat
Parameters:
nDecimalPlaces - An int that specifies the number of decimal places.

setNegativeFormat

public void setNegativeFormat(NegativeType negativeFormat)
Description copied from interface: INumericFieldFormat

Sets the manner in which negative values appear.

Specified by:
setNegativeFormat in interface INumericFieldFormat
Parameters:
negativeFormat - A NegativeType object that specifies the manner in which negative values appear.

setOneCurrencySymbolPerPage

public void setOneCurrencySymbolPerPage(boolean oneCurrencySymbolPerPage)
Description copied from interface: INumericFieldFormat

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

Specified by:
setOneCurrencySymbolPerPage in interface INumericFieldFormat
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.

setRoundingFormat

public void setRoundingFormat(RoundingType roundingFormat)
Description copied from interface: INumericFieldFormat

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

Specified by:
setRoundingFormat in interface INumericFieldFormat
Parameters:
roundingFormat - A RoundingType object that specifies the number of decimal places to round the number to.

setThousandsSeparator

public void setThousandsSeparator(boolean thousandsSeparator)
Description copied from interface: INumericFieldFormat

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

Specified by:
setThousandsSeparator in interface INumericFieldFormat
Parameters:
thousandsSeparator - true if a thousandths separator is inserted for numbers over 999, false otherwise.

setThousandSymbol

public void setThousandSymbol(java.lang.String thousandSymbol)
Description copied from interface: INumericFieldFormat

Sets the symbol of the thousandths separator.

Specified by:
setThousandSymbol in interface INumericFieldFormat
Parameters:
thousandSymbol - A String that specifies the symbol of the thousandths separator.

setZeroValueString

public void setZeroValueString(java.lang.String zeroValueString)
Description copied from interface: INumericFieldFormat

Sets the zero value that will be displayed.

Specified by:
setZeroValueString in interface INumericFieldFormat
Parameters:
zeroValueString - A String containing the zero value.

setAllowFieldClipping

public void setAllowFieldClipping(boolean bAllowFieldClipping)
Specified by:
setAllowFieldClipping in interface INumericFieldFormat

setUseAccountingFormat

public void setUseAccountingFormat(boolean bUseAccountingFormat)
Specified by:
setUseAccountingFormat in interface INumericFieldFormat

skipWritingIdenticalObject

public boolean skipWritingIdenticalObject()

For internal use only.


startElement

public void startElement(java.lang.String eleName,
                         java.util.Map objState,
                         org.xml.sax.Attributes attrs)

For internal use only.


doControllerModification

public void doControllerModification(java.lang.Object newObject)

enumerateMembers

public void enumerateMembers(IMemberVisitor visitor)

getControllableMixin

public ControllableMixin getControllableMixin()

isDirectlyControllable

public boolean isDirectlyControllable()