com.inet.report
Class AbstractValueElement

java.lang.Object
  com.inet.report.ReportComponent
      com.inet.report.Element
          com.inet.report.AbstractFontElement
              com.inet.report.AbstractValueElement

All Implemented Interfaces:

BorderProperties, FontProperties, GeneralProperties, NodeParser, com.inet.report.ReferenceHolder, ValueProperties, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

FieldElement, FieldPart

public abstract class AbstractValueElement
extends AbstractFontElement
implements ValueProperties

This class is an abstract implementation of the interface ValueProperties.

Since:

6.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.inet.report.Element

BOX, CHART, CROSSTAB, CROSSTABCELL, CROSSTABCOLUMN, CROSSTABROW, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, JAVABEAN, LINE, PARAGRAPH, PICTURE, SIGNATURE, SUBREPORT, TEXT, TEXTPART

Fields inherited from interface com.inet.report.ValueProperties

AM_PM_AFTER, AM_PM_BEFORE, BRACKETED, DATE_ONLY_ORDER, DATE_TIME_ORDER, DAY_MONTH_YEAR, DAY_OF_WEEK_ENCLOSURE_ANGLE, DAY_OF_WEEK_ENCLOSURE_NONE, DAY_OF_WEEK_ENCLOSURE_PARENTHESIS, DAY_OF_WEEK_ENCLOSURE_SQUARED, FIXED_SYMBOL, FLOATING_SYMBOL, GREGORIAN_CALENDAR, GREGORIAN_US_CALENDAR, HIJRI_CALENDAR, JAPANESE_CALENDAR, KOREAN_CALENDAR, LEADING_CURRENCY_INSIDE_NEGATIVE, LEADING_CURRENCY_OUTSIDE_NEGATIVE, LEADING_DAY_OF_WEEK, LEADING_MINUS, LEADING_ZERO_NUMERIC_DAY, LEADING_ZERO_NUMERIC_MONTH, LONG_DAY_OF_WEEK, LONG_ERA, LONG_MONTH, LONG_YEAR, MONTH_DAY_YEAR, NOT_NEGATIVE, NOT_USING_SYSTEM_DEFAULTS, NO_DAY, NO_DAY_OF_WEEK, NO_ERA, NO_HOUR, NO_MINUTE, NO_MONTH, NO_SYMBOL, NO_YEAR, NUMBER_FORMAT_CURRENCY, NUMBER_FORMAT_FRACTIONAL, NUMBER_FORMAT_INTEGER, NUMBER_FORMAT_PERCENT, NUMERAL_LANGUAGE_ARABIC, NUMERAL_LANGUAGE_BENGALI, NUMERAL_LANGUAGE_DEVANAGARI, NUMERAL_LANGUAGE_EASTERN_ARABIC, NUMERAL_LANGUAGE_ETHIOPIC, NUMERAL_LANGUAGE_EUROPEAN, NUMERAL_LANGUAGE_GUJARATI, NUMERAL_LANGUAGE_GURMUKHI, NUMERAL_LANGUAGE_KANNADA, NUMERAL_LANGUAGE_KHMER, NUMERAL_LANGUAGE_LAO, NUMERAL_LANGUAGE_MALAYALAM, NUMERAL_LANGUAGE_MONGOLIAN, NUMERAL_LANGUAGE_MYANMAR, NUMERAL_LANGUAGE_ORIYA, NUMERAL_LANGUAGE_TAMIL, NUMERAL_LANGUAGE_TELUGU, NUMERAL_LANGUAGE_THAI, NUMERAL_LANGUAGE_TIBETAN, NUMERIC_DAY, NUMERIC_HOUR, NUMERIC_HOUR_NO_LEADING_ZERO, NUMERIC_MINUTE, NUMERIC_MINUTE_NO_LEADING_ZERO, NUMERIC_MONTH, NUMERIC_NO_LEADING_ZERO, NUMERIC_NO_SECOND, NUMERIC_SECOND, ONE_OR_ZERO, ROUND_CEILING, ROUND_DOWN, ROUND_FLOOR, ROUND_HALF_DOWN, ROUND_HALF_EVEN, ROUND_HALF_UP, ROUND_TO_BILLIONTH, ROUND_TO_HUNDRED, ROUND_TO_HUNDRED_MILLIONTH, ROUND_TO_HUNDRED_THOUSAND, ROUND_TO_HUNDRED_THOUSANDTH, ROUND_TO_HUNDRETH, ROUND_TO_MILLION, ROUND_TO_MILLIONTH, ROUND_TO_TEN, ROUND_TO_TENTH, ROUND_TO_TEN_BILLIONTH, ROUND_TO_TEN_MILLIONTH, ROUND_TO_TEN_THOUSAND, ROUND_TO_TEN_THOUSANDTH, ROUND_TO_THOUSAND, ROUND_TO_THOUSANDTH, ROUND_TO_UNIT, ROUND_UP, SHORT_DAY_OF_WEEK, SHORT_ERA, SHORT_MONTH, SHORT_YEAR, TAIWANESE_CALENDAR, THAI_CALENDAR, TIME_DATE_ORDER, TIME_ONLY_ORDER, TRAILING_CURRENCY_INSIDE_NEGATIVE, TRAILING_CURRENCY_OUTSIDE_NEGATIVE, TRAILING_DAY_OF_WEEK, TRAILING_MINUS, TRUE_OR_FALSE, TWELVE_HOURS, TWENTY_FOUR_HOURS, T_OR_F, USE_CUSTOM_FORMAT, USE_SYSTEM_LONG_DATE, USE_SYSTEM_LONG_TIME, USE_SYSTEM_MEDIUM_DATE, USE_SYSTEM_MEDIUM_TIME, USE_SYSTEM_SHORT_DATE, USE_SYSTEM_SHORT_TIME, YEAR_MONTH_DAY, YES_OR_NO, Y_OR_N

Fields inherited from interface com.inet.report.FontProperties

FONT_DIALOG, FONT_MONOSPACED, FONT_SANS_SERIF, FONT_SERIF, FONT_STYLE_BOLD, FONT_STYLE_ITALIC, FONT_STYLE_STRIKETHROUGH, FONT_STYLE_UNDERLINE

Fields inherited from interface com.inet.report.BorderProperties

LINE_STYLE_DASHED, LINE_STYLE_DOTTED, LINE_STYLE_DOUBLE, LINE_STYLE_SINGLE, NO_LINE

Fields inherited from interface com.inet.report.GeneralProperties

ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT

Method Summary

FormulaField	getAllowFieldClippingFormula() Get the formula for the property 'allow field clipping'.
int	getAmPmOrder() Returns the value of the property 'am pm order/type'.
FormulaField	getAmPmOrderFormula() returns the formula of the property 'am pm order/type'.
java.lang.String	getAmString() Returns the value of the property 'am string'.
FormulaField	getAmStringFormula() Returns the formula of the property 'am string'.
int	getBooleanFormatOutputType() Returns the value of the property 'boolean format output type'.
FormulaField	getBooleanFormatOutputTypeFormula() Returns the formula for the property 'boolean format output type'.
FormulaField	getBooleanFormatTypeFormula() Returns the formula for the property 'boolean format output type'.
int	getCurrencyPosition() Returns the value of the property 'currency position type'.
FormulaField	getCurrencyPositionFormula() Returns the formula for the property 'currency position type'.
java.lang.String	getCurrencySeparator() Returns the separator between the number value and currency symbol.
FormulaField	getCurrencySeparatorFormula() Returns the formula for the property 'currency separator'.
java.lang.String	getCurrencySymbol() Returns the value of the property 'currency symbol'.
FormulaField	getCurrencySymbolFormula() Returns the formula for the property 'currency symbol'.
int	getCurrencySymbolType() Returns the value of the property 'currency symbol type'.
FormulaField	getCurrencySymbolTypeFormula() Returns the formula for the property 'currency symbol type'.
int	getDateCalendarType() Returns the value of the property 'date calendar type'.
FormulaField	getDateCalendarTypeFormula() Returns the formula of the property 'date calendar type'.
int	getDateEraType() Returns the value of the property 'date era type'.
FormulaField	getDateEraTypeFormula() Returns the formula of the property 'date era type'.
java.lang.String	getDateFirstSeparator() Returns the value of the property 'date first separator'.
FormulaField	getDateFirstSeparatorFormula() Returns the formula for the property 'date first separator'.
int	getDateFormatType() Returns the date format type set for this element.
FormulaField	getDateFormatTypeFormula() Returns the formula for the property 'date format type'.
int	getDateOrder() Returns the value of the property 'date order'.
FormulaField	getDateOrderFormula() Returns the formula for the property 'date order'.
java.lang.String	getDatePrefixSeparator() Returns the value of the property 'date prefix separator'.
FormulaField	getDatePrefixSeparatorFormula() Returns the formula for the property 'date prefix separator'.
java.lang.String	getDateSecondSeparator() Returns the value of the property 'date second separator'.
FormulaField	getDateSecondSeparatorFormula() Returns the formula for the property 'date second separator'.
java.lang.String	getDateSuffixSeparator() Returns the value of the property 'date suffix separator'.
FormulaField	getDateSuffixSeparatorFormula() Returns the formula for the property 'date suffix separator'.
int	getDateTimeOrder() Returns the value of the property 'date time order'.
FormulaField	getDateTimeOrderFormula() Returns the formula for the property 'date time order'.
java.lang.String	getDateTimeSeparator() Returns the value of the property 'date time separator'.
FormulaField	getDateTimeSeparatorFormula() Returns the formula for the property 'date time separator'.
int	getDayOfWeekEnclosure() Returns the value of the property 'day of week enclosure'.
FormulaField	getDayOfWeekEnclosureFormula() Returns the formula for the property 'day of week enclosure'.
int	getDayOfWeekPosition() Returns the value of the property 'day of week position'.
FormulaField	getDayOfWeekPositionFormula() Returns the formula for the property 'day of week position'.
java.lang.String	getDayOfWeekSeparator() Returns the value of the property 'day of week separator'.
FormulaField	getDayOfWeekSeparatorFormula() Returns the formula for the property 'day of week separator'.
int	getDayOfWeekType() Returns the value of the property 'day of week type'.
FormulaField	getDayOfWeekTypeFormula() Returns the formula for the property 'day of week type'.
int	getDayType() Returns the value of the property 'day type'.
FormulaField	getDayTypeFormula() Returns the formula for the property 'day type'.
java.lang.String	getDecimalSeparatorSymbol() Returns the value of the property 'decimal separators symbol'.
FormulaField	getDecimalSeparatorSymbolFormula() Returns the formula for the property 'decimal separators symbol'.
java.lang.String	getHourMinuteSeparator() Returns the value of the property 'hour minute sepereator'.
FormulaField	getHourMinuteSeparatorFormula() Returns the formula for the property 'hour minute sepereator'.
int	getHourType() Returns the value of the property 'hour type'.
FormulaField	getHourTypeFormula() Returns the formula for the property 'hour type'.
FormulaField	getManualFormatFormula() Gets the formula of the property 'manual format'.
java.lang.String	getMinuteSecondSeparator() Returns the value of the property 'minute second separator'.
FormulaField	getMinuteSecondSeparatorFormula() Returns the formula for the property 'minute second separator'.
int	getMinuteType() Returns the value of the property 'minute type'.
FormulaField	getMinuteTypeFormula() Returns the formula for the property 'minute type'.
int	getMonthType() Returns the value of the property 'month type'.
FormulaField	getMonthTypeFormula() Returns the formula for the property 'month type'.
int	getNDecimalPlaces() Returns the value of the property 'n decimal places'.
FormulaField	getNDecimalPlacesFormula() Returns the formula for the property 'n decimal places'.
int	getNegativeType() Returns the value of the property 'negative type'.
FormulaField	getNegativeTypeFormula() Returns the formula for the property 'negative type'.
int	getNumberFormatType() Returns the number format type set for this element.
FormulaField	getNumberFormatTypeFormula() Returns the formula which returns the number format type to use for this element.
int	getNumeralLanguage() Returns the language of numerals for numbers, date, time and datetime values.
java.lang.String	getPmString() Returns the value of the property 'pm string'.
FormulaField	getPmStringFormula() Returns the formula of the property 'pm string'.
java.util.List	getPropertyFormulas() Returns a list with all property formulas that are set for this report element.
FormulaField	getReverseSignForDisplayFormula() Returns the formula for the property 'use reverse sign for display'.
int	getRounding() Returns which digit to round the number to.
int	getRoundingDigits() Deprecated. As of i-net Crystal-Clear 10, this has been replaced with getRounding()
FormulaField	getRoundingFormula() Returns the formula which provides the digit to round the number to.
int	getRoundingMode() Returns the rounding mode for this element.
FormulaField	getRoundingModeFormula() Returns the formula for the rounding mode, can be null if the formula is not set.
int	getRoundingType() Deprecated. As of i-net Crystal-Clear 10, this has been replaced with getRounding()
FormulaField	getRoundingTypeFormula() Deprecated. As of i-net Crystal-Clear 10, this has been replaced with getRoundingFormula()
int	getSecondType() Returns the value of the property 'second type'.
FormulaField	getSecondTypeFormula() Returns the formula for the property 'second type'.
boolean	getSuppressIfZero() Returns the value of the property 'suppress if zero'.
FormulaField	getSuppressIfZeroFormula() Returns the formula for the property 'suppress if zero'.
java.lang.String	getThousandsSeparatorSymbol() Returns the value of the property 'thousands separator symbol'.
FormulaField	getThousandsSeparatorSymbolFormula() Returns the formula for the property 'thousands separator symbol'.
int	getTimeBase() Returns the value of the property 'time base'.
FormulaField	getTimeBaseFormula() Returns the formula for the property 'time base'.
int	getTimeFormatType() Returns the time format type to use for this element.
FormulaField	getTimeFormatTypeFormula() Returns the formula determining the time format type to use for this element.
boolean	getUseLeadingZero() Returns the value of the property 'use leading zero'.
FormulaField	getUseLeadingZeroFormula() Returns the formula for the property 'use leading zero'.
boolean	getUseOneCurrencySymbolPerPage() Returns the value of the property 'use one currency symbol per page'.
FormulaField	getUseOneCurrencySymbolPerPageFormula() Returns the formula for the property 'use one currency symbol per page'.
boolean	getUseThousandsSeparator() Returns the value of the property 'use thousands separator'.
FormulaField	getUseThousandsSeparatorFormula() Returns the formula for the property 'use thousands separator'.
int	getYearType() Returns the value of the property 'year type'.
FormulaField	getYearTypeFormula() Returns the formula for the property 'year type'.
java.lang.String	getZeroValueString() Returns the value of the property 'zero value string'.
boolean	isAllowFieldClipping() Returns true if allow field clipping is enabled, else false is returned.
boolean	isReverseSignForDisplay() Checks the property 'use reverse sign for display'
NodeParser	parseElement(com.inet.report.parser.XMLTag group, java.lang.String tag, org.xml.sax.Attributes atts, java.util.Map parserMap) FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML Parses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself.
void	setAllowFieldClipping(boolean newValue) Sets the value of the property 'allow field clipping'.
void	setAllowFieldClippingFormula(FormulaField newField) Set the formula for the property 'allow field clipping'.
void	setAmPmOrder(int newValue) Sets the value of the property 'am pm order/type'.
void	setAmPmOrderFormula(FormulaField newFormula) Sets the formula for the property 'am pm order/type'.
void	setAmString(java.lang.String newValue) Sets the value of the property 'am string'.
void	setAmStringFormula(FormulaField newFormula) Sets the formula for the property 'am string'.
void	setBooleanFormatOutputType(int newValue) Sets the value of the property 'boolean format output type'.
void	setBooleanFormatOutputTypeFormula(FormulaField newFormula) Sets the formula for the property 'boolean format output type'.
void	setCurrencyPosition(int newValue) Sets the value of the property 'currency position type'.
void	setCurrencyPositionFormula(FormulaField newFormula) Sets the formula for the property 'currency position type'.
void	setCurrencySeparator(java.lang.String newCurrencySeparator) Sets the separator to be displayed between the number value and the currency value.
void	setCurrencySeparatorFormula(FormulaField newFormula) Sets the formula which should be used to retrieve the value for the separator between number value and currency symbol.
void	setCurrencySymbol(java.lang.String newValue) Sets the value of the property 'currency symbol'.
void	setCurrencySymbolFormula(FormulaField newFormula) Sets the formula for the property 'currency symbol'.
void	setCurrencySymbolType(int newValue) Sets the value of the property 'currency symbol type'.
void	setCurrencySymbolTypeFormula(FormulaField newFormula) Sets the formula for the property 'currency symbol type'.
void	setDateCalendarType(int newValue) Sets the value of the property 'date calendar type'.
void	setDateCalendarTypeFormula(FormulaField newFormula) Sets the formula for the property 'date calendar type'.
void	setDateEraType(int newValue) Sets the value of the property 'date era type'.
void	setDateEraTypeFormula(FormulaField newFormula) Sets the formula for the property 'date era type'.
void	setDateFirstSeparator(java.lang.String newValue) Sets the value of the property 'date first separator'.
void	setDateFirstSeparatorFormula(FormulaField newFormula) Sets the formula for the property 'date first separator'.
void	setDateFormatType(int newValue) Sets the date format type to use for this element.
void	setDateFormatTypeFormula(FormulaField newFormula) Sets the formula for the property 'date format type'.
void	setDateOrder(int newValue) Sets the value of the property 'date order'.
void	setDateOrderFormula(FormulaField newFormula) Sets the formula for the property 'date order'.
void	setDatePrefixSeparator(java.lang.String newValue) Sets the value of the property 'date prefix separator'.
void	setDatePrefixSeparatorFormula(FormulaField newFormula) Sets the formula for the property 'date prefix separator'.
void	setDateSecondSeparator(java.lang.String newValue) Sets the value of the property 'date second separator'.
void	setDateSecondSeparatorFormula(FormulaField newFormula) Sets the formula for the property 'date second separator'.
void	setDateSuffixSeparator(java.lang.String newValue) Sets the value of the property 'date suffix separator'.
void	setDateSuffixSeparatorFormula(FormulaField newFormula) Sets the formula for the property 'date suffix separator'.
void	setDateTimeOrder(int newValue) Sets the value of the property 'date time order'.
void	setDateTimeOrderFormula(FormulaField newFormula) Sets the formula for the property 'date time order'.
void	setDateTimeSeparator(java.lang.String newValue) Sets the value of the property 'date time separator'.
void	setDateTimeSeparatorFormula(FormulaField newFormula) Sets the formula for the property 'date time separator'.
void	setDayOfWeekEnclosure(int newValue) Sets the value of the property 'day of week enclosure'.
void	setDayOfWeekEnclosureFormula(FormulaField newFormula) Sets the formula for the property 'day of week enclosure'.
void	setDayOfWeekPosition(int newValue) Sets the value of the property 'day of week position'.
void	setDayOfWeekPositionFormula(FormulaField newFormula) Sets the formula for the property 'day of week position'.
void	setDayOfWeekSeparator(java.lang.String newValue) Sets the value of the property 'day of week separator'.
void	setDayOfWeekSeparatorFormula(FormulaField newFormula) Sets the formula for the property 'day of week separator'.
void	setDayOfWeekType(int newValue) Sets the value of the property 'day of week type'.
void	setDayOfWeekTypeFormula(FormulaField newFormula) Sets the formula for the property 'day of week type'.
void	setDayType(int newValue) Sets the value of the property 'day type'.
void	setDayTypeFormula(FormulaField newFormula) Sets the formula for the property 'day type'.
void	setDecimalSeparatorSymbol(java.lang.String newValue) Sets the value of the property 'decimal separators symbol'.
void	setDecimalSeparatorSymbolFormula(FormulaField newFormula) Sets the formula for the property 'decimal separators symbol'.
void	setField(Field newField) Sets the field definition element (for example, DatabaseField element, prompt field element).
void	setHourMinuteSeparator(java.lang.String newValue) Sets the value of the property 'hour minute sepereator'.
void	setHourMinuteSeparatorFormula(FormulaField newFormula) Sets the formula for the property 'hour minute sepereator'.
void	setHourType(int newValue) Sets the value of the property 'hour type'.
void	setHourTypeFormula(FormulaField newFormula) Sets the formula for the property 'hour type'.
void	setManualFormatFormula(FormulaField newFormula) Gets the formula of the property 'manual format'.
void	setMinuteSecondSeparator(java.lang.String newValue) Sets the value of the property 'minute second separator'.
void	setMinuteSecondSeparatorFormula(FormulaField newFormula) Sets the formula for the property 'minute second separator'.
void	setMinuteType(int newValue) Sets the value of the property 'minute type'.
void	setMinuteTypeFormula(FormulaField newFormula) Sets the formula for the property 'minute type'.
void	setMonthType(int newValue) Sets the value of the property 'month type'.
void	setMonthTypeFormula(FormulaField newFormula) Sets the formula for the property 'month type'.
void	setNDecimalPlaces(int newValue) Sets the value of the property 'n decimal places'.
void	setNDecimalPlacesFormula(FormulaField newFormula) Sets the formula for the property 'n decimal places'.
void	setNegativeType(int newValue) Sets the value of the property 'negative type'.
void	setNegativeTypeFormula(FormulaField newFormula) Sets the formula for the property 'negative type'.
void	setNumberFormatType(int newValue) Sets the number format type to use for this element.
void	setNumberFormatTypeFormula(FormulaField newFormula) Sets the formula which returns the number format type to use for this element.
void	setNumeralLanguage(int language) Sets the language of the numerals in number, date, time or datetime values.
void	setPmString(java.lang.String newValue) Sets the value of the property 'pm string'.
void	setPmStringFormula(FormulaField newFormula) Sets the formula for the property 'pm string'.
void	setReverseSignForDisplay(boolean newValue) Sets the property 'use reverse sign for display'.
void	setReverseSignForDisplayFormula(FormulaField newFormula) Sets the formula for the property 'use reverse sign for display'.
void	setRounding(int newValue) Sets which digit to round the number to.
void	setRoundingDigits(int digits) Deprecated. As of i-net Crystal-Clear 10, this has been replaced with setRounding(int)
void	setRoundingFormula(FormulaField newFormula) Sets the formula which provides the digit to round the number to.
void	setRoundingMode(int newValue) Sets the rounding mode.
void	setRoundingModeFormula(FormulaField newFormula) Sets the formula for the property 'rounding mode'.
void	setRoundingType(int newValue) Deprecated. As of i-net Crystal-Clear 10, this has been replaced with setRounding(int)
void	setRoundingTypeFormula(FormulaField newFormula) Deprecated. As of i-net Crystal-Clear 10, this has been replaced with setRoundingFormula(FormulaField)
void	setSecondType(int newValue) Sets the value of the property 'second type'.
void	setSecondTypeFormula(FormulaField newFormula) Sets the formula for the property 'second type'.
void	setSuppressIfZero(boolean newValue) Sets the value of the property 'suppress if zero'.
void	setSuppressIfZeroFormula(FormulaField newFormula) Sets the formula for the property 'suppress if zero'.
void	setThousandsSeparatorSymbol(java.lang.String newValue) Sets the value of the property 'thousands separator symbol'.
void	setThousandsSeparatorSymbolFormula(FormulaField newFormula) Sets the formula for the property 'thousands separator symbol'.
void	setTimeBase(int newValue) Sets the value of the property 'time base'.
void	setTimeBaseFormula(FormulaField newFormula) Sets the formula for the property 'time base'.
void	setTimeFormatType(int systemDefaultTimeType) Sets the time format type to use for this element.
void	setTimeFormatTypeFormula(FormulaField newFormula) Sets the formula determining the time format type to use for this element.
void	setUseLeadingZero(boolean newValue) Sets the value of the property 'use leading zero'.
void	setUseLeadingZeroFormula(FormulaField newFormula) Sets the formula for the property 'use leading zero'.
void	setUseOneCurrencySymbolPerPage(boolean newValue) Sets the value of the property 'use one currency symbol per page'.
void	setUseOneCurrencySymbolPerPageFormula(FormulaField newFormula) Sets the formula for the property 'use one currency symbol per page'.
void	setUseThousandsSeparator(boolean newValue) Sets the value of the property 'use thousands separator'.
void	setUseThousandsSeparatorFormula(FormulaField newFormula) Sets the formula for the property 'use thousands separator'.
void	setYearType(int newValue) Sets the value of the property 'year type'.
void	setYearTypeFormula(FormulaField newFormula) Sets the formula for the property 'year type'.
void	setZeroValueString(java.lang.String newValue) Sets the value of the property 'zero value string'.

Methods inherited from class com.inet.report.AbstractFontElement

getFontColor, getFontColorFormula, getFontName, getFontNameFormula, getFontSize, getFontSizeFormula, getFontSizeTwips, getFontStyle, getFontStyleFormula, getStrikeoutFormula, getUnderlineFormula, isBold, isItalic, isStrikeout, isUnderline, setBold, setFontColor, setFontColorFormula, setFontName, setFontNameFormula, setFontSize, setFontSizeFormula, setFontSizeTwips, setFontStyle, setFontStyleFormula, setItalic, setStrikeout, setStrikeoutFormula, setUnderline, setUnderlineFormula

Methods inherited from class com.inet.report.Element

addListener, copy, copyXML2, getBottomLineStyle, getBottomLineStyleFormula, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getParent, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, indexOf, isCanGrow, isCloseBorderOnPageBreak, isDropShadow, isSuppressIfDuplicated, isTightHorizontal, paramString, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setForeColor, setForeColorFormula, setHorAlign, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula

Methods inherited from class com.inet.report.ReportComponent

getBackColor, getBackColorFormula, getHeight, getKeepTogetherFormula, getSuppressFormula, getType, getWidth, getX, getY, isKeepTogether, isSuppress, setBackColor, setBackColorFormula, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setY

Methods inherited from interface com.inet.report.BorderProperties

getBackColor, getBackColorFormula, setBackColor, setBackColorFormula

Methods inherited from interface com.inet.report.GeneralProperties

getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula

Methods inherited from interface com.inet.report.parser.NodeParser

isDOMParser, parseDOM, parseEndElement, parseText

Method Detail

getAmString

public final java.lang.String getAmString()

Returns the value of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.

Specified by:

getAmString in interface ValueProperties

Returns:

The value of the property 'am string'.

setAmString

public final void setAmString(java.lang.String newValue)

Sets the value of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.

Specified by:

setAmString in interface ValueProperties

Parameters:

newValue - The new value of the property 'am string'.

getAmStringFormula

public final FormulaField getAmStringFormula()

Returns the formula of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.

Specified by:

getAmStringFormula in interface ValueProperties

Returns:

FormulaField if a formula for this property was defined else null.

setAmStringFormula

public final void setAmStringFormula(FormulaField newFormula)

Sets the formula for the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.

Specified by:

setAmStringFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'am string'.

getPmString

public final java.lang.String getPmString()

Returns the value of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.

Specified by:

getPmString in interface ValueProperties

Returns:

The value of the property 'pm string'.

setPmString

public final void setPmString(java.lang.String newValue)

Sets the value of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.

Specified by:

setPmString in interface ValueProperties

Parameters:

newValue - The new value of the property 'pm string'.

getPmStringFormula

public final FormulaField getPmStringFormula()

Returns the formula of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.

Specified by:

getPmStringFormula in interface ValueProperties

Returns:

FormulaField if a formula for this property was defined else null.

setPmStringFormula

public final void setPmStringFormula(FormulaField newFormula)

Sets the formula for the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.

Specified by:

setPmStringFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'pm string'.

setTimeBase

public final void setTimeBase(int newValue)

Sets the value of the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.

Specified by:

setTimeBase in interface ValueProperties

Parameters:

newValue - The new value of the property 'time base'.

See Also:

ValueProperties.TWELVE_HOURS, ValueProperties.TWENTY_FOUR_HOURS

getTimeBase

public final int getTimeBase()

Returns the value of the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.

Specified by:

getTimeBase in interface ValueProperties

Returns:

The value of the property 'time base'.

See Also:

ValueProperties.TWELVE_HOURS, ValueProperties.TWENTY_FOUR_HOURS

setTimeBaseFormula

public final void setTimeBaseFormula(FormulaField newFormula)

Sets the formula for the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.

Specified by:

setTimeBaseFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'time base'.

See Also:

ValueProperties.TWELVE_HOURS, ValueProperties.TWENTY_FOUR_HOURS

getTimeBaseFormula

public final FormulaField getTimeBaseFormula()

Returns the formula for the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.

Specified by:

getTimeBaseFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'time base'.

getAmPmOrder

public final int getAmPmOrder()

Returns the value of the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.

Specified by:

getAmPmOrder in interface ValueProperties

Returns:

The current value of property.

See Also:

ValueProperties.AM_PM_BEFORE, ValueProperties.AM_PM_AFTER

setAmPmOrder

public final void setAmPmOrder(int newValue)

Sets the value of the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.

Specified by:

setAmPmOrder in interface ValueProperties

Parameters:

newValue - The new value for property.

See Also:

ValueProperties.AM_PM_BEFORE, ValueProperties.AM_PM_AFTER

getAmPmOrderFormula

public final FormulaField getAmPmOrderFormula()

returns the formula of the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.

Specified by:

getAmPmOrderFormula in interface ValueProperties

Returns:

FormulaField if a formula for this property was defined else null.

setAmPmOrderFormula

public final void setAmPmOrderFormula(FormulaField newFormula)

Sets the formula for the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.

Specified by:

setAmPmOrderFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'am pm order/type'. The result of the formula should either 0 or 1.

See Also:

ValueProperties.AM_PM_BEFORE, ValueProperties.AM_PM_AFTER

setHourType

public final void setHourType(int newValue)

Sets the value of the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.

Specified by:

setHourType in interface ValueProperties

Parameters:

newValue - The new value of the property 'hour type'.

See Also:

ValueProperties.NO_HOUR, ValueProperties.NUMERIC_HOUR, ValueProperties.NUMERIC_HOUR_NO_LEADING_ZERO

getHourType

public final int getHourType()

Returns the value of the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.

Specified by:

getHourType in interface ValueProperties

Returns:

The current value of the property 'hour type'.

See Also:

ValueProperties.NO_HOUR, ValueProperties.NUMERIC_HOUR, ValueProperties.NUMERIC_HOUR_NO_LEADING_ZERO

setHourTypeFormula

public final void setHourTypeFormula(FormulaField newFormula)

Sets the formula for the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.

Specified by:

setHourTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'hour type'. The result of the formula should be in range from 0 to 2.

See Also:

ValueProperties.NO_HOUR, ValueProperties.NUMERIC_HOUR, ValueProperties.NUMERIC_HOUR_NO_LEADING_ZERO

getHourTypeFormula

public final FormulaField getHourTypeFormula()

Returns the formula for the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.

Specified by:

getHourTypeFormula in interface ValueProperties

Returns:

FormulaField The current formula for the property 'hour type'.

setMinuteType

public final void setMinuteType(int newValue)

Sets the value of the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.

Specified by:

setMinuteType in interface ValueProperties

Parameters:

newValue - The new value of the property 'minute type'.

See Also:

ValueProperties.NO_MINUTE, ValueProperties.NUMERIC_MINUTE, ValueProperties.NUMERIC_MINUTE_NO_LEADING_ZERO

getMinuteType

public final int getMinuteType()

Returns the value of the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.

Specified by:

getMinuteType in interface ValueProperties

Returns:

The current value of the property 'minute type'.

See Also:

ValueProperties.NO_MINUTE, ValueProperties.NUMERIC_MINUTE, ValueProperties.NUMERIC_MINUTE_NO_LEADING_ZERO

setMinuteTypeFormula

public final void setMinuteTypeFormula(FormulaField newFormula)

Sets the formula for the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.

Specified by:

setMinuteTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'minute type'. The result of the formula should be in range from 0 to 2.

See Also:

ValueProperties.NO_MINUTE, ValueProperties.NUMERIC_MINUTE, ValueProperties.NUMERIC_MINUTE_NO_LEADING_ZERO

getMinuteTypeFormula

public final FormulaField getMinuteTypeFormula()

Returns the formula for the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.

Specified by:

getMinuteTypeFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'minute type'.

setSecondType

public final void setSecondType(int newValue)

Sets the value of the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.

Specified by:

setSecondType in interface ValueProperties

Parameters:

newValue - The new value of the property 'second type'.

See Also:

ValueProperties.NUMERIC_NO_SECOND, ValueProperties.NUMERIC_SECOND, ValueProperties.NUMERIC_NO_LEADING_ZERO

getSecondType

public final int getSecondType()

Returns the value of the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.

Specified by:

getSecondType in interface ValueProperties

Returns:

The current value of the property 'second type'.

See Also:

ValueProperties.NUMERIC_NO_SECOND, ValueProperties.NUMERIC_SECOND, ValueProperties.NUMERIC_NO_LEADING_ZERO

setSecondTypeFormula

public final void setSecondTypeFormula(FormulaField newFormula)

Sets the formula for the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.

Specified by:

setSecondTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'second type'. The result of the formula should be in range from 0 to 2.

See Also:

ValueProperties.NUMERIC_NO_SECOND, ValueProperties.NUMERIC_SECOND, ValueProperties.NUMERIC_NO_LEADING_ZERO

getSecondTypeFormula

public final FormulaField getSecondTypeFormula()

Returns the formula for the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.

Specified by:

getSecondTypeFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'second type'.

getHourMinuteSeparator

public final java.lang.String getHourMinuteSeparator()

Returns the value of the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.

Specified by:

getHourMinuteSeparator in interface ValueProperties

Returns:

The current value of the property 'hour minute sepereator'.

Since:

6.1

setHourMinuteSeparator

public final void setHourMinuteSeparator(java.lang.String newValue)

Sets the value of the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.

Specified by:

setHourMinuteSeparator in interface ValueProperties

Parameters:

newValue - The new value of the property 'hour minute sepereator'.

Since:

6.1

setHourMinuteSeparatorFormula

public final void setHourMinuteSeparatorFormula(FormulaField newFormula)

Sets the formula for the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.

Specified by:

setHourMinuteSeparatorFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'hour minute sepereator'.

Since:

6.1

getHourMinuteSeparatorFormula

public final FormulaField getHourMinuteSeparatorFormula()

Returns the formula for the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.

Specified by:

getHourMinuteSeparatorFormula in interface ValueProperties

Returns:

FormulaField The current formula for the property 'hour minute sepereator'.

Since:

6.1

setMinuteSecondSeparator

public final void setMinuteSecondSeparator(java.lang.String newValue)

Sets the value of the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.

Specified by:

setMinuteSecondSeparator in interface ValueProperties

Parameters:

newValue - The new value of the property 'minute second separator'.

Since:

6.1

getMinuteSecondSeparator

public final java.lang.String getMinuteSecondSeparator()

Returns the value of the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.

Specified by:

getMinuteSecondSeparator in interface ValueProperties

Returns:

The current value of the property 'minute second separator'.

Since:

6.1

setMinuteSecondSeparatorFormula

public final void setMinuteSecondSeparatorFormula(FormulaField newFormula)

Sets the formula for the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.

Specified by:

setMinuteSecondSeparatorFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'minute second separator'.

Since:

6.1

getMinuteSecondSeparatorFormula

public final FormulaField getMinuteSecondSeparatorFormula()

Returns the formula for the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.

Specified by:

getMinuteSecondSeparatorFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'minute second separator'.

Since:

6.1

getDateFormatType

public final int getDateFormatType()

Returns the date format type set for this element. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not have any effect.

Specified by:

getDateFormatType in interface ValueProperties

Returns:

The date format type set for this element.

See Also:

ValueProperties.USE_SYSTEM_LONG_DATE, ValueProperties.USE_SYSTEM_MEDIUM_DATE, ValueProperties.USE_SYSTEM_SHORT_DATE, ValueProperties.NOT_USING_SYSTEM_DEFAULTS

setDateFormatType

public final void setDateFormatType(int newValue)

Sets the date format type to use for this element. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not take effect.

Specified by:

setDateFormatType in interface ValueProperties

Parameters:

newValue - The date format type set for this element

See Also:

ValueProperties.USE_SYSTEM_LONG_DATE, ValueProperties.USE_SYSTEM_MEDIUM_DATE, ValueProperties.USE_SYSTEM_SHORT_DATE, ValueProperties.NOT_USING_SYSTEM_DEFAULTS

getDateFormatTypeFormula

public final FormulaField getDateFormatTypeFormula()

Returns the formula for the property 'date format type'. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not take effect.

Specified by:

getDateFormatTypeFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'date format type'.

setDateFormatTypeFormula

public final void setDateFormatTypeFormula(FormulaField newFormula)

Sets the formula for the property 'date format type'. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not take effect.

Specified by:

setDateFormatTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'date format type'. The result of the formula should be 0 (long), 1 (short), 2 (custom), or 3 (medium).

See Also:

ValueProperties.USE_SYSTEM_LONG_DATE, ValueProperties.USE_SYSTEM_MEDIUM_DATE, ValueProperties.USE_SYSTEM_SHORT_DATE, ValueProperties.NOT_USING_SYSTEM_DEFAULTS

getTimeFormatType

public int getTimeFormatType()

Returns the time format type to use for this element. Use this property to specify whether you want to use the short default time format (e.g. "1:12 AM"), the medium default time format (e.g. "1:12:23 AM"), the long default time format (e.g. "1:12:23 AM GMT-06:00"), or if you want to create your own format. When this property is set to short, medium, or long default time format all other properties for date format will not take effect.

Specified by:

getTimeFormatType in interface ValueProperties

Returns:

the time format type set for this element.

See Also:

ValueProperties.USE_SYSTEM_LONG_TIME, ValueProperties.USE_SYSTEM_MEDIUM_TIME, ValueProperties.USE_SYSTEM_SHORT_TIME, ValueProperties.USE_CUSTOM_FORMAT

setTimeFormatType

public void setTimeFormatType(int systemDefaultTimeType)

Sets the time format type to use for this element. Use this property to specify whether you want to use the short default time format (e.g. "1:12 AM"), the medium default time format (e.g. "1:12:23 AM"), the long default time format (e.g. "1:12:23 AM GMT-06:00"), or if you want to create your own format. When this property is set to short, medium, or long default time format all other properties for date format will not take effect.

Specified by:

setTimeFormatType in interface ValueProperties

Parameters:

systemDefaultTimeType - the time format type set for this element

See Also:

ValueProperties.USE_SYSTEM_LONG_TIME, ValueProperties.USE_SYSTEM_MEDIUM_TIME, ValueProperties.USE_SYSTEM_SHORT_TIME, ValueProperties.USE_CUSTOM_FORMAT

getTimeFormatTypeFormula

public FormulaField getTimeFormatTypeFormula()

Returns the formula determining the time format type to use for this element. Use this property to specify whether you want to use the short default time format (e.g. "1:12 AM"), the medium default time format (e.g. "1:12:23 AM"), the long default time format (e.g. "1:12:23 AM GMT-06:00"), or if you want to create your own format. When this property is set to short, medium, or long default time format all other properties for date format will not take effect.

Specified by:

getTimeFormatTypeFormula in interface ValueProperties

Returns:

the formula determining the time format type set for this element

setTimeFormatTypeFormula

public void setTimeFormatTypeFormula(FormulaField newFormula)

Sets the formula determining the time format type to use for this element. Use this property to specify whether you want to use the short default time format (e.g. "1:12 AM"), the medium default time format (e.g. "1:12:23 AM"), the long default time format (e.g. "1:12:23 AM GMT-06:00"), or if you want to create your own format. When this property is set to short, medium, or long default time format all other properties for date format will not take effect.

Specified by:

setTimeFormatTypeFormula in interface ValueProperties

Parameters:

newFormula - the formula determining the time format type set for this element

getNumberFormatType

public int getNumberFormatType()

Returns the number format type set for this element. Use this property to specify whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.

Specified by:

getNumberFormatType in interface ValueProperties

Returns:

The number format type set for this element.

See Also:

ValueProperties.NUMBER_FORMAT_INTEGER, ValueProperties.NUMBER_FORMAT_FRACTIONAL, ValueProperties.NUMBER_FORMAT_PERCENT, ValueProperties.NUMBER_FORMAT_CURRENCY, ValueProperties.USE_CUSTOM_FORMAT

setNumberFormatType

public void setNumberFormatType(int newValue)

Sets the number format type to use for this element. Use this property to specify whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.

Specified by:

setNumberFormatType in interface ValueProperties

Parameters:

newValue - The number format type to set for this element

See Also:

ValueProperties.NUMBER_FORMAT_INTEGER, ValueProperties.NUMBER_FORMAT_FRACTIONAL, ValueProperties.NUMBER_FORMAT_PERCENT, ValueProperties.NUMBER_FORMAT_CURRENCY, ValueProperties.USE_CUSTOM_FORMAT

getNumberFormatTypeFormula

public FormulaField getNumberFormatTypeFormula()

Returns the formula which returns the number format type to use for this element. This type specifies whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.

Specified by:

getNumberFormatTypeFormula in interface ValueProperties

Returns:

The formula field which returns the number format type to use for this element.

See Also:

ValueProperties.NUMBER_FORMAT_INTEGER, ValueProperties.NUMBER_FORMAT_FRACTIONAL, ValueProperties.NUMBER_FORMAT_PERCENT, ValueProperties.NUMBER_FORMAT_CURRENCY, ValueProperties.USE_CUSTOM_FORMAT

setNumberFormatTypeFormula

public void setNumberFormatTypeFormula(FormulaField newFormula)

Sets the formula which returns the number format type to use for this element. This type specifies whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.

Specified by:

setNumberFormatTypeFormula in interface ValueProperties

Parameters:

newFormula - The formula field which returns the number format type to use for this element

See Also:

ValueProperties.NUMBER_FORMAT_INTEGER, ValueProperties.NUMBER_FORMAT_FRACTIONAL, ValueProperties.NUMBER_FORMAT_PERCENT, ValueProperties.NUMBER_FORMAT_CURRENCY, ValueProperties.USE_CUSTOM_FORMAT

getDateCalendarType

public final int getDateCalendarType()

Returns the value of the property 'date calendar type'. Use this property to choose a calendar.

Specified by:

getDateCalendarType in interface ValueProperties

Returns:

The value of the property 'date calendar type'.

See Also:

ValueProperties.GREGORIAN_CALENDAR, ValueProperties.GREGORIAN_US_CALENDAR, ValueProperties.JAPANESE_CALENDAR, ValueProperties.TAIWANESE_CALENDAR, ValueProperties.KOREAN_CALENDAR, ValueProperties.HIJRI_CALENDAR, ValueProperties.THAI_CALENDAR

setDateCalendarType

public final void setDateCalendarType(int newValue)

Sets the value of the property 'date calendar type'. Use this property to choose a calendar.

Specified by:

setDateCalendarType in interface ValueProperties

Parameters:

newValue - The new value of the property 'date calendar type'.

See Also:

ValueProperties.GREGORIAN_CALENDAR, ValueProperties.GREGORIAN_US_CALENDAR, ValueProperties.JAPANESE_CALENDAR, ValueProperties.TAIWANESE_CALENDAR, ValueProperties.KOREAN_CALENDAR, ValueProperties.HIJRI_CALENDAR, ValueProperties.THAI_CALENDAR

getDateCalendarTypeFormula

public final FormulaField getDateCalendarTypeFormula()

Returns the formula of the property 'date calendar type'. Use this property to choose a calendar.

Specified by:

getDateCalendarTypeFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'date calendar type'.

setDateCalendarTypeFormula

public final void setDateCalendarTypeFormula(FormulaField newFormula)

Sets the formula for the property 'date calendar type'. Use this property to choose a calendar.

Specified by:

setDateCalendarTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula of the property 'date calendar type'. The result of the formula should be in range from 1 to 7.

See Also:

ValueProperties.GREGORIAN_CALENDAR, ValueProperties.GREGORIAN_US_CALENDAR, ValueProperties.JAPANESE_CALENDAR, ValueProperties.TAIWANESE_CALENDAR, ValueProperties.KOREAN_CALENDAR, ValueProperties.HIJRI_CALENDAR, ValueProperties.THAI_CALENDAR

getDateEraType

public final int getDateEraType()

Returns the value of the property 'date era type'.

Specified by:

getDateEraType in interface ValueProperties

Returns:

The value of the property 'date era type'.

See Also:

ValueProperties.SHORT_ERA, ValueProperties.LONG_ERA, ValueProperties.NO_ERA

setDateEraType

public final void setDateEraType(int newValue)

Sets the value of the property 'date era type'.

Specified by:

setDateEraType in interface ValueProperties

Parameters:

newValue - The new value of the property 'date era type'.

See Also:

ValueProperties.SHORT_ERA, ValueProperties.LONG_ERA, ValueProperties.NO_ERA

getDateEraTypeFormula

public final FormulaField getDateEraTypeFormula()

Returns the formula of the property 'date era type'.

Specified by:

getDateEraTypeFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'date era type'.

setDateEraTypeFormula

public final void setDateEraTypeFormula(FormulaField newFormula)

Sets the formula for the property 'date era type'.

Specified by:

setDateEraTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'date era type'. The result of the formula should be in range from 0 to 2.

See Also:

ValueProperties.SHORT_ERA, ValueProperties.LONG_ERA, ValueProperties.NO_ERA

getDayType

public final int getDayType()

Returns the value of the property 'day type'. Use this property to specify the day representation of a custom date format.

Specified by:

getDayType in interface ValueProperties

Returns:

The value of the property 'day type'.

See Also:

ValueProperties.NUMERIC_DAY, ValueProperties.LEADING_ZERO_NUMERIC_DAY, ValueProperties.NO_DAY

setDayType

public final void setDayType(int newValue)

Sets the value of the property 'day type'. Use this property to specify the day representation of a custom date format.

Specified by:

setDayType in interface ValueProperties

Parameters:

newValue - The new value of the property 'day type'.

See Also:

ValueProperties.NUMERIC_DAY, ValueProperties.LEADING_ZERO_NUMERIC_DAY, ValueProperties.NO_DAY

getDayTypeFormula

public final FormulaField getDayTypeFormula()

Returns the formula for the property 'day type'. Use this property to specify the day representation of a custom date format.

Specified by:

getDayTypeFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'day type'.

See Also:

ValueProperties.NUMERIC_DAY, ValueProperties.LEADING_ZERO_NUMERIC_DAY, ValueProperties.NO_DAY

setDayTypeFormula

public final void setDayTypeFormula(FormulaField newFormula)

Sets the formula for the property 'day type'. Use this property to specify the day representation of a custom date format.

Specified by:

setDayTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'day type'. The result of the formula should be in range from 0 to 2.

See Also:

ValueProperties.NUMERIC_DAY, ValueProperties.LEADING_ZERO_NUMERIC_DAY, ValueProperties.NO_DAY

setMonthType

public final void setMonthType(int newValue)

Sets the value of the property 'month type'. Use this property to set the representation of the month part in a custom format date.

Specified by:

setMonthType in interface ValueProperties

Parameters:

newValue - The new value of the property 'month type'.

See Also:

ValueProperties.LEADING_ZERO_NUMERIC_MONTH, ValueProperties.LONG_MONTH, ValueProperties.NO_MONTH, ValueProperties.NUMERIC_MONTH, ValueProperties.SHORT_MONTH

getMonthType

public final int getMonthType()

Returns the value of the property 'month type'. Use this property to set the representation of the month part in a custom format date.

Specified by:

getMonthType in interface ValueProperties

Returns:

The current value of the property 'month type'.

See Also:

ValueProperties.LEADING_ZERO_NUMERIC_MONTH, ValueProperties.LONG_MONTH, ValueProperties.NO_MONTH, ValueProperties.NUMERIC_MONTH, ValueProperties.SHORT_MONTH

setMonthTypeFormula

public final void setMonthTypeFormula(FormulaField newFormula)

Sets the formula for the property 'month type'. Use this property to set the representation of the month part in a custom format date.

Specified by:

setMonthTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'month type'. The result of the formula should be in range from 0 to 2.

See Also:

ValueProperties.LEADING_ZERO_NUMERIC_MONTH, ValueProperties.LONG_MONTH, ValueProperties.NO_MONTH, ValueProperties.NUMERIC_MONTH, ValueProperties.SHORT_MONTH

getMonthTypeFormula

public final FormulaField getMonthTypeFormula()

Returns the formula for the property 'month type'. Use this property to set the representation of the month part in a custom format date.

Specified by:

getMonthTypeFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'month type'.

setYearType

public final void setYearType(int newValue)

Sets the value of the property 'year type'. Use this property to specify the year representation of a custom date format.

Specified by:

setYearType in interface ValueProperties

Parameters:

newValue - The new value of the property 'year type'.

See Also:

ValueProperties.SHORT_YEAR, ValueProperties.LONG_YEAR, ValueProperties.NO_YEAR

getYearType

public final int getYearType()

Returns the value of the property 'year type'. Use this property to specify the year representation of a custom date format.

Specified by:

getYearType in interface ValueProperties

Returns:

The value of the property 'year type'.

See Also:

ValueProperties.SHORT_YEAR, ValueProperties.LONG_YEAR, ValueProperties.NO_YEAR

setYearTypeFormula

public final void setYearTypeFormula(FormulaField newFormula)

Sets the formula for the property 'year type'. Use this property to specify the year representation of a custom date format.

Specified by:

setYearTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'year type'. The result of the formula should be in range from 0 to 2.

See Also:

ValueProperties.SHORT_YEAR, ValueProperties.LONG_YEAR, ValueProperties.NO_YEAR

getYearTypeFormula

public final FormulaField getYearTypeFormula()

Returns the formula for the property 'year type'. Use this property to specify the year representation of a custom date format.

Specified by:

getYearTypeFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'year type'.

getDayOfWeekPosition

public final int getDayOfWeekPosition()

Returns the value of the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.

Specified by:

getDayOfWeekPosition in interface ValueProperties

Returns:

The value of the property 'day of week position'.

See Also:

ValueProperties.LEADING_DAY_OF_WEEK, ValueProperties.TRAILING_DAY_OF_WEEK

setDayOfWeekPosition

public final void setDayOfWeekPosition(int newValue)

Sets the value of the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.

Specified by:

setDayOfWeekPosition in interface ValueProperties

Parameters:

newValue - The new value of the property 'day of week position'.

See Also:

ValueProperties.LEADING_DAY_OF_WEEK, ValueProperties.TRAILING_DAY_OF_WEEK

getDayOfWeekPositionFormula

public final FormulaField getDayOfWeekPositionFormula()

Returns the formula for the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.

Specified by:

getDayOfWeekPositionFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'day of week position'.

setDayOfWeekPositionFormula

public final void setDayOfWeekPositionFormula(FormulaField newFormula)

Sets the formula for the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.

Specified by:

setDayOfWeekPositionFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'day of week position'. The result of the formula should be in range from 0 to 1.

See Also:

ValueProperties.LEADING_DAY_OF_WEEK, ValueProperties.TRAILING_DAY_OF_WEEK

getDayOfWeekEnclosure

public final int getDayOfWeekEnclosure()

Returns the value of the property 'day of week enclosure'.

Specified by:

getDayOfWeekEnclosure in interface ValueProperties

Returns:

The current value of the property 'day of week enclosure'.

See Also:

ValueProperties.DAY_OF_WEEK_ENCLOSURE_NONE, ValueProperties.DAY_OF_WEEK_ENCLOSURE_PARENTHESIS, ValueProperties.DAY_OF_WEEK_ENCLOSURE_ANGLE, ValueProperties.DAY_OF_WEEK_ENCLOSURE_SQUARED

setDayOfWeekEnclosure

public final void setDayOfWeekEnclosure(int newValue)

Sets the value of the property 'day of week enclosure'. Use this property to specify the enclosure of the week day name.

Specified by:

setDayOfWeekEnclosure in interface ValueProperties

Parameters:

newValue - The value of the property 'day of week enclosure'.

See Also:

ValueProperties.DAY_OF_WEEK_ENCLOSURE_NONE, ValueProperties.DAY_OF_WEEK_ENCLOSURE_PARENTHESIS, ValueProperties.DAY_OF_WEEK_ENCLOSURE_ANGLE, ValueProperties.DAY_OF_WEEK_ENCLOSURE_SQUARED

getDayOfWeekEnclosureFormula

public final FormulaField getDayOfWeekEnclosureFormula()

Returns the formula for the property 'day of week enclosure'.

Specified by:

getDayOfWeekEnclosureFormula in interface ValueProperties

Returns:

The formula for the property 'day of week enclosure'.

setDayOfWeekEnclosureFormula

public final void setDayOfWeekEnclosureFormula(FormulaField newFormula)

Sets the formula for the property 'day of week enclosure'. Use this property to specify the enclosure of the week day name.

Specified by:

setDayOfWeekEnclosureFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'week day enclosure'.

setDayOfWeekSeparator

public final void setDayOfWeekSeparator(java.lang.String newValue)

Sets the value of the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.

Specified by:

setDayOfWeekSeparator in interface ValueProperties

Parameters:

newValue - The new value of the property 'day of week separator'.

Since:

6.1

getDayOfWeekSeparator

public final java.lang.String getDayOfWeekSeparator()

Returns the value of the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.

Specified by:

getDayOfWeekSeparator in interface ValueProperties

Returns:

The current value of the property 'day of week separator'.

Since:

6.1

setDayOfWeekSeparatorFormula

public final void setDayOfWeekSeparatorFormula(FormulaField newFormula)

Sets the formula for the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.

Specified by:

setDayOfWeekSeparatorFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'day of week separator'.

Since:

6.1

getDayOfWeekSeparatorFormula

public final FormulaField getDayOfWeekSeparatorFormula()

Returns the formula for the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.

Specified by:

getDayOfWeekSeparatorFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'day of week separator'.

Since:

6.1

getDayOfWeekType

public final int getDayOfWeekType()

Returns the value of the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.

Specified by:

getDayOfWeekType in interface ValueProperties

Returns:

The value of the property 'day of week type'.

See Also:

ValueProperties.SHORT_DAY_OF_WEEK, ValueProperties.LONG_DAY_OF_WEEK, ValueProperties.NO_DAY_OF_WEEK

setDayOfWeekType

public final void setDayOfWeekType(int newValue)

Sets the value of the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.

Specified by:

setDayOfWeekType in interface ValueProperties

Parameters:

newValue - The new value of the property 'day of week type'.

See Also:

ValueProperties.SHORT_DAY_OF_WEEK, ValueProperties.LONG_DAY_OF_WEEK, ValueProperties.NO_DAY_OF_WEEK

getDayOfWeekTypeFormula

public final FormulaField getDayOfWeekTypeFormula()

Returns the formula for the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.

Specified by:

getDayOfWeekTypeFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'day of week type'.

setDayOfWeekTypeFormula

public final void setDayOfWeekTypeFormula(FormulaField newFormula)

Sets the formula for the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.

Specified by:

setDayOfWeekTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'day of week type'. The result of the formula should be in range from 0 to 2.

See Also:

ValueProperties.SHORT_DAY_OF_WEEK, ValueProperties.LONG_DAY_OF_WEEK, ValueProperties.NO_DAY_OF_WEEK

getDateOrder

public final int getDateOrder()

Returns the value of the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.

Specified by:

getDateOrder in interface ValueProperties

Returns:

The value of the property 'date order'.

See Also:

ValueProperties.YEAR_MONTH_DAY, ValueProperties.DAY_MONTH_YEAR, ValueProperties.MONTH_DAY_YEAR

setDateOrder

public final void setDateOrder(int newValue)

Sets the value of the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.

Specified by:

setDateOrder in interface ValueProperties

Parameters:

newValue - The new value of the property 'date order'.

See Also:

ValueProperties.YEAR_MONTH_DAY, ValueProperties.DAY_MONTH_YEAR, ValueProperties.MONTH_DAY_YEAR

getDateOrderFormula

public final FormulaField getDateOrderFormula()

Returns the formula for the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.

Specified by:

getDateOrderFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'date order'.

setDateOrderFormula

public final void setDateOrderFormula(FormulaField newFormula)

Sets the formula for the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.

Specified by:

setDateOrderFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'date order'. The result of the formula should be in range from 0 to 2.

See Also:

ValueProperties.YEAR_MONTH_DAY, ValueProperties.DAY_MONTH_YEAR, ValueProperties.MONTH_DAY_YEAR

getDatePrefixSeparator

public final java.lang.String getDatePrefixSeparator()

Returns the value of the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.

Specified by:

getDatePrefixSeparator in interface ValueProperties

Returns:

The value of the property 'date prefix separator'.

Since:

6.1

setDatePrefixSeparator

public final void setDatePrefixSeparator(java.lang.String newValue)

Sets the value of the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.

Specified by:

setDatePrefixSeparator in interface ValueProperties

Parameters:

newValue - The new value of the property 'date prefix separator'.

Since:

6.1

getDatePrefixSeparatorFormula

public final FormulaField getDatePrefixSeparatorFormula()

Returns the formula for the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.

Specified by:

getDatePrefixSeparatorFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'date prefix separator'.

Since:

6.1

setDatePrefixSeparatorFormula

public final void setDatePrefixSeparatorFormula(FormulaField newFormula)

Sets the formula for the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.

Specified by:

setDatePrefixSeparatorFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'date prefix separator'.

Since:

6.1

getDateFirstSeparator

public final java.lang.String getDateFirstSeparator()

Returns the value of the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.

Specified by:

getDateFirstSeparator in interface ValueProperties

Returns:

The value of the property 'date firts separator'.

Since:

6.1

setDateFirstSeparator

public final void setDateFirstSeparator(java.lang.String newValue)

Sets the value of the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.

Specified by:

setDateFirstSeparator in interface ValueProperties

Parameters:

newValue - The new value of the property 'date first separator'.

Since:

6.1

getDateFirstSeparatorFormula

public final FormulaField getDateFirstSeparatorFormula()

Returns the formula for the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.

Specified by:

getDateFirstSeparatorFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'date first separator'.

Since:

6.1

setDateFirstSeparatorFormula

public final void setDateFirstSeparatorFormula(FormulaField newFormula)

Sets the formula for the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.

Specified by:

setDateFirstSeparatorFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'date first separator'.

Since:

6.1

getDateSecondSeparator

public final java.lang.String getDateSecondSeparator()

Returns the value of the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.

Specified by:

getDateSecondSeparator in interface ValueProperties

Returns:

The value of the property 'date second separator'.

Since:

6.1

setDateSecondSeparator

public final void setDateSecondSeparator(java.lang.String newValue)

Sets the value of the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.

Specified by:

setDateSecondSeparator in interface ValueProperties

Parameters:

newValue - The new value of the property 'date second separator'.

Since:

6.1

getDateSecondSeparatorFormula

public final FormulaField getDateSecondSeparatorFormula()

Returns the formula for the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.

Specified by:

getDateSecondSeparatorFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'date second separator'.

Since:

6.1

setDateSecondSeparatorFormula

public final void setDateSecondSeparatorFormula(FormulaField newFormula)

Sets the formula for the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.

Specified by:

setDateSecondSeparatorFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'date second separator'.

Since:

6.1

getDateSuffixSeparator

public final java.lang.String getDateSuffixSeparator()

Returns the value of the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.

Specified by:

getDateSuffixSeparator in interface ValueProperties

Returns:

The value of the property 'date suffix separator'.

Since:

6.1

setDateSuffixSeparator

public final void setDateSuffixSeparator(java.lang.String newValue)

Sets the value of the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.

Specified by:

setDateSuffixSeparator in interface ValueProperties

Parameters:

newValue - The new value of the property 'date suffix separator'.

Since:

6.1

getDateSuffixSeparatorFormula

public final FormulaField getDateSuffixSeparatorFormula()

Returns the formula for the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.

Specified by:

getDateSuffixSeparatorFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'date suffix separator'.

Since:

6.1

setDateSuffixSeparatorFormula

public final void setDateSuffixSeparatorFormula(FormulaField newFormula)

Sets the formula for the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.

Specified by:

setDateSuffixSeparatorFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'date suffix separator'.

Since:

6.1

setDateTimeOrder

public final void setDateTimeOrder(int newValue)

Sets the value of the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.

Specified by:

setDateTimeOrder in interface ValueProperties

Parameters:

newValue - The new value of the property 'date time order'.

See Also:

ValueProperties.DATE_TIME_ORDER, ValueProperties.TIME_DATE_ORDER, ValueProperties.DATE_ONLY_ORDER, ValueProperties.TIME_ONLY_ORDER

getDateTimeOrder

public final int getDateTimeOrder()

Returns the value of the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.

Specified by:

getDateTimeOrder in interface ValueProperties

Returns:

The value of the property 'date time order'.

See Also:

ValueProperties.DATE_TIME_ORDER, ValueProperties.TIME_DATE_ORDER, ValueProperties.DATE_ONLY_ORDER, ValueProperties.TIME_ONLY_ORDER

setDateTimeOrderFormula

public final void setDateTimeOrderFormula(FormulaField newFormula)

Sets the formula for the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.

Specified by:

setDateTimeOrderFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'date time order'.

See Also:

ValueProperties.DATE_TIME_ORDER, ValueProperties.TIME_DATE_ORDER, ValueProperties.DATE_ONLY_ORDER, ValueProperties.TIME_ONLY_ORDER

getDateTimeOrderFormula

public final FormulaField getDateTimeOrderFormula()

Returns the formula for the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.

Specified by:

getDateTimeOrderFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'date time order'.

See Also:

ValueProperties.DATE_TIME_ORDER, ValueProperties.TIME_DATE_ORDER, ValueProperties.DATE_ONLY_ORDER, ValueProperties.TIME_ONLY_ORDER

setDateTimeSeparator

public final void setDateTimeSeparator(java.lang.String newValue)

Sets the value of the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.

Specified by:

setDateTimeSeparator in interface ValueProperties

Parameters:

newValue - The new value of the property 'date time separator'.

Since:

6.1

getDateTimeSeparator

public final java.lang.String getDateTimeSeparator()

Returns the value of the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.

Specified by:

getDateTimeSeparator in interface ValueProperties

Returns:

The value of the property 'date time separator'.

Since:

6.1

setDateTimeSeparatorFormula

public final void setDateTimeSeparatorFormula(FormulaField newFormula)

Sets the formula for the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.

Specified by:

setDateTimeSeparatorFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'date time separator'.

Since:

6.1

getDateTimeSeparatorFormula

public final FormulaField getDateTimeSeparatorFormula()

Returns the formula for the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.

Specified by:

getDateTimeSeparatorFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'date time separator'.

Since:

6.1

getBooleanFormatOutputType

public final int getBooleanFormatOutputType()

Returns the value of the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or fasle.

Specified by:

getBooleanFormatOutputType in interface ValueProperties

Returns:

The value of the property 'boolean format output type'.

See Also:

ValueProperties.TRUE_OR_FALSE, ValueProperties.T_OR_F, ValueProperties.YES_OR_NO, ValueProperties.Y_OR_N, ValueProperties.ONE_OR_ZERO

setBooleanFormatOutputType

public final void setBooleanFormatOutputType(int newValue)

Sets the value of the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or fasle.

Specified by:

setBooleanFormatOutputType in interface ValueProperties

Parameters:

newValue - The new value for the property 'boolean format output type'.

See Also:

ValueProperties.TRUE_OR_FALSE, ValueProperties.T_OR_F, ValueProperties.YES_OR_NO, ValueProperties.Y_OR_N, ValueProperties.ONE_OR_ZERO

setBooleanFormatOutputTypeFormula

public final void setBooleanFormatOutputTypeFormula(FormulaField newFormula)

Sets the formula for the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or fasle.

Specified by:

setBooleanFormatOutputTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'boolean format output type'. The result of the formula should be in range from 0 to 4.

See Also:

ValueProperties.TRUE_OR_FALSE, ValueProperties.T_OR_F, ValueProperties.YES_OR_NO, ValueProperties.Y_OR_N, ValueProperties.ONE_OR_ZERO

getBooleanFormatTypeFormula

public final FormulaField getBooleanFormatTypeFormula()

Returns the formula for the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or fasle.

Specified by:

getBooleanFormatTypeFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'boolean format output type'.

getBooleanFormatOutputTypeFormula

public final FormulaField getBooleanFormatOutputTypeFormula()

Returns the formula for the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or false.

Specified by:

getBooleanFormatOutputTypeFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'boolean format output type'.

getCurrencyPosition

public int getCurrencyPosition()

Returns the value of the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency inside negative.

Specified by:

getCurrencyPosition in interface ValueProperties

Returns:

The value of the property 'currency position type'.

See Also:

ValueProperties.LEADING_CURRENCY_INSIDE_NEGATIVE, ValueProperties.LEADING_CURRENCY_OUTSIDE_NEGATIVE, ValueProperties.TRAILING_CURRENCY_INSIDE_NEGATIVE, ValueProperties.TRAILING_CURRENCY_OUTSIDE_NEGATIVE

setCurrencyPosition

public final void setCurrencyPosition(int newValue)

Sets the value of the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency outside negative.

Specified by:

setCurrencyPosition in interface ValueProperties

Parameters:

newValue - The new value of the property 'currency position type'.

See Also:

ValueProperties.LEADING_CURRENCY_INSIDE_NEGATIVE, ValueProperties.LEADING_CURRENCY_OUTSIDE_NEGATIVE, ValueProperties.TRAILING_CURRENCY_INSIDE_NEGATIVE, ValueProperties.TRAILING_CURRENCY_OUTSIDE_NEGATIVE

getCurrencyPositionFormula

public final FormulaField getCurrencyPositionFormula()

Returns the formula for the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency inside negative.

Specified by:

getCurrencyPositionFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'currency position type'.

setCurrencyPositionFormula

public final void setCurrencyPositionFormula(FormulaField newFormula)

Sets the formula for the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency inside negative.

Specified by:

setCurrencyPositionFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'currency position type', where the result of the formula should be in range 0 to 3.

See Also:

ValueProperties.LEADING_CURRENCY_INSIDE_NEGATIVE, ValueProperties.LEADING_CURRENCY_OUTSIDE_NEGATIVE, ValueProperties.TRAILING_CURRENCY_INSIDE_NEGATIVE, ValueProperties.TRAILING_CURRENCY_OUTSIDE_NEGATIVE

setCurrencySymbol

public void setCurrencySymbol(java.lang.String newValue)

Sets the value of the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.

Specified by:

setCurrencySymbol in interface ValueProperties

Parameters:

newValue - The new value of the property 'currency symbol'.

getCurrencySymbol

public java.lang.String getCurrencySymbol()

Returns the value of the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.

Specified by:

getCurrencySymbol in interface ValueProperties

Returns:

The value of the property 'currency symbol'.

setCurrencySymbolFormula

public final void setCurrencySymbolFormula(FormulaField newFormula)

Sets the formula for the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.

Specified by:

setCurrencySymbolFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'currency symbol'.

getCurrencySymbolFormula

public final FormulaField getCurrencySymbolFormula()

Returns the formula for the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.

Specified by:

getCurrencySymbolFormula in interface ValueProperties

Returns:

Formula field for the property "currency symbol"

setCurrencySymbolType

public void setCurrencySymbolType(int newValue)

Sets the value of the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.

Specified by:

setCurrencySymbolType in interface ValueProperties

Parameters:

newValue - The new value of the property 'currency symbol type'.

See Also:

ValueProperties.NO_SYMBOL, ValueProperties.FIXED_SYMBOL, ValueProperties.FLOATING_SYMBOL

getCurrencySymbolType

public int getCurrencySymbolType()

Returns the value of the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.

Specified by:

getCurrencySymbolType in interface ValueProperties

Returns:

The value of the property 'currency symbol type'.

See Also:

ValueProperties.NO_SYMBOL, ValueProperties.FIXED_SYMBOL, ValueProperties.FLOATING_SYMBOL

setCurrencySymbolTypeFormula

public final void setCurrencySymbolTypeFormula(FormulaField newFormula)

Sets the formula for the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.

Specified by:

setCurrencySymbolTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'currency symbol type'. The result of the formula should be in range from 0 to 2.

See Also:

ValueProperties.NO_SYMBOL, ValueProperties.FIXED_SYMBOL, ValueProperties.FLOATING_SYMBOL

getCurrencySymbolTypeFormula

public final FormulaField getCurrencySymbolTypeFormula()

Returns the formula for the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.

Specified by:

getCurrencySymbolTypeFormula in interface ValueProperties

Returns:

Formula Field for the property "currency symbol type"

setUseOneCurrencySymbolPerPage

public final void setUseOneCurrencySymbolPerPage(boolean newValue)

Sets the value of the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.

Specified by:

setUseOneCurrencySymbolPerPage in interface ValueProperties

Parameters:

newValue - The new value of the property 'use one currency symbol per page'.

getUseOneCurrencySymbolPerPage

public final boolean getUseOneCurrencySymbolPerPage()

Returns the value of the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.

Specified by:

getUseOneCurrencySymbolPerPage in interface ValueProperties

Returns:

The value of the property 'use one currency symbol per page'.

setUseOneCurrencySymbolPerPageFormula

public final void setUseOneCurrencySymbolPerPageFormula(FormulaField newFormula)

Sets the formula for the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.

Specified by:

setUseOneCurrencySymbolPerPageFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'use one currency symbol per page'.

getUseOneCurrencySymbolPerPageFormula

public final FormulaField getUseOneCurrencySymbolPerPageFormula()

Returns the formula for the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.

Specified by:

getUseOneCurrencySymbolPerPageFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'use one currency symbol per page'.

getNDecimalPlaces

public final int getNDecimalPlaces()

Returns the value of the property 'n decimal places'. This property allows you to set the number of decimal places (possible values are 0 to 10). Note that if your number format is a system default it is possible that your system default will override any manual setting here. In this case, set the number format type to 'use custom format' if you want your own settings.

Specified by:

getNDecimalPlaces in interface ValueProperties

Returns:

The value of the property 'n decimal places'.

See Also:

ValueProperties.getRoundingType(), ValueProperties.setNumberFormatType(int)

setNDecimalPlaces

public final void setNDecimalPlaces(int newValue)

Sets the value of the property 'n decimal places'. This property allows you to set the number of decimal places (possible values are 0 to 10). Note that if your number format is a system default it is possible that your system default will override any manual setting here. In this case, set the number format type to 'use custom format' if you want your own settings.

Specified by:

setNDecimalPlaces in interface ValueProperties

Parameters:

newValue - The new value of the property 'n decimal places'.

See Also:

ValueProperties.getRoundingType(), ValueProperties.setNumberFormatType(int)

getNDecimalPlacesFormula

public final FormulaField getNDecimalPlacesFormula()

Returns the formula for the property 'n decimal places'. This property allows you to set the number of decimal places (possible values are 0 to 10). Note that if your number format is a system default it is possible that your system default will override any manual setting here. In this case, set the number format type to 'use custom format' if you want your own settings.

Specified by:

getNDecimalPlacesFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'n decimal places'.

See Also:

ValueProperties.setNumberFormatType(int)

setNDecimalPlacesFormula

public final void setNDecimalPlacesFormula(FormulaField newFormula)

Sets the formula for the property 'n decimal places'. This property allows you to set the number of decimal places (possible values are 0 to 10). Note that if your number format is a system default it is possible that your system default will override any manual setting here. In this case, set the number format type to 'use custom format' if you want your own settings.

Specified by:

setNDecimalPlacesFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'n decimal places'.

See Also:

ValueProperties.setNumberFormatType(int)

getDecimalSeparatorSymbol

public final java.lang.String getDecimalSeparatorSymbol()

Returns the value of the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.

Specified by:

getDecimalSeparatorSymbol in interface ValueProperties

Returns:

The value of the property 'decimal separators symbol'.

Since:

6.1

setDecimalSeparatorSymbol

public final void setDecimalSeparatorSymbol(java.lang.String newValue)

Sets the value of the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.

Specified by:

setDecimalSeparatorSymbol in interface ValueProperties

Parameters:

newValue - The new value of the property 'decimal separators symbol'.

Since:

6.1

getDecimalSeparatorSymbolFormula

public final FormulaField getDecimalSeparatorSymbolFormula()

Returns the formula for the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.

Specified by:

getDecimalSeparatorSymbolFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'decimal separators symbol'.

Since:

6.1

setDecimalSeparatorSymbolFormula

public final void setDecimalSeparatorSymbolFormula(FormulaField newFormula)

Sets the formula for the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.

Specified by:

setDecimalSeparatorSymbolFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'decimal separators symbol'.

Since:

6.1

setReverseSignForDisplay

public final void setReverseSignForDisplay(boolean newValue)

Sets the property 'use reverse sign for display'.

Specified by:

setReverseSignForDisplay in interface ValueProperties

Parameters:

newValue - New value for the property 'use reverse sign for display'.

isReverseSignForDisplay

public final boolean isReverseSignForDisplay()

Checks the property 'use reverse sign for display'

Specified by:

isReverseSignForDisplay in interface ValueProperties

Returns:

Whether the property 'use reverse sign for display' is on or off.

Since:

7.0

getReverseSignForDisplayFormula

public final FormulaField getReverseSignForDisplayFormula()

Returns the formula for the property 'use reverse sign for display'.

Specified by:

getReverseSignForDisplayFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'use reverse sign for display'.

setReverseSignForDisplayFormula

public final void setReverseSignForDisplayFormula(FormulaField newFormula)

Sets the formula for the property 'use reverse sign for display'.

Specified by:

setReverseSignForDisplayFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'use reverse sign for display'.

setSuppressIfZero

public final void setSuppressIfZero(boolean newValue)

Sets the value of the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.

Specified by:

setSuppressIfZero in interface ValueProperties

Parameters:

newValue - The new value of the property 'suppress if zero'.

getSuppressIfZero

public final boolean getSuppressIfZero()

Returns the value of the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.

Specified by:

getSuppressIfZero in interface ValueProperties

Returns:

The value of the property 'suppress if zero'.

setSuppressIfZeroFormula

public final void setSuppressIfZeroFormula(FormulaField newFormula)

Sets the formula for the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.

Specified by:

setSuppressIfZeroFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'suppress if zero'.

getSuppressIfZeroFormula

public final FormulaField getSuppressIfZeroFormula()

Returns the formula for the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.

Specified by:

getSuppressIfZeroFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'suppress if zero'.

setUseThousandsSeparator

public final void setUseThousandsSeparator(boolean newValue)

Sets the value of the property 'use thousands separator'. When this property is enabled a sepearator sysmbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.

Specified by:

setUseThousandsSeparator in interface ValueProperties

Parameters:

newValue - The new value of the property 'use thousands separator'.

Since:

6.1

getUseThousandsSeparator

public final boolean getUseThousandsSeparator()

Returns the value of the property 'use thousands separator'. When this property is enabled a sepearator symbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.

Specified by:

getUseThousandsSeparator in interface ValueProperties

Returns:

The value of the property 'use thousands separator'.

Since:

6.1

setUseThousandsSeparatorFormula

public final void setUseThousandsSeparatorFormula(FormulaField newFormula)

Sets the formula for the property 'use thousands separator'. When this property is enabled a sepearator symbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.

Specified by:

setUseThousandsSeparatorFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'use thousands separator'.

Since:

6.1

getUseThousandsSeparatorFormula

public final FormulaField getUseThousandsSeparatorFormula()

Returns the formula for the property 'use thousands separator'. When this property is enabled a sepearator symbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.

Specified by:

getUseThousandsSeparatorFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'use thousands separator'.

Since:

6.1

setThousandsSeparatorSymbol

public final void setThousandsSeparatorSymbol(java.lang.String newValue)

Sets the value of the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.

Specified by:

setThousandsSeparatorSymbol in interface ValueProperties

Parameters:

newValue - The new value of the property 'thousands separator symbol'.

Since:

6.1

getThousandsSeparatorSymbol

public final java.lang.String getThousandsSeparatorSymbol()

Returns the value of the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.

Specified by:

getThousandsSeparatorSymbol in interface ValueProperties

Returns:

The value of the property 'thousands separator symbol'.

Since:

6.1

setThousandsSeparatorSymbolFormula

public final void setThousandsSeparatorSymbolFormula(FormulaField newFormula)

Sets the formula for the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.

Specified by:

setThousandsSeparatorSymbolFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'thousands separator symbol'.

Since:

6.1

getThousandsSeparatorSymbolFormula

public final FormulaField getThousandsSeparatorSymbolFormula()

Returns the formula for the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.

Specified by:

getThousandsSeparatorSymbolFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'thousands separator symbol'.

Since:

6.1

setRoundingDigits

@Deprecated
public final void setRoundingDigits(int digits)

Deprecated. As of i-net Crystal-Clear 10, this has been replaced with setRounding(int)

Sets the count of visible digits before and after the decimal point with no need to use of the rounding type constants. If you want round after the decimal point then use negative numbers. If you want round before the decimal point then use positive numbers. I.e. to round a number value to millions use 6. To round a number value to millionth use -6.

Specified by:

setRoundingDigits in interface ValueProperties

Parameters:

digits - the count of rounding digits.

See Also:

ValueProperties.getRoundingDigits(), ValueProperties.setRoundingType(int), ValueProperties.getRoundingType()

getRoundingDigits

@Deprecated
public final int getRoundingDigits()

Deprecated. As of i-net Crystal-Clear 10, this has been replaced with getRounding()

Returns the count of rounding digits.

Specified by:

getRoundingDigits in interface ValueProperties

Returns:

the count of rounding digits.

See Also:

ValueProperties.setRoundingDigits(int), ValueProperties.setRoundingType(int), ValueProperties.getRoundingType()

setRoundingType

@Deprecated
public final void setRoundingType(int newValue)

Deprecated. As of i-net Crystal-Clear 10, this has been replaced with setRounding(int)

Sets the rounding type. If 'use system default' is disabled, it set the number of digits to round to. If the count of decimal places is smaller then this value has no effect.

Specified by:

setRoundingType in interface ValueProperties

Parameters:

newValue - rounding type. This type value is not the count of digits.

See Also:

ValueProperties.getNDecimalPlaces(), ValueProperties.ROUND_TO_TEN_BILLIONTH, ValueProperties.ROUND_TO_BILLIONTH, ValueProperties.ROUND_TO_HUNDRED_MILLIONTH, ValueProperties.ROUND_TO_TEN_MILLIONTH, ValueProperties.ROUND_TO_MILLIONTH, ValueProperties.ROUND_TO_HUNDRED_THOUSANDTH, ValueProperties.ROUND_TO_TEN_THOUSANDTH, ValueProperties.ROUND_TO_THOUSANDTH, ValueProperties.ROUND_TO_HUNDRETH, ValueProperties.ROUND_TO_TENTH, ValueProperties.ROUND_TO_UNIT, ValueProperties.ROUND_TO_TEN, ValueProperties.ROUND_TO_HUNDRED, ValueProperties.ROUND_TO_THOUSAND, ValueProperties.ROUND_TO_TEN_THOUSAND, ValueProperties.ROUND_TO_HUNDRED_THOUSAND, ValueProperties.ROUND_TO_MILLION

getRoundingType

@Deprecated
public final int getRoundingType()

Deprecated. As of i-net Crystal-Clear 10, this has been replaced with getRounding()

Returns the value of the property 'rounding type'. When property 'use system default' is disabled, you can set the numbers of digits to round to.

Specified by:

getRoundingType in interface ValueProperties

Returns:

The current value of the property 'rounding type'.

See Also:

ValueProperties.getNDecimalPlaces(), ValueProperties.ROUND_TO_TEN_BILLIONTH, ValueProperties.ROUND_TO_BILLIONTH, ValueProperties.ROUND_TO_HUNDRED_MILLIONTH, ValueProperties.ROUND_TO_TEN_MILLIONTH, ValueProperties.ROUND_TO_MILLIONTH, ValueProperties.ROUND_TO_HUNDRED_THOUSANDTH, ValueProperties.ROUND_TO_TEN_THOUSANDTH, ValueProperties.ROUND_TO_THOUSANDTH, ValueProperties.ROUND_TO_HUNDRETH, ValueProperties.ROUND_TO_TENTH, ValueProperties.ROUND_TO_UNIT, ValueProperties.ROUND_TO_TEN, ValueProperties.ROUND_TO_HUNDRED, ValueProperties.ROUND_TO_THOUSAND, ValueProperties.ROUND_TO_TEN_THOUSAND, ValueProperties.ROUND_TO_HUNDRED_THOUSAND, ValueProperties.ROUND_TO_MILLION

setRounding

public void setRounding(int newValue)

Sets which digit to round the number to. In order to round after the decimal point, use negative numbers. Otherwise use positive numbers. Examples would be "-6" for rounding to millionth, "2" for rounding to hundreds, "0" for rounding to whole numbers.

Specified by:

setRounding in interface ValueProperties

Parameters:

newValue - position of digit to round to: negative numbers for after the decimal point, positive for before

getRounding

public int getRounding()

Returns which digit to round the number to. Examples would be "-6" for rounding to millionth, "2" for rounding to hundreds, "0" for rounding to whole numbers.

Specified by:

getRounding in interface ValueProperties

Returns:

digits position of digit to round to: negative numbers for after the decimal point, positive for before

setRoundingFormula

public void setRoundingFormula(FormulaField newFormula)

Sets the formula which provides the digit to round the number to. In order to round after the decimal point, use positive numbers. Otherwise use negative numbers. Examples would be "6" for rounding to millionth, "-2" for rounding to hundreds, "0" for rounding to whole numbers.

Specified by:

setRoundingFormula in interface ValueProperties

Parameters:

newFormula - formula providing the digits position of digit to round to: positive numbers for after the decimal point, negative for before

getRoundingFormula

public FormulaField getRoundingFormula()

Returns the formula which provides the digit to round the number to. In order to round after the decimal point, use positive numbers. Otherwise use negative numbers. Examples would be "6" for rounding to millionth, "-2" for rounding to hundreds, "0" for rounding to whole numbers.

Specified by:

getRoundingFormula in interface ValueProperties

Returns:

The formula providing the digits position of digit to round to: positive numbers for after the decimal point, negative for before

setRoundingTypeFormula

@Deprecated
public final void setRoundingTypeFormula(FormulaField newFormula)

Deprecated. As of i-net Crystal-Clear 10, this has been replaced with setRoundingFormula(FormulaField)

Sets the formula for the property 'rounding type'. When property 'use system default' is disabled, you can set the numbers of digits to round to.

Specified by:

setRoundingTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'rounding type'. The result of the formula should be in range from -10 to 6.

getRoundingTypeFormula

@Deprecated
public final FormulaField getRoundingTypeFormula()

Deprecated. As of i-net Crystal-Clear 10, this has been replaced with getRoundingFormula()

Returns the formula for the property 'rounding type'. When property 'use system default' is disabled, you can set the numbers of digits to round to.

Specified by:

getRoundingTypeFormula in interface ValueProperties

Returns:

The formula for the property 'rounding type'.

setRoundingMode

public final void setRoundingMode(int newValue)

Sets the rounding mode. The default mode is ROUND_HALF_EVEN. This property has only an effect if 'use system default' is disabled.

Specified by:

setRoundingMode in interface ValueProperties

Parameters:

newValue - the rounding mode to be used for rounding numbers.

See Also:

ValueProperties.ROUND_CEILING, ValueProperties.ROUND_DOWN, ValueProperties.ROUND_FLOOR, ValueProperties.ROUND_HALF_DOWN, ValueProperties.ROUND_HALF_EVEN, ValueProperties.ROUND_HALF_UP, ValueProperties.ROUND_UP, ValueProperties.getRoundingMode(), ValueProperties.setRoundingModeFormula(com.inet.report.FormulaField)

getRoundingMode

public final int getRoundingMode()

Returns the rounding mode for this element.

Specified by:

getRoundingMode in interface ValueProperties

Returns:

the current rounding mode

See Also:

ValueProperties.ROUND_CEILING, ValueProperties.ROUND_DOWN, ValueProperties.ROUND_FLOOR, ValueProperties.ROUND_HALF_DOWN, ValueProperties.ROUND_HALF_EVEN, ValueProperties.ROUND_HALF_UP, ValueProperties.ROUND_UP, ValueProperties.setRoundingMode(int)

setRoundingModeFormula

public final void setRoundingModeFormula(FormulaField newFormula)

Sets the formula for the property 'rounding mode'. When property 'use system default' is disabled, you can set the rounding algorithm.

Specified by:

setRoundingModeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'rounding type'. The result of the formula should be in range from 0 to 7.

See Also:

ValueProperties.ROUND_CEILING, ValueProperties.ROUND_DOWN, ValueProperties.ROUND_FLOOR, ValueProperties.ROUND_HALF_DOWN, ValueProperties.ROUND_HALF_EVEN, ValueProperties.ROUND_HALF_UP, ValueProperties.ROUND_UP, ValueProperties.setRoundingMode(int)

getRoundingModeFormula

public final FormulaField getRoundingModeFormula()

Returns the formula for the rounding mode, can be null if the formula is not set.

Specified by:

getRoundingModeFormula in interface ValueProperties

Returns:

the formula or null if not set.

See Also:

ValueProperties.setRoundingModeFormula(com.inet.report.FormulaField)

setNegativeType

public void setNegativeType(int newValue)

Sets the value of the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.

Specified by:

setNegativeType in interface ValueProperties

Parameters:

newValue - The new value of the property 'negative type'.

See Also:

ValueProperties.NOT_NEGATIVE, ValueProperties.LEADING_MINUS, ValueProperties.TRAILING_MINUS, ValueProperties.BRACKETED

getNegativeType

public int getNegativeType()

Returns the value of the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.

Specified by:

getNegativeType in interface ValueProperties

Returns:

The current value of the property 'negative type'.

See Also:

ValueProperties.NOT_NEGATIVE, ValueProperties.LEADING_MINUS, ValueProperties.TRAILING_MINUS, ValueProperties.BRACKETED

setNegativeTypeFormula

public void setNegativeTypeFormula(FormulaField newFormula)

Sets the formula for the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.

Specified by:

setNegativeTypeFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'negative type'. The result of the formula should be in range from 0 to 3.

See Also:

ValueProperties.NOT_NEGATIVE, ValueProperties.LEADING_MINUS, ValueProperties.TRAILING_MINUS, ValueProperties.BRACKETED

getNegativeTypeFormula

public FormulaField getNegativeTypeFormula()

Returns the formula for the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.

Specified by:

getNegativeTypeFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'negative type'.

setUseLeadingZero

public final void setUseLeadingZero(boolean newValue)

Sets the value of the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).

Specified by:

setUseLeadingZero in interface ValueProperties

Parameters:

newValue - The new value of the property 'use leading zero'.

getUseLeadingZero

public final boolean getUseLeadingZero()

Returns the value of the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).

Specified by:

getUseLeadingZero in interface ValueProperties

Returns:

The value of the property 'use leading zero'.

setUseLeadingZeroFormula

public final void setUseLeadingZeroFormula(FormulaField newFormula)

Sets the formula for the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).

Specified by:

setUseLeadingZeroFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'use leading zero'.

getUseLeadingZeroFormula

public final FormulaField getUseLeadingZeroFormula()

Returns the formula for the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).

Specified by:

getUseLeadingZeroFormula in interface ValueProperties

Returns:

FormulaField The formula for the property 'use leading zero'.

setZeroValueString

public final void setZeroValueString(java.lang.String newValue)

Sets the value of the property 'zero value string'. If the value is null then there will be no custom zero value.

Specified by:

setZeroValueString in interface ValueProperties

Parameters:

newValue - The new value of the property 'zero value string'.

getZeroValueString

public final java.lang.String getZeroValueString()

Returns the value of the property 'zero value string'.

Specified by:

getZeroValueString in interface ValueProperties

Returns:

The value of the property 'zero value string'.

setNumeralLanguage

public final void setNumeralLanguage(int language)

Sets the language of the numerals in number, date, time or datetime values.

Specified by:

setNumeralLanguage in interface ValueProperties

Parameters:

language - one of the language constant values or -1 for the default of the current report and locale.

See Also:

Engine.setLocale(java.util.Locale), Engine.setNumeralLanguage(int), ValueProperties.getNumeralLanguage(), ValueProperties.NUMERAL_LANGUAGE_EUROPEAN, ValueProperties.NUMERAL_LANGUAGE_ARABIC, ValueProperties.NUMERAL_LANGUAGE_EASTERN_ARABIC, ValueProperties.NUMERAL_LANGUAGE_DEVANAGARI, ValueProperties.NUMERAL_LANGUAGE_BENGALI, ValueProperties.NUMERAL_LANGUAGE_GURMUKHI, ValueProperties.NUMERAL_LANGUAGE_GUJARATI, ValueProperties.NUMERAL_LANGUAGE_ORIYA, ValueProperties.NUMERAL_LANGUAGE_TAMIL, ValueProperties.NUMERAL_LANGUAGE_TELUGU, ValueProperties.NUMERAL_LANGUAGE_KANNADA, ValueProperties.NUMERAL_LANGUAGE_MALAYALAM, ValueProperties.NUMERAL_LANGUAGE_THAI, ValueProperties.NUMERAL_LANGUAGE_LAO, ValueProperties.NUMERAL_LANGUAGE_TIBETAN, ValueProperties.NUMERAL_LANGUAGE_MYANMAR, ValueProperties.NUMERAL_LANGUAGE_ETHIOPIC, ValueProperties.NUMERAL_LANGUAGE_KHMER, ValueProperties.NUMERAL_LANGUAGE_MONGOLIAN

getNumeralLanguage

public final int getNumeralLanguage()

Returns the language of numerals for numbers, date, time and datetime values.

Specified by:

getNumeralLanguage in interface ValueProperties

Returns:

One of the language constant or -1 for the report and locale default.

See Also:

ValueProperties.setNumeralLanguage(int)

setAllowFieldClipping

public final void setAllowFieldClipping(boolean newValue)

Sets the value of the property 'allow field clipping'. When this property is enabled and the number value of the field is larger then the clip rectangle then the value is cutting. If it is disable then only a count of number sign '#' are printed in the clip rectangle.

Specified by:

setAllowFieldClipping in interface ValueProperties

Parameters:

newValue - The new value of the property.

See Also:

isAllowFieldClipping(), setAllowFieldClippingFormula(FormulaField)

isAllowFieldClipping

public final boolean isAllowFieldClipping()

Returns true if allow field clipping is enabled, else false is returned.

Specified by:

isAllowFieldClipping in interface ValueProperties

Returns:

whether field clipping is allowed for this field.

Since:

7.0

setAllowFieldClippingFormula

public final void setAllowFieldClippingFormula(FormulaField newField)

Set the formula for the property 'allow field clipping'.

Specified by:

setAllowFieldClippingFormula in interface ValueProperties

Parameters:

newField - Formula Field to set for the property "allow field clipping"

See Also:

setAllowFieldClipping(boolean), getAllowFieldClippingFormula()

getAllowFieldClippingFormula

public final FormulaField getAllowFieldClippingFormula()

Get the formula for the property 'allow field clipping'.

Specified by:

getAllowFieldClippingFormula in interface ValueProperties

Returns:

Formula Field for the property "allow field clipping"

See Also:

setAllowFieldClipping(boolean), setAllowFieldClippingFormula(com.inet.report.FormulaField)

getCurrencySeparator

public final java.lang.String getCurrencySeparator()

Returns the separator between the number value and currency symbol. The default value for this property is an space character.

Specified by:

getCurrencySeparator in interface ValueProperties

Returns:

The separator to be displayed between the number value and the currency value.

Since:

7.0

setCurrencySeparator

public final void setCurrencySeparator(java.lang.String newCurrencySeparator)

Sets the separator to be displayed between the number value and the currency value.

Specified by:

setCurrencySeparator in interface ValueProperties

Parameters:

newCurrencySeparator - The separator to be used between number value and currency symbol.

Since:

7.0

getCurrencySeparatorFormula

public final FormulaField getCurrencySeparatorFormula()

Returns the formula for the property 'currency separator'. If this formula is not null it will be used to get the separator between the number value and the currency symbol otherwise the value of ValueProperties.getCurrencySeparator() will be used.

Specified by:

getCurrencySeparatorFormula in interface ValueProperties

Returns:

The formula which will be used to get the separator between the number value and the currency symbol or null if only the value of ValueProperties.getCurrencySeparator() should be used.

Since:

7.0

setCurrencySeparatorFormula

public final void setCurrencySeparatorFormula(FormulaField newFormula)

Sets the formula which should be used to retrieve the value for the separator between number value and currency symbol. The formula passed has to return a value of type string.

Specified by:

setCurrencySeparatorFormula in interface ValueProperties

Parameters:

newFormula - The formula which should be used for the property 'currency separator' or null if no formula should be used.

Since:

7.0

setField

public final void setField(Field newField)

Sets the field definition element (for example, DatabaseField element, prompt field element).

Overrides:

setField in class Element

Parameters:

newField - The new field element of the property 'field'.

getPropertyFormulas

public java.util.List getPropertyFormulas()

Returns a list with all property formulas that are set for this report element.

Overrides:

getPropertyFormulas in class AbstractFontElement

Returns:

List of property formulas

getManualFormatFormula

public FormulaField getManualFormatFormula()

Gets the formula of the property 'manual format'. Use this property to specify a formula to manually format the value of this element. If this formula is not null, it will be used to manually format the element and will override any number, date, or other formatting settings. This formula must return a string value to be valid.

Specified by:

getManualFormatFormula in interface ValueProperties

Returns:

FormulaField The formula of the property 'manual format'.

Since:

6.1

setManualFormatFormula

public void setManualFormatFormula(FormulaField newFormula)

Gets the formula of the property 'manual format'. Use this property to specify a formula to manually format the value of this element. If this formula is not null, it will be used to manually format the element and will override any number, date, or other formatting settings. This formula must return a string value to be valid.

Specified by:

setManualFormatFormula in interface ValueProperties

Parameters:

newFormula - The new formula for the property 'manual format'.

Since:

6.1

parseElement

public NodeParser parseElement(com.inet.report.parser.XMLTag group,
                               java.lang.String tag,
                               org.xml.sax.Attributes atts,
                               java.util.Map parserMap)
                        throws FatalParserException

FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML

Parses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.

Specified by:

parseElement in interface NodeParser

Overrides:

parseElement in class AbstractFontElement

Parameters:

group - XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.

tag - The XMLTag to be parsed

atts - The set of attributes in the current XMLTag

parserMap - The map of current Parser.

Returns:

The NodeParser sub-element if one needed to be created, or null if none was created.

Throws:

FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.