|
|||||||||
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 |
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 |
---|
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()
INumericFieldFormat
Returns the condition formulas used to override the numeric field's format settings.
getConditionFormulas
in interface INumericFieldFormat
NumericFieldFormatConditionFormulas
object containing
the condition formulas used to override the numeric field's format settings.public CurrencyPositionFormat getCurrencyPosition()
INumericFieldFormat
Returns the position of the currency symbol.
getCurrencyPosition
in interface INumericFieldFormat
CurrencyPositionFormat
that specifies the position of
the currency symbol.public java.lang.String getCurrencySymbol()
INumericFieldFormat
Returns the currency symbol.
getCurrencySymbol
in interface INumericFieldFormat
String
that specifies the currency symbol.public CurrencySymbolType getCurrencySymbolFormat()
INumericFieldFormat
Returns the format of the currency symbol.
getCurrencySymbolFormat
in interface INumericFieldFormat
CurrencySymbolType
that specifies the format of the currency symbol.public java.lang.String getDecimalSymbol()
INumericFieldFormat
Returns the symbol of the decimal operator.
getDecimalSymbol
in interface INumericFieldFormat
String
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 INumericFieldFormat
true
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 INumericFieldFormat
true
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 INumericFieldFormat
true
if a zero will be included before the decimal point, false
otherwise.public int getNDecimalPlaces()
INumericFieldFormat
Returns the number of decimal places.
getNDecimalPlaces
in interface INumericFieldFormat
int
that specifies the number of decimal places.public NegativeType getNegativeFormat()
INumericFieldFormat
Returns the manner in which negative values appear.
getNegativeFormat
in interface INumericFieldFormat
NegativeType
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 INumericFieldFormat
true
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()
INumericFieldFormat
Returns the number of decimal places to round the number to.
getRoundingFormat
in interface INumericFieldFormat
RoundingType
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 INumericFieldFormat
true
if a thousandths separator is inserted for numbers over 999,
false
otherwise.public java.lang.String getThousandSymbol()
INumericFieldFormat
Returns the symbol of the thousandths separator.
getThousandSymbol
in interface INumericFieldFormat
String
that specifies the symbol of the thousandths separator.public java.lang.String getZeroValueString()
INumericFieldFormat
Returns the zero value that will be displayed.
getZeroValueString
in interface INumericFieldFormat
String
containing the zero value.public boolean getAllowFieldClipping()
getAllowFieldClipping
in interface INumericFieldFormat
public boolean getUseAccountingFormat()
getUseAccountingFormat
in interface INumericFieldFormat
public 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.IOException
public void setConditionFormulas(NumericFieldFormatConditionFormulas conditionFormulas)
INumericFieldFormat
Sets the condition formulas used to override the numeric field's format settings.
setConditionFormulas
in interface INumericFieldFormat
conditionFormulas
- A NumericFieldFormatConditionFormulas
object containing
the condition formulas used to override the numeric field's format settings.public void setCurrencyPosition(CurrencyPositionFormat currencyPosition)
INumericFieldFormat
Sets the position of the currency symbol.
setCurrencyPosition
in interface INumericFieldFormat
currencyPosition
- A CurrencyPositionFormat
that specifies the position of
the currency symbol.public void setCurrencySymbol(java.lang.String currencySymbol)
INumericFieldFormat
Sets the currency symbol.
setCurrencySymbol
in interface INumericFieldFormat
currencySymbol
- A String
that specifies the currency symbol.public void setCurrencySymbolFormat(CurrencySymbolType currencySymbolFormat)
INumericFieldFormat
Sets the format of the currency symbol.
setCurrencySymbolFormat
in interface INumericFieldFormat
currencySymbolFormat
- A CurrencySymbolType
that specifies the format of the
currency symbol.public void setDecimalSymbol(java.lang.String decimalSymbol)
INumericFieldFormat
Sets the symbol of the decimal operator.
setDecimalSymbol
in interface INumericFieldFormat
decimalSymbol
- A String
that specifies the symbol of the decimal operator.public void setDisplayReverseSign(boolean displayReverseSign)
INumericFieldFormat
Sets whether the sign is reversed for display.
setDisplayReverseSign
in interface INumericFieldFormat
displayReverseSign
- true
if the sign is reversed for display,
false
otherwise.public void setEnableSuppressIfZero(boolean enableSuppressIfZero)
INumericFieldFormat
Sets whether nothing is printed when the value is zero.
setEnableSuppressIfZero
in interface INumericFieldFormat
enableSuppressIfZero
- 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)
INumericFieldFormat
Sets whether a zero will be included before the decimal point.
setEnableUseLeadZero
in interface INumericFieldFormat
enableUseLeadZero
- true
if a zero will be included before the decimal
point, false
otherwise.public void setNDecimalPlaces(int nDecimalPlaces)
INumericFieldFormat
Sets the number of decimal places.
setNDecimalPlaces
in interface INumericFieldFormat
nDecimalPlaces
- An int
that specifies the number of decimal places.public void setNegativeFormat(NegativeType negativeFormat)
INumericFieldFormat
Sets the manner in which negative values appear.
setNegativeFormat
in interface INumericFieldFormat
negativeFormat
- A NegativeType
object that specifies the manner in which
negative values appear.public void setOneCurrencySymbolPerPage(boolean oneCurrencySymbolPerPage)
INumericFieldFormat
Sets whether a currency symbol is displayed only once per page.
setOneCurrencySymbolPerPage
in interface INumericFieldFormat
oneCurrencySymbolPerPage
- 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)
INumericFieldFormat
Sets the number of decimal places to round the number to.
setRoundingFormat
in interface INumericFieldFormat
roundingFormat
- A RoundingType
object that specifies the number of decimal places to
round the number to.public void setThousandsSeparator(boolean thousandsSeparator)
INumericFieldFormat
Sets whether a thousandths separator is inserted for numbers over 999.
setThousandsSeparator
in interface INumericFieldFormat
thousandsSeparator
- true
if a thousandths separator is inserted for numbers over 999,
false
otherwise.public void setThousandSymbol(java.lang.String thousandSymbol)
INumericFieldFormat
Sets the symbol of the thousandths separator.
setThousandSymbol
in interface INumericFieldFormat
thousandSymbol
- A String
that specifies the symbol of the thousandths separator.public void setZeroValueString(java.lang.String zeroValueString)
INumericFieldFormat
Sets the zero value that will be displayed.
setZeroValueString
in interface INumericFieldFormat
zeroValueString
- A String
containing the zero value.public void setAllowFieldClipping(boolean bAllowFieldClipping)
setAllowFieldClipping
in interface INumericFieldFormat
public void setUseAccountingFormat(boolean bUseAccountingFormat)
setUseAccountingFormat
in interface INumericFieldFormat
public 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.
public void doControllerModification(java.lang.Object newObject)
public void enumerateMembers(IMemberVisitor visitor)
public ControllableMixin getControllableMixin()
public boolean isDirectlyControllable()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |