Package 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:
FontProperties
,GeneralProperties
,NodeParser
,com.inet.report.ReferenceHolder
,ValueProperties
,Serializable
,Cloneable
- Direct Known Subclasses:
FieldElement
,FieldPart
This class is an abstract implementation of the interface
ValueProperties
.- Since:
- 6.0
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
FOR INTERNAL USE ONLYstatic enum
FOR INTERNAL USE ONLYNested classes/interfaces inherited from class com.inet.report.AbstractFontElement
AbstractFontElement.FontProps
Nested classes/interfaces inherited from class com.inet.report.Element
Element.BorderProps, Element.CommonProperties, Element.ElementTypes, Element.HyperlinkProps, Element.StringProps
-
Field Summary
Fields inherited from class com.inet.report.Element
BOX, CHART, CROSSTAB, CROSSTABSECTION, DATABASE_PICTURE, FIELD, FIELDPART, FORMFIELD, INTERACTIVE_SORTING, JAVABEAN, LINE, PARAGRAPH, PICTURE, SIGNATURE, SUBREPORT, TEXT, TEXTPART
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.GeneralProperties
ALIGN_HORIZONTAL_CENTER, ALIGN_HORIZONTAL_DEFAULT, ALIGN_HORIZONTAL_JUSTIFIED, ALIGN_HORIZONTAL_LEFT, ALIGN_HORIZONTAL_RIGHT
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, DEFAULT_FORMAT, 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, NO_DAY, NO_DAY_OF_WEEK, NO_ERA, NO_HOUR, NO_MINUTE, NO_MONTH, NO_SYMBOL, NO_YEAR, NOT_NEGATIVE, NOT_USING_SYSTEM_DEFAULTS, 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_UP, SHORT_DAY_OF_WEEK, SHORT_ERA, SHORT_MONTH, SHORT_YEAR, T_OR_F, 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, 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, Y_OR_N, YEAR_MONTH_DAY, YES_OR_NO
-
Method Summary
Modifier and TypeMethodDescriptionfinal FormulaField
Get the formula for the property 'allow field clipping'.final int
Returns the value of the property 'am pm order/type'.final FormulaField
returns the formula of the property 'am pm order/type'.final String
Returns the value of the property 'am string'.final FormulaField
Returns the formula of the property 'am string'.final int
Returns the value of the property 'boolean format output type'.final FormulaField
Returns the formula for the property 'boolean format output type'.int
Returns the value of the property 'currency position type'.final FormulaField
Returns the formula for the property 'currency position type'.final String
Returns the separator between the number value and currency symbol.final FormulaField
Returns the formula for the property 'currency separator'.Returns the value of the property 'currency symbol'.final FormulaField
Returns the formula for the property 'currency symbol'.int
Returns the value of the property 'currency symbol type'.Returns the formula for the property 'currency symbol type'.final int
Returns the value of the property 'date calendar type'.final FormulaField
Returns the formula of the property 'date calendar type'.final int
Returns the value of the property 'date era type'.final FormulaField
Returns the formula of the property 'date era type'.final String
Returns the value of the property 'date first separator'.final FormulaField
Returns the formula for the property 'date first separator'.final int
Returns the date format type set for this element.final FormulaField
Returns the formula for the property 'date format type'.final int
Returns the value of the property 'date order'.final FormulaField
Returns the formula for the property 'date order'.final String
Returns the value of the property 'date prefix separator'.final FormulaField
Returns the formula for the property 'date prefix separator'.final String
Returns the value of the property 'date second separator'.final FormulaField
Returns the formula for the property 'date second separator'.final String
Returns the value of the property 'date suffix separator'.final FormulaField
Returns the formula for the property 'date suffix separator'.final int
Returns the value of the property 'date time order'.final FormulaField
Returns the formula for the property 'date time order'.final String
Returns the value of the property 'date time separator'.final FormulaField
Returns the formula for the property 'date time separator'.final FormulaField
Deprecated.final int
Returns the value of the property 'day of week enclosure'.final FormulaField
Returns the formula for the property 'day of week enclosure'.final int
Returns the value of the property 'day of week position'.final FormulaField
Returns the formula for the property 'day of week position'.final String
Returns the value of the property 'day of week separator'.final FormulaField
Returns the formula for the property 'day of week separator'.final int
Returns the value of the property 'day of week type'.final FormulaField
Returns the formula for the property 'day of week type'.final int
Returns the value of the property 'day type'.final FormulaField
Returns the formula for the property 'day type'.final String
Returns the value of the property 'decimal separators symbol'.final FormulaField
Returns the formula for the property 'decimal separators symbol'.final String
Returns the value of the property 'hour minute sepereator'.final FormulaField
Returns the formula for the property 'hour minute sepereator'.final int
Returns the value of the property 'hour type'.final FormulaField
Returns the formula for the property 'hour type'.Gets the formula of the property 'manual format'.final String
Returns the value of the property 'minute second separator'.final FormulaField
Returns the formula for the property 'minute second separator'.final int
Returns the value of the property 'minute type'.final FormulaField
Returns the formula for the property 'minute type'.final int
Returns the value of the property 'month type'.final FormulaField
Returns the formula for the property 'month type'.final int
Returns the value of the property 'n decimal places'.final FormulaField
Returns the formula for the property 'n decimal places'.int
Returns the value of the property 'negative type'.Returns the formula for the property 'negative type'.int
Returns the number format type set for this element.Returns the formula which returns the number format type to use for this element.final int
Returns the language of numerals for numbers, date, time and datetime values.final String
Returns the value of the property 'pm string'.final FormulaField
Returns the formula of the property 'pm string'.Returns a list with all property formulas that are set for this report element.final FormulaField
Returns the formula for the property 'use reverse sign for display'.int
Returns which digit to round the number to.Returns the formula which provides the digit to round the number to.final int
Returns the rounding mode for this element.final FormulaField
Returns the formula for the rounding mode, can be null if the formula is not set.final int
Returns the value of the property 'second type'.final FormulaField
Returns the formula for the property 'second type'.final boolean
Returns the value of the property 'suppress if zero'.final FormulaField
Returns the formula for the property 'suppress if zero'.final String
Returns the value of the property 'thousands separator symbol'.final FormulaField
Returns the formula for the property 'thousands separator symbol'.final int
Returns the value of the property 'time base'.final FormulaField
Returns the formula for the property 'time base'.int
Returns the time format type to use for this element.Returns the formula determining the time format type to use for this element.final boolean
Returns the value of the property 'use leading zero'.final FormulaField
Returns the formula for the property 'use leading zero'.final boolean
Returns the value of the property 'use one currency symbol per page'.final FormulaField
Returns the formula for the property 'use one currency symbol per page'.final boolean
Returns the value of the property 'use thousands separator'.final FormulaField
Returns the formula for the property 'use thousands separator'.final int
Returns the value of the property 'year type'.final FormulaField
Returns the formula for the property 'year type'.final String
Returns the value of the property 'zero value string'.final boolean
Returnstrue
if allow field clipping is enabled, elsefalse
is returned.final boolean
Checks the property 'use reverse sign for display'parseElement
(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLfinal void
setAllowFieldClipping
(boolean newValue) Sets the value of the property 'allow field clipping'.final void
setAllowFieldClippingFormula
(FormulaField newField) Set the formula for the property 'allow field clipping'.final void
setAmPmOrder
(int newValue) Sets the value of the property 'am pm order/type'.final void
setAmPmOrderFormula
(FormulaField newFormula) Sets the formula for the property 'am pm order/type'.final void
setAmString
(String newValue) Sets the value of the property 'am string'.final void
setAmStringFormula
(FormulaField newFormula) Sets the formula for the property 'am string'.final void
setBooleanFormatOutputType
(int newValue) Sets the value of the property 'boolean format output type'.final void
setBooleanFormatOutputTypeFormula
(FormulaField newFormula) Sets the formula for the property 'boolean format output type'.final void
setCurrencyPosition
(int newValue) Sets the value of the property 'currency position type'.final void
setCurrencyPositionFormula
(FormulaField newFormula) Sets the formula for the property 'currency position type'.final void
setCurrencySeparator
(String newCurrencySeparator) Sets the separator to be displayed between the number value and the currency value.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.void
setCurrencySymbol
(String newValue) Sets the value of the property 'currency symbol'.final 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'.final void
setCurrencySymbolTypeFormula
(FormulaField newFormula) Sets the formula for the property 'currency symbol type'.final void
setDateCalendarType
(int newValue) Sets the value of the property 'date calendar type'.final void
setDateCalendarTypeFormula
(FormulaField newFormula) Sets the formula for the property 'date calendar type'.final void
setDateEraType
(int newValue) Sets the value of the property 'date era type'.final void
setDateEraTypeFormula
(FormulaField newFormula) Sets the formula for the property 'date era type'.final void
setDateFirstSeparator
(String newValue) Sets the value of the property 'date first separator'.final void
setDateFirstSeparatorFormula
(FormulaField newFormula) Sets the formula for the property 'date first separator'.final void
setDateFormatType
(int newValue) Sets the date format type to use for this element.final void
setDateFormatTypeFormula
(FormulaField newFormula) Sets the formula for the property 'date format type'.final void
setDateOrder
(int newValue) Sets the value of the property 'date order'.final void
setDateOrderFormula
(FormulaField newFormula) Sets the formula for the property 'date order'.final void
setDatePrefixSeparator
(String newValue) Sets the value of the property 'date prefix separator'.final void
setDatePrefixSeparatorFormula
(FormulaField newFormula) Sets the formula for the property 'date prefix separator'.final void
setDateSecondSeparator
(String newValue) Sets the value of the property 'date second separator'.final void
setDateSecondSeparatorFormula
(FormulaField newFormula) Sets the formula for the property 'date second separator'.final void
setDateSuffixSeparator
(String newValue) Sets the value of the property 'date suffix separator'.final void
setDateSuffixSeparatorFormula
(FormulaField newFormula) Sets the formula for the property 'date suffix separator'.final void
setDateTimeOrder
(int newValue) Sets the value of the property 'date time order'.final void
setDateTimeOrderFormula
(FormulaField newFormula) Sets the formula for the property 'date time order'.final void
setDateTimeSeparator
(String newValue) Sets the value of the property 'date time separator'.final void
setDateTimeSeparatorFormula
(FormulaField newFormula) Sets the formula for the property 'date time separator'.final void
setDateWindowsDefaultTypeFormula
(FormulaField newFormula) Deprecated.As of i-net Crystal-Clear 8.0, usesetDateFormatTypeFormula(FormulaField)
instead.final void
setDayOfWeekEnclosure
(int newValue) Sets the value of the property 'day of week enclosure'.final void
setDayOfWeekEnclosureFormula
(FormulaField newFormula) Sets the formula for the property 'day of week enclosure'.final void
setDayOfWeekPosition
(int newValue) Sets the value of the property 'day of week position'.final void
setDayOfWeekPositionFormula
(FormulaField newFormula) Sets the formula for the property 'day of week position'.final void
setDayOfWeekSeparator
(String newValue) Sets the value of the property 'day of week separator'.final void
setDayOfWeekSeparatorFormula
(FormulaField newFormula) Sets the formula for the property 'day of week separator'.final void
setDayOfWeekType
(int newValue) Sets the value of the property 'day of week type'.final void
setDayOfWeekTypeFormula
(FormulaField newFormula) Sets the formula for the property 'day of week type'.final void
setDayType
(int newValue) Sets the value of the property 'day type'.final void
setDayTypeFormula
(FormulaField newFormula) Sets the formula for the property 'day type'.final void
setDecimalSeparatorSymbol
(String newValue) Sets the value of the property 'decimal separators symbol'.final void
setDecimalSeparatorSymbolFormula
(FormulaField newFormula) Sets the formula for the property 'decimal separators symbol'.final void
Sets the field definition element (for example, DatabaseField element, prompt field element).final void
setHourMinuteSeparator
(String newValue) Sets the value of the property 'hour minute sepereator'.final void
setHourMinuteSeparatorFormula
(FormulaField newFormula) Sets the formula for the property 'hour minute sepereator'.final void
setHourType
(int newValue) Sets the value of the property 'hour type'.final void
setHourTypeFormula
(FormulaField newFormula) Sets the formula for the property 'hour type'.void
setManualFormatFormula
(FormulaField newFormula) Gets the formula of the property 'manual format'.final void
setMinuteSecondSeparator
(String newValue) Sets the value of the property 'minute second separator'.final void
setMinuteSecondSeparatorFormula
(FormulaField newFormula) Sets the formula for the property 'minute second separator'.final void
setMinuteType
(int newValue) Sets the value of the property 'minute type'.final void
setMinuteTypeFormula
(FormulaField newFormula) Sets the formula for the property 'minute type'.final void
setMonthType
(int newValue) Sets the value of the property 'month type'.final void
setMonthTypeFormula
(FormulaField newFormula) Sets the formula for the property 'month type'.final void
setNDecimalPlaces
(int newValue) Sets the value of the property 'n decimal places'.final 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.final void
setNumeralLanguage
(int language) Sets the language of the numerals in number, date, time or datetime values.final void
setPmString
(String newValue) Sets the value of the property 'pm string'.final void
setPmStringFormula
(FormulaField newFormula) Sets the formula for the property 'pm string'.final void
setReverseSignForDisplay
(boolean newValue) Sets the property 'use reverse sign for display'.final 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
setRoundingFormula
(FormulaField newFormula) Sets the formula which provides the digit to round the number to.final void
setRoundingMode
(int newValue) Sets the rounding mode.final void
setRoundingModeFormula
(FormulaField newFormula) Sets the formula for the property 'rounding mode'.final void
setSecondType
(int newValue) Sets the value of the property 'second type'.final void
setSecondTypeFormula
(FormulaField newFormula) Sets the formula for the property 'second type'.final void
setSuppressIfZero
(boolean newValue) Sets the value of the property 'suppress if zero'.final void
setSuppressIfZeroFormula
(FormulaField newFormula) Sets the formula for the property 'suppress if zero'.final void
setThousandsSeparatorSymbol
(String newValue) Sets the value of the property 'thousands separator symbol'.final void
setThousandsSeparatorSymbolFormula
(FormulaField newFormula) Sets the formula for the property 'thousands separator symbol'.final void
setTimeBase
(int newValue) Sets the value of the property 'time base'.final 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.final void
setUseLeadingZero
(boolean newValue) Sets the value of the property 'use leading zero'.final void
setUseLeadingZeroFormula
(FormulaField newFormula) Sets the formula for the property 'use leading zero'.final void
setUseOneCurrencySymbolPerPage
(boolean newValue) Sets the value of the property 'use one currency symbol per page'.final void
setUseOneCurrencySymbolPerPageFormula
(FormulaField newFormula) Sets the formula for the property 'use one currency symbol per page'.final void
setUseThousandsSeparator
(boolean newValue) Sets the value of the property 'use thousands separator'.final void
setUseThousandsSeparatorFormula
(FormulaField newFormula) Sets the formula for the property 'use thousands separator'.final void
setYearType
(int newValue) Sets the value of the property 'year type'.final void
setYearTypeFormula
(FormulaField newFormula) Sets the formula for the property 'year type'.final void
setZeroValueString
(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, getBottomLineStyle, getBottomLineStyleFormula, getBulletValueStack, getCanGrowCount, getCanGrowFormula, getCloseBorderOnPageBreakFormula, getDropShadowFormula, getEngine, getField, getForeColor, getForeColorFormula, getHorAlign, getHorAlignFormula, getHyperlinkUrl, getHyperlinkUrlFormula, getLeftLineStyle, getLeftLineStyleFormula, getListStack, getParent, getRightLineStyle, getRightLineStyleFormula, getSuppressIfDuplicatedFormula, getTightHorizontalFormula, getToolTipsText, getToolTipsTextFormula, getTopLineStyle, getTopLineStyleFormula, getTypeAsString, indexOf, isCanGrow, isCloseBorderOnPageBreak, isCloseBorderOnPageBreakInternal, isDropShadow, isInCrossTab, isSuppressIfDuplicated, isTightHorizontal, paramString, parseText, removeListener, setBottomLineStyle, setBottomLineStyleFormula, setBulletValueStack, setCanGrow, setCanGrowCount, setCanGrowFormula, setCloseBorderOnPageBreak, setCloseBorderOnPageBreakFormula, setDropShadow, setDropShadowFormula, setForeColor, setForeColorFormula, setHorAlign, setHorAlignFormula, setHyperlinkUrl, setHyperlinkUrlFormula, setIndex, setLeftLineStyle, setLeftLineStyleFormula, setListStack, setReferences, setRightLineStyle, setRightLineStyleFormula, setSuppressIfDuplicated, setSuppressIfDuplicatedFormula, setTightHorizontal, setTightHorizontalFormula, setToolTipsText, setToolTipsTextFormula, setTopLineStyle, setTopLineStyleFormula
Methods inherited from class com.inet.report.ReportComponent
addPropertyChangeListener, addPropertyChangeListener, addReferencedObject, addVetoableChangeListener, addVetoableChangeListener, getBackColor, getBackColorFormula, getCustomData, getHeight, getKeepTogetherFormula, getRealReferencedObjectCount, getReferencedObjectCount, getReferencedObjects, getSubComponents, getSuppressFormula, getType, getWidth, getX, getY, isDOMParser, isKeepTogether, isSuppress, parseDOM, parseEndElement, removePropertyChangeListener, removePropertyChangeListener, removeReferencedObject, removeVetoableChangeListener, removeVetoableChangeListener, resetReferences, setBackColor, setBackColorFormula, setCustomData, setHeight, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula, setWidth, setX, setY
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.inet.report.GeneralProperties
getKeepTogetherFormula, getSuppressFormula, isKeepTogether, isSuppress, setKeepTogether, setKeepTogetherFormula, setSuppress, setSuppressFormula
-
Method Details
-
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 interfaceValueProperties
- Returns:
- The value of the property 'am string'.
- Since:
- 6.0
-
setAmString
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'am string'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
FormulaField
if a formula for this property was defined elsenull
.- Since:
- 6.0
-
setAmStringFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'am string'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
- The value of the property 'pm string'.
- Since:
- 6.0
-
setPmString
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'pm string'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
FormulaField
if a formula for this property was defined elsenull
.- Since:
- 6.0
-
setPmStringFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'pm string'.- Since:
- 6.0
-
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'time base'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.TWELVE_HOURS
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The value of the property 'time base'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.TWELVE_HOURS
ValuePropertiesConstants.TWENTY_FOUR_HOURS
-
setTimeBaseFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'time base'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.TWELVE_HOURS
ValuePropertiesConstants.TWENTY_FOUR_HOURS
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'time base'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
- The current value of property.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.AM_PM_BEFORE
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The new value for property.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.AM_PM_BEFORE
ValuePropertiesConstants.AM_PM_AFTER
-
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 interfaceValueProperties
- Returns:
FormulaField
if a formula for this property was defined elsenull
.- Since:
- 6.0
-
setAmPmOrderFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'am pm order/type'. The result of the formula should either 0 or 1.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.AM_PM_BEFORE
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'hour type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NO_HOUR
ValuePropertiesConstants.NUMERIC_HOUR
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The current value of the property 'hour type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NO_HOUR
ValuePropertiesConstants.NUMERIC_HOUR
ValuePropertiesConstants.NUMERIC_HOUR_NO_LEADING_ZERO
-
setHourTypeFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'hour type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NO_HOUR
ValuePropertiesConstants.NUMERIC_HOUR
ValuePropertiesConstants.NUMERIC_HOUR_NO_LEADING_ZERO
-
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 interfaceValueProperties
- Returns:
FormulaField
The current formula for the property 'hour type'.- Since:
- 6.0
-
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'minute type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NO_MINUTE
ValuePropertiesConstants.NUMERIC_MINUTE
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The current value of the property 'minute type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NO_MINUTE
ValuePropertiesConstants.NUMERIC_MINUTE
ValuePropertiesConstants.NUMERIC_MINUTE_NO_LEADING_ZERO
-
setMinuteTypeFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'minute type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NO_MINUTE
ValuePropertiesConstants.NUMERIC_MINUTE
ValuePropertiesConstants.NUMERIC_MINUTE_NO_LEADING_ZERO
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'minute type'.- Since:
- 6.0
-
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'second type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NUMERIC_NO_SECOND
ValuePropertiesConstants.NUMERIC_SECOND
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The current value of the property 'second type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NUMERIC_NO_SECOND
ValuePropertiesConstants.NUMERIC_SECOND
ValuePropertiesConstants.NUMERIC_NO_LEADING_ZERO
-
setSecondTypeFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'second type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NUMERIC_NO_SECOND
ValuePropertiesConstants.NUMERIC_SECOND
ValuePropertiesConstants.NUMERIC_NO_LEADING_ZERO
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'second type'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
- The current value of the property 'hour minute sepereator'.
- Since:
- 6.1
-
setHourMinuteSeparator
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'hour minute sepereator'.- Since:
- 6.1
-
setHourMinuteSeparatorFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'hour minute sepereator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
FormulaField
The current formula for the property 'hour minute sepereator'.- Since:
- 6.1
-
setMinuteSecondSeparator
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'minute second separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
- The current value of the property 'minute second separator'.
- Since:
- 6.1
-
setMinuteSecondSeparatorFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'minute second separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- 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 interfaceValueProperties
- Returns:
- The date format type set for this element.
- See Also:
-
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 interfaceValueProperties
- Parameters:
newValue
- The date format type set for this element- See Also:
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula of the property 'date format type'.
-
setDateFormatTypeFormula
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 interfaceValueProperties
- 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:
-
getDateWindowsDefaultTypeFormula
Deprecated.As of i-net Crystal-Clear 8.0, usegetDateFormatTypeFormula()
instead.FOR INTERNAL USE ONLY -
setDateWindowsDefaultTypeFormula
Deprecated.As of i-net Crystal-Clear 8.0, usesetDateFormatTypeFormula(FormulaField)
instead.FOR INTERNAL USE ONLY -
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 interfaceValueProperties
- Returns:
- the time format type set for this element.
- See Also:
-
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 interfaceValueProperties
- Parameters:
systemDefaultTimeType
- the time format type set for this element- See Also:
-
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 interfaceValueProperties
- Returns:
- the formula determining the time format type set for this element
-
setTimeFormatTypeFormula
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 interfaceValueProperties
- 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 interfaceValueProperties
- Returns:
- The number format type set for this element.
- See Also:
-
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 interfaceValueProperties
- Parameters:
newValue
- The number format type to set for this element- See Also:
-
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 interfaceValueProperties
- Returns:
- The formula field which returns the number format type to use for this element.
- See Also:
-
setNumberFormatTypeFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The formula field which returns the number format type to use for this element- See Also:
-
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 interfaceValueProperties
- Returns:
- The value of the property 'date calendar type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.GREGORIAN_CALENDAR
ValuePropertiesConstants.GREGORIAN_US_CALENDAR
ValuePropertiesConstants.JAPANESE_CALENDAR
ValuePropertiesConstants.TAIWANESE_CALENDAR
ValuePropertiesConstants.KOREAN_CALENDAR
ValuePropertiesConstants.HIJRI_CALENDAR
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'date calendar type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.GREGORIAN_CALENDAR
ValuePropertiesConstants.GREGORIAN_US_CALENDAR
ValuePropertiesConstants.JAPANESE_CALENDAR
ValuePropertiesConstants.TAIWANESE_CALENDAR
ValuePropertiesConstants.KOREAN_CALENDAR
ValuePropertiesConstants.HIJRI_CALENDAR
ValuePropertiesConstants.THAI_CALENDAR
-
getDateCalendarTypeFormula
Returns the formula of the property 'date calendar type'. Use this property to choose a calendar.- Specified by:
getDateCalendarTypeFormula
in interfaceValueProperties
- Returns:
FormulaField
The formula of the property 'date calendar type'.- Since:
- 6.0
-
setDateCalendarTypeFormula
Sets the formula for the property 'date calendar type'. Use this property to choose a calendar.- Specified by:
setDateCalendarTypeFormula
in interfaceValueProperties
- Parameters:
newFormula
- The new formula of the property 'date calendar type'. The result of the formula should be in range from 1 to 7.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.GREGORIAN_CALENDAR
ValuePropertiesConstants.GREGORIAN_US_CALENDAR
ValuePropertiesConstants.JAPANESE_CALENDAR
ValuePropertiesConstants.TAIWANESE_CALENDAR
ValuePropertiesConstants.KOREAN_CALENDAR
ValuePropertiesConstants.HIJRI_CALENDAR
ValuePropertiesConstants.THAI_CALENDAR
-
getDateEraType
public final int getDateEraType()Returns the value of the property 'date era type'.- Specified by:
getDateEraType
in interfaceValueProperties
- Returns:
- The value of the property 'date era type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.SHORT_ERA
ValuePropertiesConstants.LONG_ERA
ValuePropertiesConstants.NO_ERA
-
setDateEraType
public final void setDateEraType(int newValue) Sets the value of the property 'date era type'.- Specified by:
setDateEraType
in interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'date era type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.SHORT_ERA
ValuePropertiesConstants.LONG_ERA
ValuePropertiesConstants.NO_ERA
-
getDateEraTypeFormula
Returns the formula of the property 'date era type'.- Specified by:
getDateEraTypeFormula
in interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'date era type'.- Since:
- 6.0
-
setDateEraTypeFormula
Sets the formula for the property 'date era type'.- Specified by:
setDateEraTypeFormula
in interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'date era type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.SHORT_ERA
ValuePropertiesConstants.LONG_ERA
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The value of the property 'day type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NUMERIC_DAY
ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'day type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NUMERIC_DAY
ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY
ValuePropertiesConstants.NO_DAY
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula of the property 'day type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NUMERIC_DAY
ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY
ValuePropertiesConstants.NO_DAY
-
setDayTypeFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'day type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NUMERIC_DAY
ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'month type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.LEADING_ZERO_NUMERIC_MONTH
ValuePropertiesConstants.LONG_MONTH
ValuePropertiesConstants.NO_MONTH
ValuePropertiesConstants.NUMERIC_MONTH
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The current value of the property 'month type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.LEADING_ZERO_NUMERIC_MONTH
ValuePropertiesConstants.LONG_MONTH
ValuePropertiesConstants.NO_MONTH
ValuePropertiesConstants.NUMERIC_MONTH
ValuePropertiesConstants.SHORT_MONTH
-
setMonthTypeFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'month type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.LEADING_ZERO_NUMERIC_MONTH
ValuePropertiesConstants.LONG_MONTH
ValuePropertiesConstants.NO_MONTH
ValuePropertiesConstants.NUMERIC_MONTH
ValuePropertiesConstants.SHORT_MONTH
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'month type'.- Since:
- 6.0
-
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'year type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.SHORT_YEAR
ValuePropertiesConstants.LONG_YEAR
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The value of the property 'year type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.SHORT_YEAR
ValuePropertiesConstants.LONG_YEAR
ValuePropertiesConstants.NO_YEAR
-
setYearTypeFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'year type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.SHORT_YEAR
ValuePropertiesConstants.LONG_YEAR
ValuePropertiesConstants.NO_YEAR
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'year type'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
- The value of the property 'day of week position'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.LEADING_DAY_OF_WEEK
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'day of week position'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.LEADING_DAY_OF_WEEK
ValuePropertiesConstants.TRAILING_DAY_OF_WEEK
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'day of week position'.- Since:
- 6.0
-
setDayOfWeekPositionFormula
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 interfaceValueProperties
- 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.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.LEADING_DAY_OF_WEEK
ValuePropertiesConstants.TRAILING_DAY_OF_WEEK
-
getDayOfWeekEnclosure
public final int getDayOfWeekEnclosure()Returns the value of the property 'day of week enclosure'.- Specified by:
getDayOfWeekEnclosure
in interfaceValueProperties
- Returns:
- The current value of the property 'day of week enclosure'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_NONE
ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_PARENTHESIS
ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_ANGLE
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The value of the property 'day of week enclosure'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_NONE
ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_PARENTHESIS
ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_ANGLE
ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_SQUARED
-
getDayOfWeekEnclosureFormula
Returns the formula for the property 'day of week enclosure'.- Specified by:
getDayOfWeekEnclosureFormula
in interfaceValueProperties
- Returns:
- The formula for the property 'day of week enclosure'.
- Since:
- 6.0
-
setDayOfWeekEnclosureFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'week day enclosure'.- Since:
- 6.0
-
setDayOfWeekSeparator
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'day of week separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
- The current value of the property 'day of week separator'.
- Since:
- 6.1
-
setDayOfWeekSeparatorFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'day of week separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- 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 interfaceValueProperties
- Returns:
- The value of the property 'day of week type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.SHORT_DAY_OF_WEEK
ValuePropertiesConstants.LONG_DAY_OF_WEEK
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'day of week type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.SHORT_DAY_OF_WEEK
ValuePropertiesConstants.LONG_DAY_OF_WEEK
ValuePropertiesConstants.NO_DAY_OF_WEEK
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'day of week type'.- Since:
- 6.0
-
setDayOfWeekTypeFormula
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 interfaceValueProperties
- 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.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.SHORT_DAY_OF_WEEK
ValuePropertiesConstants.LONG_DAY_OF_WEEK
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The value of the property 'date order'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.YEAR_MONTH_DAY
ValuePropertiesConstants.DAY_MONTH_YEAR
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'date order'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.YEAR_MONTH_DAY
ValuePropertiesConstants.DAY_MONTH_YEAR
ValuePropertiesConstants.MONTH_DAY_YEAR
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula of the property 'date order'.- Since:
- 6.0
-
setDateOrderFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'date order'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.YEAR_MONTH_DAY
ValuePropertiesConstants.DAY_MONTH_YEAR
ValuePropertiesConstants.MONTH_DAY_YEAR
-
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 interfaceValueProperties
- Returns:
- The value of the property 'date prefix separator'.
- Since:
- 6.1
-
setDatePrefixSeparator
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'date prefix separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula of the property 'date prefix separator'.- Since:
- 6.1
-
setDatePrefixSeparatorFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'date prefix separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
- The value of the property 'date firts separator'.
- Since:
- 6.1
-
setDateFirstSeparator
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'date first separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'date first separator'.- Since:
- 6.1
-
setDateFirstSeparatorFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'date first separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
- The value of the property 'date second separator'.
- Since:
- 6.1
-
setDateSecondSeparator
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'date second separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula of the property 'date second separator'.- Since:
- 6.1
-
setDateSecondSeparatorFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'date second separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
- The value of the property 'date suffix separator'.
- Since:
- 6.1
-
setDateSuffixSeparator
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'date suffix separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula of the property 'date suffix separator'.- Since:
- 6.1
-
setDateSuffixSeparatorFormula
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 interfaceValueProperties
- 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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'date time order'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.DATE_TIME_ORDER
ValuePropertiesConstants.TIME_DATE_ORDER
ValuePropertiesConstants.DATE_ONLY_ORDER
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The value of the property 'date time order'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.DATE_TIME_ORDER
ValuePropertiesConstants.TIME_DATE_ORDER
ValuePropertiesConstants.DATE_ONLY_ORDER
ValuePropertiesConstants.TIME_ONLY_ORDER
-
setDateTimeOrderFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'date time order'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.DATE_TIME_ORDER
ValuePropertiesConstants.TIME_DATE_ORDER
ValuePropertiesConstants.DATE_ONLY_ORDER
ValuePropertiesConstants.TIME_ONLY_ORDER
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'date time order'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.DATE_TIME_ORDER
ValuePropertiesConstants.TIME_DATE_ORDER
ValuePropertiesConstants.DATE_ONLY_ORDER
ValuePropertiesConstants.TIME_ONLY_ORDER
-
setDateTimeSeparator
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'date time separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
- The value of the property 'date time separator'.
- Since:
- 6.1
-
setDateTimeSeparatorFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'date time separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- 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 interfaceValueProperties
- Returns:
- The value of the property 'boolean format output type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.TRUE_OR_FALSE
ValuePropertiesConstants.T_OR_F
ValuePropertiesConstants.YES_OR_NO
ValuePropertiesConstants.Y_OR_N
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The new value for the property 'boolean format output type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.TRUE_OR_FALSE
ValuePropertiesConstants.T_OR_F
ValuePropertiesConstants.YES_OR_NO
ValuePropertiesConstants.Y_OR_N
ValuePropertiesConstants.ONE_OR_ZERO
-
setBooleanFormatOutputTypeFormula
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 interfaceValueProperties
- 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.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.TRUE_OR_FALSE
ValuePropertiesConstants.T_OR_F
ValuePropertiesConstants.YES_OR_NO
ValuePropertiesConstants.Y_OR_N
ValuePropertiesConstants.ONE_OR_ZERO
-
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 interfaceValueProperties
- 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 interfaceValueProperties
- Returns:
- The value of the property 'currency position type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.LEADING_CURRENCY_INSIDE_NEGATIVE
ValuePropertiesConstants.LEADING_CURRENCY_OUTSIDE_NEGATIVE
ValuePropertiesConstants.TRAILING_CURRENCY_INSIDE_NEGATIVE
ValuePropertiesConstants.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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'currency position type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.LEADING_CURRENCY_INSIDE_NEGATIVE
ValuePropertiesConstants.LEADING_CURRENCY_OUTSIDE_NEGATIVE
ValuePropertiesConstants.TRAILING_CURRENCY_INSIDE_NEGATIVE
ValuePropertiesConstants.TRAILING_CURRENCY_OUTSIDE_NEGATIVE
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'currency position type'.- Since:
- 6.0
-
setCurrencyPositionFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'currency position type', where the result of the formula should be in range 0 to 3.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.LEADING_CURRENCY_INSIDE_NEGATIVE
ValuePropertiesConstants.LEADING_CURRENCY_OUTSIDE_NEGATIVE
ValuePropertiesConstants.TRAILING_CURRENCY_INSIDE_NEGATIVE
ValuePropertiesConstants.TRAILING_CURRENCY_OUTSIDE_NEGATIVE
-
setCurrencySymbol
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'currency symbol'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
- The value of the property 'currency symbol'.
- Since:
- 6.0
-
setCurrencySymbolFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'currency symbol'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
- Formula field for the property "currency symbol"
- Since:
- 6.0
-
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'currency symbol type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NO_SYMBOL
ValuePropertiesConstants.FIXED_SYMBOL
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The value of the property 'currency symbol type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NO_SYMBOL
ValuePropertiesConstants.FIXED_SYMBOL
ValuePropertiesConstants.FLOATING_SYMBOL
-
setCurrencySymbolTypeFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'currency symbol type'. The result of the formula should be in range from 0 to 2.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NO_SYMBOL
ValuePropertiesConstants.FIXED_SYMBOL
ValuePropertiesConstants.FLOATING_SYMBOL
-
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 interfaceValueProperties
- Returns:
- Formula Field for the property "currency symbol type"
- Since:
- 6.0
-
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'use one currency symbol per page'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
- The value of the property 'use one currency symbol per page'.
- Since:
- 6.0
-
setUseOneCurrencySymbolPerPageFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'use one currency symbol per page'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'use one currency symbol per page'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
- The value of the property 'n decimal places'.
- See Also:
-
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'n decimal places'.- See Also:
-
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 interfaceValueProperties
- Returns:
- FormulaField The formula of the property 'n decimal places'.
- See Also:
-
setNDecimalPlacesFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'n decimal places'.- See Also:
-
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 interfaceValueProperties
- Returns:
- The value of the property 'decimal separators symbol'.
- Since:
- 6.1
-
setDecimalSeparatorSymbol
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'decimal separators symbol'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula of the property 'decimal separators symbol'.- Since:
- 6.1
-
setDecimalSeparatorSymbolFormula
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 interfaceValueProperties
- 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 interfaceValueProperties
- 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 interfaceValueProperties
- Returns:
- Whether the property 'use reverse sign for display' is on or off.
- Since:
- 7.0
-
getReverseSignForDisplayFormula
Returns the formula for the property 'use reverse sign for display'.- Specified by:
getReverseSignForDisplayFormula
in interfaceValueProperties
- Returns:
- FormulaField The formula of the property 'use reverse sign for display'.
-
setReverseSignForDisplayFormula
Sets the formula for the property 'use reverse sign for display'.- Specified by:
setReverseSignForDisplayFormula
in interfaceValueProperties
- 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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'suppress if zero'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
- The value of the property 'suppress if zero'.
- Since:
- 6.0
-
setSuppressIfZeroFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'suppress if zero'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'suppress if zero'.- Since:
- 6.0
-
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 interfaceValueProperties
- 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 interfaceValueProperties
- Returns:
- The value of the property 'use thousands separator'.
- Since:
- 6.1
-
setUseThousandsSeparatorFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'use thousands separator'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'use thousands separator'.- Since:
- 6.1
-
setThousandsSeparatorSymbol
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'thousands separator symbol'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
- The value of the property 'thousands separator symbol'.
- Since:
- 6.1
-
setThousandsSeparatorSymbolFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'thousands separator symbol'.- Since:
- 6.1
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'thousands separator symbol'.- Since:
- 6.1
-
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 interfaceValueProperties
- 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 interfaceValueProperties
- Returns:
- digits position of digit to round to: negative numbers for after the decimal point, positive for before
-
setRoundingFormula
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 interfaceValueProperties
- Parameters:
newFormula
- formula providing the digits position of digit to round to: positive numbers for after the decimal point, negative for before
-
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 interfaceValueProperties
- Returns:
- The formula providing the digits position of digit to round to: positive numbers for after the decimal point, negative for before
-
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 interfaceValueProperties
- 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 interfaceValueProperties
- Returns:
- the current rounding mode
- See Also:
-
setRoundingModeFormula
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 interfaceValueProperties
- 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:
-
getRoundingModeFormula
Returns the formula for the rounding mode, can be null if the formula is not set.- Specified by:
getRoundingModeFormula
in interfaceValueProperties
- Returns:
- the formula or null if not set.
- See Also:
-
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'negative type'.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NOT_NEGATIVE
ValuePropertiesConstants.LEADING_MINUS
ValuePropertiesConstants.TRAILING_MINUS
ValuePropertiesConstants.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 interfaceValueProperties
- Returns:
- The current value of the property 'negative type'.
- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NOT_NEGATIVE
ValuePropertiesConstants.LEADING_MINUS
ValuePropertiesConstants.TRAILING_MINUS
ValuePropertiesConstants.BRACKETED
-
setNegativeTypeFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'negative type'. The result of the formula should be in range from 0 to 3.- Since:
- 6.0
- See Also:
-
ValuePropertiesConstants.NOT_NEGATIVE
ValuePropertiesConstants.LEADING_MINUS
ValuePropertiesConstants.TRAILING_MINUS
ValuePropertiesConstants.BRACKETED
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'negative type'.- Since:
- 6.0
-
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'use leading zero'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
- The value of the property 'use leading zero'.
- Since:
- 6.0
-
setUseLeadingZeroFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'use leading zero'.- Since:
- 6.0
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula for the property 'use leading zero'.- Since:
- 6.0
-
setZeroValueString
Sets the value of the property 'zero value string'. If the value isnull
then there will be no custom zero value.- Specified by:
setZeroValueString
in interfaceValueProperties
- Parameters:
newValue
- The new value of the property 'zero value string'.- Since:
- 6.0
-
getZeroValueString
Returns the value of the property 'zero value string'.- Specified by:
getZeroValueString
in interfaceValueProperties
- Returns:
- The value of the property 'zero value string'.
- Since:
- 6.0
-
setNumeralLanguage
public final void setNumeralLanguage(int language) Sets the language of the numerals in number, date, time or datetime values.- Specified by:
setNumeralLanguage
in interfaceValueProperties
- 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 interfaceValueProperties
- Returns:
- One of the language constant or -1 for the report and locale default.
- See Also:
-
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 interfaceValueProperties
- Parameters:
newValue
- The new value of the property.- Since:
- 6.0
- See Also:
-
isAllowFieldClipping
public final boolean isAllowFieldClipping()Returnstrue
if allow field clipping is enabled, elsefalse
is returned.- Specified by:
isAllowFieldClipping
in interfaceValueProperties
- Returns:
- whether field clipping is allowed for this field.
- Since:
- 7.0
-
setAllowFieldClippingFormula
Set the formula for the property 'allow field clipping'.- Specified by:
setAllowFieldClippingFormula
in interfaceValueProperties
- Parameters:
newField
- Formula Field to set for the property "allow field clipping"- Since:
- 6.0
- See Also:
-
getAllowFieldClippingFormula
Get the formula for the property 'allow field clipping'.- Specified by:
getAllowFieldClippingFormula
in interfaceValueProperties
- Returns:
- Formula Field for the property "allow field clipping"
- Since:
- 6.0
- See Also:
-
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 interfaceValueProperties
- Returns:
- The separator to be displayed between the number value and the currency value.
- Since:
- 7.0
-
setCurrencySeparator
Sets the separator to be displayed between the number value and the currency value.- Specified by:
setCurrencySeparator
in interfaceValueProperties
- Parameters:
newCurrencySeparator
- The separator to be used between number value and currency symbol.- Since:
- 7.0
-
getCurrencySeparatorFormula
Returns the formula for the property 'currency separator'. If this formula is notnull
it will be used to get the separator between the number value and the currency symbol otherwise the value ofValueProperties.getCurrencySeparator()
will be used.- Specified by:
getCurrencySeparatorFormula
in interfaceValueProperties
- 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 ofValueProperties.getCurrencySeparator()
should be used. - Since:
- 7.0
-
setCurrencySeparatorFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The formula which should be used for the property 'currency separator' ornull
if no formula should be used.- Since:
- 7.0
-
setField
Sets the field definition element (for example, DatabaseField element, prompt field element). -
getPropertyFormulas
Returns a list with all property formulas that are set for this report element. This includes property formulas for any type of sub-component but excludes formulas for any descendantReportComponent
of this one. To get the property formulas for descendantReportComponent
useReportComponent.getSubComponents()
- Overrides:
getPropertyFormulas
in classAbstractFontElement
- Returns:
- List of property formulas
-
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 interfaceValueProperties
- Returns:
FormulaField
The formula of the property 'manual format'.- Since:
- 6.1
-
setManualFormatFormula
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 interfaceValueProperties
- Parameters:
newFormula
- The new formula for the property 'manual format'.- Since:
- 6.1
-
parseElement
public NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XMLParses 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 interfaceNodeParser
- Overrides:
parseElement
in classAbstractFontElement
- 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 parsedatts
- The set of attributes in the current XMLTagparserMap
- 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.
-
getDateFormatTypeFormula()
instead.