Interface ValueProperties

  • All Known Implementing Classes:
    AbstractValueElement, FieldElement, FieldPart

    public interface ValueProperties
    Interface for elements that display numbers, string and other types of values.

    This class is part of the RDC.
    Since:
    6.1
    • Field Detail

      • USE_SYSTEM_LONG_TIME

        static final int USE_SYSTEM_LONG_TIME
        Use system default long time format.
        See Also:
        Constant Field Values
      • USE_SYSTEM_MEDIUM_TIME

        static final int USE_SYSTEM_MEDIUM_TIME
        Use system default medium time format.
        See Also:
        Constant Field Values
      • USE_SYSTEM_SHORT_TIME

        static final int USE_SYSTEM_SHORT_TIME
        Use system default short time format.
        See Also:
        Constant Field Values
      • USE_SYSTEM_LONG_DATE

        static final int USE_SYSTEM_LONG_DATE
        Use system default long date format.
        See Also:
        Constant Field Values
      • USE_SYSTEM_MEDIUM_DATE

        static final int USE_SYSTEM_MEDIUM_DATE
        Use system default medium date format.
        See Also:
        Constant Field Values
      • USE_SYSTEM_SHORT_DATE

        static final int USE_SYSTEM_SHORT_DATE
        Use system default short date format.
        See Also:
        Constant Field Values
      • NOT_USING_SYSTEM_DEFAULTS

        static final int NOT_USING_SYSTEM_DEFAULTS
        Use a custom format instead of system short or long.
        See Also:
        Constant Field Values
      • NUMBER_FORMAT_INTEGER

        static final int NUMBER_FORMAT_INTEGER
        Use the default Integer NumberFormat instance for formatting numbers.
        See Also:
        NumberFormat.getIntegerInstance(), Constant Field Values
      • NUMBER_FORMAT_FRACTIONAL

        static final int NUMBER_FORMAT_FRACTIONAL
        Use the default NumberFormat instance for formatting numbers.
        See Also:
        NumberFormat.getNumberInstance(), Constant Field Values
      • NUMBER_FORMAT_PERCENT

        static final int NUMBER_FORMAT_PERCENT
        Use the default Integer NumberFormat instance for formatting numbers.
        See Also:
        NumberFormat.getPercentInstance(), Constant Field Values
      • NUMBER_FORMAT_CURRENCY

        static final int NUMBER_FORMAT_CURRENCY
        Use the default Integer NumberFormat instance for formatting numbers.
        See Also:
        NumberFormat.getCurrencyInstance(), Constant Field Values
      • USE_CUSTOM_FORMAT

        static final int USE_CUSTOM_FORMAT
        Use custom date/time format instead of system short, medium or long date/time format.
        See Also:
        Constant Field Values
      • GREGORIAN_CALENDAR

        static final int GREGORIAN_CALENDAR
        Calendar type: gregorian.
        See Also:
        Constant Field Values
      • GREGORIAN_US_CALENDAR

        static final int GREGORIAN_US_CALENDAR
        Calendar type: US-gregorian. Not supported yet, for future use.
        See Also:
        Constant Field Values
      • JAPANESE_CALENDAR

        static final int JAPANESE_CALENDAR
        Calendar type: japanese. Not supported yet, for future use.
        See Also:
        Constant Field Values
      • TAIWANESE_CALENDAR

        static final int TAIWANESE_CALENDAR
        Calendar type: taiwanes Not supported yet, for future use.
        See Also:
        Constant Field Values
      • KOREAN_CALENDAR

        static final int KOREAN_CALENDAR
        Calendar type: korean. Not supported yet, for future use.
        See Also:
        Constant Field Values
      • HIJRI_CALENDAR

        static final int HIJRI_CALENDAR
        Calendar type: hijri. Not supported yet, for future use.
        See Also:
        Constant Field Values
      • THAI_CALENDAR

        static final int THAI_CALENDAR
        Calendar type: thai. Not supported yet, for future use.
        See Also:
        Constant Field Values
      • SHORT_ERA

        static final int SHORT_ERA
        Short era representation. Not supported yet, for future use.
        See Also:
        Constant Field Values
      • LONG_ERA

        static final int LONG_ERA
        Long era representation. Not supported yet, for future use.
        See Also:
        Constant Field Values
      • NO_ERA

        static final int NO_ERA
        No era representation. Not supported yet, for future use.
        See Also:
        Constant Field Values
      • NUMERIC_DAY

        static final int NUMERIC_DAY
        Date format uses a numeric day.
        See Also:
        Constant Field Values
      • LEADING_ZERO_NUMERIC_DAY

        static final int LEADING_ZERO_NUMERIC_DAY
        Date format uses a numeric day with leading zeros.
        See Also:
        Constant Field Values
      • LEADING_ZERO_NUMERIC_MONTH

        static final int LEADING_ZERO_NUMERIC_MONTH
        Date representation has numeric month value with leading zero.
        See Also:
        Constant Field Values
      • LONG_MONTH

        static final int LONG_MONTH
        Date representation has long month value.
        See Also:
        Constant Field Values
      • NO_MONTH

        static final int NO_MONTH
        Date representation has no month value.
        See Also:
        Constant Field Values
      • NUMERIC_MONTH

        static final int NUMERIC_MONTH
        Date representation has numeric month value.
        See Also:
        Constant Field Values
      • SHORT_MONTH

        static final int SHORT_MONTH
        Date representation has short month value.
        See Also:
        Constant Field Values
      • SHORT_YEAR

        static final int SHORT_YEAR
        Date representation has short year.
        See Also:
        Constant Field Values
      • LONG_YEAR

        static final int LONG_YEAR
        Date representation has long year.
        See Also:
        Constant Field Values
      • LEADING_DAY_OF_WEEK

        static final int LEADING_DAY_OF_WEEK
        Date representation has leading day of week.
        See Also:
        Constant Field Values
      • TRAILING_DAY_OF_WEEK

        static final int TRAILING_DAY_OF_WEEK
        Date representation has trailing day of week.
        See Also:
        Constant Field Values
      • DAY_OF_WEEK_ENCLOSURE_NONE

        static final int DAY_OF_WEEK_ENCLOSURE_NONE
        Day of week has no enclosure.
        See Also:
        Constant Field Values
      • DAY_OF_WEEK_ENCLOSURE_PARENTHESIS

        static final int DAY_OF_WEEK_ENCLOSURE_PARENTHESIS
        Day of week in parenthesizes
        See Also:
        Constant Field Values
      • DAY_OF_WEEK_ENCLOSURE_ANGLE

        static final int DAY_OF_WEEK_ENCLOSURE_ANGLE
        Day of week in angle brackets
        See Also:
        Constant Field Values
      • DAY_OF_WEEK_ENCLOSURE_SQUARED

        static final int DAY_OF_WEEK_ENCLOSURE_SQUARED
        Day of week in squared brackets.
        See Also:
        Constant Field Values
      • SHORT_DAY_OF_WEEK

        static final int SHORT_DAY_OF_WEEK
        Day of week has short format, i.e. mon, 01.08.2001.
        See Also:
        Constant Field Values
      • LONG_DAY_OF_WEEK

        static final int LONG_DAY_OF_WEEK
        Day of week has long format, i.e. monday, 01.08.2001.
        See Also:
        Constant Field Values
      • NO_DAY_OF_WEEK

        static final int NO_DAY_OF_WEEK
        No day of week, i.e. 01.08.2001
        See Also:
        Constant Field Values
      • YEAR_MONTH_DAY

        static final int YEAR_MONTH_DAY
        Draw year first, then month and then day.
        See Also:
        Constant Field Values
      • DAY_MONTH_YEAR

        static final int DAY_MONTH_YEAR
        Draw day first, then month and then year.
        See Also:
        Constant Field Values
      • MONTH_DAY_YEAR

        static final int MONTH_DAY_YEAR
        Draw month first, then day and then year.
        See Also:
        Constant Field Values
      • TWELVE_HOURS

        static final int TWELVE_HOURS
        Time base is set to 12 hours.
        See Also:
        Constant Field Values
      • TWENTY_FOUR_HOURS

        static final int TWENTY_FOUR_HOURS
        Time base is set to 24 hours.
        See Also:
        Constant Field Values
      • AM_PM_BEFORE

        static final int AM_PM_BEFORE
        The am/pm symbol is printed before the time value: AM 10:00.
        See Also:
        Constant Field Values
      • AM_PM_AFTER

        static final int AM_PM_AFTER
        The am/pm symbol is printed after the time value: 10:00 PM.
        See Also:
        Constant Field Values
      • NO_HOUR

        static final int NO_HOUR
        Time representation has no hour value.
        See Also:
        Constant Field Values
      • NUMERIC_HOUR

        static final int NUMERIC_HOUR
        Time representation has numeric hour value.
        See Also:
        Constant Field Values
      • NUMERIC_HOUR_NO_LEADING_ZERO

        static final int NUMERIC_HOUR_NO_LEADING_ZERO
        Time representation has numeric hour but no leading zero.
        See Also:
        Constant Field Values
      • NO_MINUTE

        static final int NO_MINUTE
        Time representation has no minute value.
        See Also:
        Constant Field Values
      • NUMERIC_MINUTE

        static final int NUMERIC_MINUTE
        Time representation has numeric minute value.
        See Also:
        Constant Field Values
      • NUMERIC_MINUTE_NO_LEADING_ZERO

        static final int NUMERIC_MINUTE_NO_LEADING_ZERO
        Time representation has numeric minute but no leading zero.
        See Also:
        Constant Field Values
      • NUMERIC_NO_SECOND

        static final int NUMERIC_NO_SECOND
        Time representation has no second value.
        See Also:
        Constant Field Values
      • NUMERIC_SECOND

        static final int NUMERIC_SECOND
        Time representation has numeric value.
        See Also:
        Constant Field Values
      • NUMERIC_NO_LEADING_ZERO

        static final int NUMERIC_NO_LEADING_ZERO
        Time representation has numeric value, but no leading zero.
        See Also:
        Constant Field Values
      • DATE_TIME_ORDER

        static final int DATE_TIME_ORDER
        Date value will be printed before time value.
        See Also:
        Constant Field Values
      • TIME_DATE_ORDER

        static final int TIME_DATE_ORDER
        Date value will be printed after time value.
        See Also:
        Constant Field Values
      • DATE_ONLY_ORDER

        static final int DATE_ONLY_ORDER
        Date value will be printed only.
        See Also:
        Constant Field Values
      • TIME_ONLY_ORDER

        static final int TIME_ONLY_ORDER
        Time value will be printed only.
        See Also:
        Constant Field Values
      • TRUE_OR_FALSE

        static final int TRUE_OR_FALSE
        The output value of a field with return type boolean is represented, according with language, by 'true' or 'false' (en), 'wahr' or 'falsch'(de) etc.
        See Also:
        Constant Field Values
      • T_OR_F

        static final int T_OR_F
        The output value of a field with return type boolean is represented, according with language, by 'T' or 'F' (en), 'W' or 'F'(de) etc.
        See Also:
        Constant Field Values
      • YES_OR_NO

        static final int YES_OR_NO
        The output value of a field with return type boolean is represented, according with language, by 'Yes' or 'No' (en), 'Ja' or 'Nein'(de) etc.
        See Also:
        Constant Field Values
      • Y_OR_N

        static final int Y_OR_N
        The output value of a field with return type boolean is represented, according with language, by 'Y' or 'N' (en), 'J' or 'N'(de) etc.
        See Also:
        Constant Field Values
      • ONE_OR_ZERO

        static final int ONE_OR_ZERO
        The output value of a field with return type boolean is represented by '1' or '0'.
        See Also:
        Constant Field Values
      • LEADING_CURRENCY_INSIDE_NEGATIVE

        static final int LEADING_CURRENCY_INSIDE_NEGATIVE
        The currency symbol will placed leading, then a minus, if number is negative and trailing the number itself, i.e. $-20.
        See Also:
        Constant Field Values
      • LEADING_CURRENCY_OUTSIDE_NEGATIVE

        static final int LEADING_CURRENCY_OUTSIDE_NEGATIVE
        If number is negative, minus will placed leading, then the currency symbol and trailing the number itself, i.e. -$20.
        See Also:
        Constant Field Values
      • TRAILING_CURRENCY_INSIDE_NEGATIVE

        static final int TRAILING_CURRENCY_INSIDE_NEGATIVE
        The number will placed leading, then if number is negative the minus and trailing the currency symbol, i.e. 20-$.
        See Also:
        Constant Field Values
      • TRAILING_CURRENCY_OUTSIDE_NEGATIVE

        static final int TRAILING_CURRENCY_OUTSIDE_NEGATIVE
        If number is negative, minus will placed leading, then the number itself and trailing the currency symbol, i.e. -20$.
        See Also:
        Constant Field Values
      • NO_SYMBOL

        static final int NO_SYMBOL
        The currency symbol will not drawn.
        See Also:
        Constant Field Values
      • FIXED_SYMBOL

        static final int FIXED_SYMBOL
        The currency symbol will be fixed on border of field.
        See Also:
        Constant Field Values
      • FLOATING_SYMBOL

        static final int FLOATING_SYMBOL
        The currency symbol will cleave on number.
        See Also:
        Constant Field Values
      • ROUND_UP

        static final int ROUND_UP
        Rounding mode to round away from zero. Always increments the digit prior to a non-zero discarded fraction. Note that this rounding mode never decreases the magnitude of the calculated value.
        See Also:
        Constant Field Values
      • ROUND_DOWN

        static final int ROUND_DOWN
        Rounding mode to round towards zero. Never increments the digit prior to a discarded fraction (i.e., truncates). Note that this rounding mode never increases the magnitude of the calculated value.
        See Also:
        Constant Field Values
      • ROUND_CEILING

        static final int ROUND_CEILING
        Rounding mode to round towards positive infinity. If the number is positive, behaves as for ROUND_UP; if negative, behaves as for ROUND_DOWN. Note that this rounding mode never decreases the calculated value.
        See Also:
        Constant Field Values
      • ROUND_FLOOR

        static final int ROUND_FLOOR
        Rounding mode to round towards negative infinity. If the number is positive, behave as for ROUND_DOWN; if negative, behave as for ROUND_UP. Note that this rounding mode never increases the calculated value.
        See Also:
        Constant Field Values
      • ROUND_HALF_UP

        static final int ROUND_HALF_UP
        Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up. Behaves as for ROUND_UP if the discarded fraction is >= .5; otherwise, behaves as for ROUND_DOWN. Note that this is the rounding mode that most of us were taught in grade school.
        See Also:
        Constant Field Values
      • ROUND_HALF_DOWN

        static final int ROUND_HALF_DOWN
        Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down. Behaves as for ROUND_UP if the discarded fraction is > .5; otherwise, behaves as for ROUND_DOWN.
        See Also:
        Constant Field Values
      • ROUND_HALF_EVEN

        static final int ROUND_HALF_EVEN
        Rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor. Behaves as for ROUND_HALF_UP if the digit to the left of the discarded fraction is odd; behaves as for ROUND_HALF_DOWN if it is even. Note that this is the rounding mode that minimizes cumulative error when applied repeatedly over a sequence of calculations.
        See Also:
        Constant Field Values
      • NOT_NEGATIVE

        static final int NOT_NEGATIVE
        Number representation has no minus, also if number is negative.
        See Also:
        Constant Field Values
      • LEADING_MINUS

        static final int LEADING_MINUS
        Number representation has leading minus if number is negative.
        See Also:
        Constant Field Values
      • TRAILING_MINUS

        static final int TRAILING_MINUS
        Number representation has trailing minus if number is negative.
        See Also:
        Constant Field Values
      • BRACKETED

        static final int BRACKETED
        Number representation has bracketed number with minus if number is negative.
        See Also:
        Constant Field Values
      • DEFAULT_FORMAT

        static final java.lang.String DEFAULT_FORMAT
        FOR INTERNAL USE ONLY
        See Also:
        Constant Field Values
    • Method Detail

      • getNumberFormatType

        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.
        Returns:
        The number format type set for this element.
        Since:
        8.0
        See Also:
        NUMBER_FORMAT_INTEGER, NUMBER_FORMAT_FRACTIONAL, NUMBER_FORMAT_PERCENT, NUMBER_FORMAT_CURRENCY, USE_CUSTOM_FORMAT
      • setNumberFormatType

        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.
        Parameters:
        newValue - The number format type to set for this element
        Since:
        8.0
        See Also:
        NUMBER_FORMAT_INTEGER, NUMBER_FORMAT_FRACTIONAL, NUMBER_FORMAT_PERCENT, NUMBER_FORMAT_CURRENCY, USE_CUSTOM_FORMAT
      • getNumberFormatTypeFormula

        FormulaField getNumberFormatTypeFormula()
        Returns the formula which returns the number format type to use for this element. This type specifies whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.
        Returns:
        The formula field which returns the number format type to use for this element.
        Since:
        8.0
        See Also:
        NUMBER_FORMAT_INTEGER, NUMBER_FORMAT_FRACTIONAL, NUMBER_FORMAT_PERCENT, NUMBER_FORMAT_CURRENCY, USE_CUSTOM_FORMAT
      • setNumberFormatTypeFormula

        void setNumberFormatTypeFormula​(FormulaField newFormula)
        Sets the formula which returns the number format type to use for this element. This type specifies whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.
        Parameters:
        newFormula - The formula field which returns the number format type to use for this element
        Since:
        8.0
        See Also:
        NUMBER_FORMAT_INTEGER, NUMBER_FORMAT_FRACTIONAL, NUMBER_FORMAT_PERCENT, NUMBER_FORMAT_CURRENCY, USE_CUSTOM_FORMAT
      • getDateFormatType

        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.
        Returns:
        The date format type set for this element.
        Since:
        8.0
        See Also:
        USE_SYSTEM_LONG_DATE, USE_SYSTEM_MEDIUM_DATE, USE_SYSTEM_SHORT_DATE, NOT_USING_SYSTEM_DEFAULTS
      • setDateFormatType

        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.
        Parameters:
        newValue - The date format type set for this element
        Since:
        8.0
        See Also:
        USE_SYSTEM_LONG_DATE, USE_SYSTEM_MEDIUM_DATE, USE_SYSTEM_SHORT_DATE, NOT_USING_SYSTEM_DEFAULTS
      • getDateFormatTypeFormula

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

        void setDateFormatTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'date format type'. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not take effect.
        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).
        Since:
        8.0
        See Also:
        USE_SYSTEM_LONG_DATE, USE_SYSTEM_MEDIUM_DATE, USE_SYSTEM_SHORT_DATE, NOT_USING_SYSTEM_DEFAULTS
      • getTimeFormatType

        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.
        Returns:
        the time format type set for this element.
        Since:
        8.0
        See Also:
        USE_SYSTEM_LONG_TIME, USE_SYSTEM_MEDIUM_TIME, USE_SYSTEM_SHORT_TIME, USE_CUSTOM_FORMAT
      • setTimeFormatType

        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.
        Parameters:
        systemDefaultTimeType - the time format type set for this element
        Since:
        8.0
        See Also:
        USE_SYSTEM_LONG_TIME, USE_SYSTEM_MEDIUM_TIME, USE_SYSTEM_SHORT_TIME, USE_CUSTOM_FORMAT
      • getTimeFormatTypeFormula

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

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

        FormulaField getDateCalendarTypeFormula()
        For future use. Returns the formula of the property 'date calendar type'. Use this property to choose a calendar.
        Returns:
        FormulaField The formula of the property 'date calendar type'.
        Since:
        6.1
      • getDateEraType

        int getDateEraType()
        For future use. Returns the value of the property 'date era type'.
        Returns:
        The value of the property 'date era type'.
        Since:
        6.1
        See Also:
        SHORT_ERA, LONG_ERA, NO_ERA
      • setDateEraType

        void setDateEraType​(int newValue)
        For future use. Sets the value of the property 'date era type'.
        Parameters:
        newValue - The new value of the property 'date era type'.
        Since:
        6.1
        See Also:
        SHORT_ERA, LONG_ERA, NO_ERA
      • getDateEraTypeFormula

        FormulaField getDateEraTypeFormula()
        For future use. Returns the formula of the property 'date era type'.
        Returns:
        FormulaField The formula for the property 'date era type'.
        Since:
        6.1
      • setDateEraTypeFormula

        void setDateEraTypeFormula​(FormulaField newFormula)
        For future use. Sets the formula for the property 'date era type'.
        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.1
        See Also:
        SHORT_ERA, LONG_ERA, NO_ERA
      • getDayType

        int getDayType()
        Returns the value of the property 'day type'. Use this property to specify the day representation of a custom date format.
        Returns:
        The value of the property 'day type'.
        Since:
        6.1
        See Also:
        NUMERIC_DAY, LEADING_ZERO_NUMERIC_DAY, NO_DAY
      • setDayType

        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.
        Parameters:
        newValue - The new value of the property 'day type'.
        Since:
        6.1
        See Also:
        NUMERIC_DAY, LEADING_ZERO_NUMERIC_DAY, NO_DAY
      • getDayTypeFormula

        FormulaField getDayTypeFormula()
        Returns the formula for the property 'day type'. Use this property to specify the day representation of a custom date format.
        Returns:
        FormulaField The formula of the property 'day type'.
        Since:
        6.1
        See Also:
        NUMERIC_DAY, LEADING_ZERO_NUMERIC_DAY, NO_DAY
      • setDayTypeFormula

        void setDayTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'day type'. Use this property to specify the day representation of a custom date format.
        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.1
        See Also:
        NUMERIC_DAY, LEADING_ZERO_NUMERIC_DAY, NO_DAY
      • setMonthType

        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.
        Parameters:
        newValue - The new value of the property 'month type'.
        Since:
        6.1
        See Also:
        LEADING_ZERO_NUMERIC_MONTH, LONG_MONTH, NO_MONTH, NUMERIC_MONTH, SHORT_MONTH
      • setMonthTypeFormula

        void setMonthTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'month type'. Use this property to set the representation of the month part in a custom format date.
        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.1
        See Also:
        LEADING_ZERO_NUMERIC_MONTH, LONG_MONTH, NO_MONTH, NUMERIC_MONTH, SHORT_MONTH
      • getMonthTypeFormula

        FormulaField getMonthTypeFormula()
        Returns the formula for the property 'month type'. Use this property to set the representation of the month part in a custom format date.
        Returns:
        FormulaField The formula for the property 'month type'.
        Since:
        6.1
      • setYearType

        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.
        Parameters:
        newValue - The new value of the property 'year type'.
        Since:
        6.1
        See Also:
        SHORT_YEAR, LONG_YEAR, NO_YEAR
      • getYearType

        int getYearType()
        Returns the value of the property 'year type'. Use this property to specify the year representation of a custom date format.
        Returns:
        The value of the property 'year type'.
        Since:
        6.1
        See Also:
        SHORT_YEAR, LONG_YEAR, NO_YEAR
      • setYearTypeFormula

        void setYearTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'year type'. Use this property to specify the year representation of a custom date format.
        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.1
        See Also:
        SHORT_YEAR, LONG_YEAR, NO_YEAR
      • getYearTypeFormula

        FormulaField getYearTypeFormula()
        Returns the formula for the property 'year type'. Use this property to specify the year representation of a custom date format.
        Returns:
        FormulaField The formula for the property 'year type'.
        Since:
        6.1
      • getDayOfWeekPosition

        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.
        Returns:
        The value of the property 'day of week position'.
        Since:
        6.1
        See Also:
        LEADING_DAY_OF_WEEK, TRAILING_DAY_OF_WEEK
      • setDayOfWeekPosition

        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.
        Parameters:
        newValue - The new value of the property 'day of week position'.
        Since:
        6.1
        See Also:
        LEADING_DAY_OF_WEEK, TRAILING_DAY_OF_WEEK
      • getDayOfWeekPositionFormula

        FormulaField getDayOfWeekPositionFormula()
        Returns the formula for the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.
        Returns:
        FormulaField The formula for the property 'day of week position'.
        Since:
        6.1
      • setDayOfWeekPositionFormula

        void setDayOfWeekPositionFormula​(FormulaField newFormula)
        Sets the formula for the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.
        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.1
        See Also:
        LEADING_DAY_OF_WEEK, TRAILING_DAY_OF_WEEK
      • getDayOfWeekEnclosureFormula

        FormulaField getDayOfWeekEnclosureFormula()
        Returns the formula for the property 'day of week enclosure'.
        Returns:
        The formula for the property 'day of week enclosure'.
        Since:
        6.1
      • setDayOfWeekEnclosureFormula

        void setDayOfWeekEnclosureFormula​(FormulaField newFormula)
        Sets the formula for the property 'day of week enclosure'. Use this property to specify the enclosure of the week day name.
        Parameters:
        newFormula - The new formula for the property 'week day enclosure'.
        Since:
        6.1
      • setDayOfWeekSeparator

        void setDayOfWeekSeparator​(java.lang.String newValue)
        Sets the value of the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.
        Parameters:
        newValue - The new value of the property 'day of week separator'.
        Since:
        6.1
      • getDayOfWeekSeparator

        java.lang.String getDayOfWeekSeparator()
        Returns the value of the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.
        Returns:
        The current value of the property 'day of week separator'.
        Since:
        6.1
      • setDayOfWeekSeparatorFormula

        void setDayOfWeekSeparatorFormula​(FormulaField newFormula)
        Sets the formula for the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.
        Parameters:
        newFormula - The new formula for the property 'day of week separator'.
        Since:
        6.1
      • getDayOfWeekSeparatorFormula

        FormulaField getDayOfWeekSeparatorFormula()
        Returns the formula for the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.
        Returns:
        FormulaField The formula for the property 'day of week separator'.
        Since:
        6.1
      • getDayOfWeekType

        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.
        Returns:
        The value of the property 'day of week type'.
        Since:
        6.1
        See Also:
        SHORT_DAY_OF_WEEK, LONG_DAY_OF_WEEK, NO_DAY_OF_WEEK
      • setDayOfWeekType

        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.
        Parameters:
        newValue - The new value of the property 'day of week type'.
        Since:
        6.1
        See Also:
        SHORT_DAY_OF_WEEK, LONG_DAY_OF_WEEK, NO_DAY_OF_WEEK
      • getDayOfWeekTypeFormula

        FormulaField getDayOfWeekTypeFormula()
        Returns the formula for the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.
        Returns:
        FormulaField The formula for the property 'day of week type'.
        Since:
        6.1
      • setDayOfWeekTypeFormula

        void setDayOfWeekTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.
        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.1
        See Also:
        SHORT_DAY_OF_WEEK, LONG_DAY_OF_WEEK, NO_DAY_OF_WEEK
      • getDateOrder

        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.
        Returns:
        The value of the property 'date order'.
        Since:
        6.1
        See Also:
        YEAR_MONTH_DAY, DAY_MONTH_YEAR, MONTH_DAY_YEAR
      • setDateOrder

        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.
        Parameters:
        newValue - The new value of the property 'date order'.
        Since:
        6.1
        See Also:
        YEAR_MONTH_DAY, DAY_MONTH_YEAR, MONTH_DAY_YEAR
      • getDateOrderFormula

        FormulaField getDateOrderFormula()
        Returns the formula for the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.
        Returns:
        FormulaField The formula of the property 'date order'.
        Since:
        6.1
      • setDateOrderFormula

        void setDateOrderFormula​(FormulaField newFormula)
        Sets the formula for the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.
        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.1
        See Also:
        YEAR_MONTH_DAY, DAY_MONTH_YEAR, MONTH_DAY_YEAR
      • getDatePrefixSeparator

        java.lang.String getDatePrefixSeparator()
        Returns the value of the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.
        Returns:
        The value of the property 'date prefix separator'.
        Since:
        6.1
      • setDatePrefixSeparator

        void setDatePrefixSeparator​(java.lang.String newValue)
        Sets the value of the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.
        Parameters:
        newValue - The new value of the property 'date prefix separator'.
        Since:
        6.1
      • getDatePrefixSeparatorFormula

        FormulaField getDatePrefixSeparatorFormula()
        Returns the formula for the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.
        Returns:
        FormulaField The formula of the property 'date prefix separator'.
        Since:
        6.1
      • setDatePrefixSeparatorFormula

        void setDatePrefixSeparatorFormula​(FormulaField newFormula)
        Sets the formula for the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.
        Parameters:
        newFormula - The new formula for the property 'date prefix separator'.
        Since:
        6.1
      • getDateFirstSeparator

        java.lang.String getDateFirstSeparator()
        Returns the value of the property 'date first separator'. Each date can be separated into three part. Use this property to specify the character(s) which separate the first and the second part.
        Returns:
        The value of the property 'date firts separator'.
        Since:
        6.1
      • setDateFirstSeparator

        void setDateFirstSeparator​(java.lang.String newValue)
        Sets the value of the property 'date first separator'. Each date can be separated into three part. Use this property to specify the character(s) which separate the first and the second part.
        Parameters:
        newValue - The new value of the property 'date first separator'.
        Since:
        6.1
      • getDateFirstSeparatorFormula

        FormulaField getDateFirstSeparatorFormula()
        Returns the formula for the property 'date first separator'. Each date can be separated into three part. Use this property to specify the character(s) which separate the first and the second part.
        Returns:
        FormulaField The formula for the property 'date first separator'.
        Since:
        6.1
      • setDateFirstSeparatorFormula

        void setDateFirstSeparatorFormula​(FormulaField newFormula)
        Sets the formula for the property 'date first separator'. Each date can be separated into three part. Use this property to specify the character(s) which separate the first and the second part.
        Parameters:
        newFormula - The new formula for the property 'date first separator'.
        Since:
        6.1
      • getDateSecondSeparator

        java.lang.String getDateSecondSeparator()
        Returns the value of the property 'date second separator'. Each date can be separated into three part. Use this property to specify the character(s) which separate the second and the third part.
        Returns:
        The value of the property 'date second separator'.
        Since:
        6.1
      • setDateSecondSeparator

        void setDateSecondSeparator​(java.lang.String newValue)
        Sets the value of the property 'date second separator'. Each date can be separated into three part. Use this property to specify the character(s) which separate the second and the third part.
        Parameters:
        newValue - The new value of the property 'date second separator'.
        Since:
        6.1
      • getDateSecondSeparatorFormula

        FormulaField getDateSecondSeparatorFormula()
        Returns the formula for the property 'date second separator'. Each date can be separated into three part. Use this property to specify the character(s) which separate the second and the third part.
        Returns:
        FormulaField The formula of the property 'date second separator'.
        Since:
        6.1
      • setDateSecondSeparatorFormula

        void setDateSecondSeparatorFormula​(FormulaField newFormula)
        Sets the formula for the property 'date second separator'. Each date can be separated into three part. Use this property to specify the character(s) which separate the second and the third part.
        Parameters:
        newFormula - The new formula for the property 'date second separator'.
        Since:
        6.1
      • getDateSuffixSeparator

        java.lang.String getDateSuffixSeparator()
        Returns the value of the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.
        Returns:
        The value of the property 'date suffix separator'.
        Since:
        6.1
      • setDateSuffixSeparator

        void setDateSuffixSeparator​(java.lang.String newValue)
        Sets the value of the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.
        Parameters:
        newValue - The new value of the property 'date suffix separator'.
        Since:
        6.1
      • getDateSuffixSeparatorFormula

        FormulaField getDateSuffixSeparatorFormula()
        Returns the formula for the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.
        Returns:
        FormulaField The formula of the property 'date suffix separator'.
        Since:
        6.1
      • setDateSuffixSeparatorFormula

        void setDateSuffixSeparatorFormula​(FormulaField newFormula)
        Sets the formula for the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.
        Parameters:
        newFormula - The new formula for the property 'date suffix separator'.
        Since:
        6.1
      • setTimeBase

        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.
        Parameters:
        newValue - The new value of the property 'time base'.
        Since:
        6.1
        See Also:
        TWELVE_HOURS, TWENTY_FOUR_HOURS
      • getTimeBase

        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.
        Returns:
        The value of the property 'time base'.
        Since:
        6.1
        See Also:
        TWELVE_HOURS, TWENTY_FOUR_HOURS
      • setTimeBaseFormula

        void setTimeBaseFormula​(FormulaField newFormula)
        Sets the formula for the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.
        Parameters:
        newFormula - The new formula for the property 'time base'.
        Since:
        6.1
        See Also:
        TWELVE_HOURS, TWENTY_FOUR_HOURS
      • getTimeBaseFormula

        FormulaField getTimeBaseFormula()
        Returns the formula for the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.
        Returns:
        FormulaField The formula for the property 'time base'.
        Since:
        6.1
      • getAmString

        java.lang.String getAmString()
        Returns the value of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.
        Returns:
        The value of the property 'am string'.
        Since:
        6.1
      • setAmString

        void setAmString​(java.lang.String newValue)
        Sets the value of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.
        Parameters:
        newValue - The new value of the property 'am string'.
        Since:
        6.1
      • getAmStringFormula

        FormulaField getAmStringFormula()
        Returns the formula of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.
        Returns:
        FormulaField if a formula for this property was defined else null.
        Since:
        6.1
      • setAmStringFormula

        void setAmStringFormula​(FormulaField newFormula)
        Sets the formula for the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.
        Parameters:
        newFormula - The new formula for the property 'am string'.
        Since:
        6.1
      • getPmString

        java.lang.String getPmString()
        Returns the value of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.
        Returns:
        The value of the property 'pm string'.
        Since:
        6.1
      • setPmString

        void setPmString​(java.lang.String newValue)
        Sets the value of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.
        Parameters:
        newValue - The new value of the property 'pm string'.
        Since:
        6.1
      • getPmStringFormula

        FormulaField getPmStringFormula()
        Returns the formula of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.
        Returns:
        FormulaField if a formula for this property was defined else null.
        Since:
        6.1
      • setPmStringFormula

        void setPmStringFormula​(FormulaField newFormula)
        Sets the formula for the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.
        Parameters:
        newFormula - The new formula for the property 'pm string'.
        Since:
        6.1
      • getAmPmOrder

        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.
        Returns:
        The current value of property.
        Since:
        6.1
        See Also:
        AM_PM_BEFORE, AM_PM_AFTER
      • setAmPmOrder

        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.
        Parameters:
        newValue - The new value for property.
        Since:
        6.1
        See Also:
        AM_PM_BEFORE, AM_PM_AFTER
      • getAmPmOrderFormula

        FormulaField getAmPmOrderFormula()
        returns the formula of the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.
        Returns:
        FormulaField if a formula for this property was defined else null.
        Since:
        6.1
      • setAmPmOrderFormula

        void setAmPmOrderFormula​(FormulaField newFormula)
        Sets the formula for the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.
        Parameters:
        newFormula - The new formula for the property 'am pm order/type'. The result of the formula should either 0 or 1.
        Since:
        6.1
        See Also:
        AM_PM_BEFORE, AM_PM_AFTER
      • setHourType

        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.
        Parameters:
        newValue - The new value of the property 'hour type'.
        Since:
        6.1
        See Also:
        NO_HOUR, NUMERIC_HOUR, NUMERIC_HOUR_NO_LEADING_ZERO
      • getHourType

        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.
        Returns:
        The current value of the property 'hour type'.
        Since:
        6.1
        See Also:
        NO_HOUR, NUMERIC_HOUR, NUMERIC_HOUR_NO_LEADING_ZERO
      • setHourTypeFormula

        void setHourTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.
        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.1
        See Also:
        NO_HOUR, NUMERIC_HOUR, NUMERIC_HOUR_NO_LEADING_ZERO
      • getHourTypeFormula

        FormulaField getHourTypeFormula()
        Returns the formula for the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.
        Returns:
        FormulaField The current formula for the property 'hour type'.
        Since:
        6.1
      • setMinuteType

        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.
        Parameters:
        newValue - The new value of the property 'minute type'.
        Since:
        6.1
        See Also:
        NO_MINUTE, NUMERIC_MINUTE, NUMERIC_MINUTE_NO_LEADING_ZERO
      • getMinuteType

        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.
        Returns:
        The current value of the property 'minute type'.
        Since:
        6.1
        See Also:
        NO_MINUTE, NUMERIC_MINUTE, NUMERIC_MINUTE_NO_LEADING_ZERO
      • setMinuteTypeFormula

        void setMinuteTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.
        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.1
        See Also:
        NO_MINUTE, NUMERIC_MINUTE, NUMERIC_MINUTE_NO_LEADING_ZERO
      • getMinuteTypeFormula

        FormulaField getMinuteTypeFormula()
        Returns the formula for the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.
        Returns:
        FormulaField The formula for the property 'minute type'.
        Since:
        6.1
      • setSecondType

        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.
        Parameters:
        newValue - The new value of the property 'second type'.
        Since:
        6.1
        See Also:
        NUMERIC_NO_SECOND, NUMERIC_SECOND, NUMERIC_NO_LEADING_ZERO
      • getSecondType

        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.
        Returns:
        The current value of the property 'second type'.
        Since:
        6.1
        See Also:
        NUMERIC_NO_SECOND, NUMERIC_SECOND, NUMERIC_NO_LEADING_ZERO
      • setSecondTypeFormula

        void setSecondTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.
        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.1
        See Also:
        NUMERIC_NO_SECOND, NUMERIC_SECOND, NUMERIC_NO_LEADING_ZERO
      • getSecondTypeFormula

        FormulaField getSecondTypeFormula()
        Returns the formula for the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.
        Returns:
        FormulaField The formula for the property 'second type'.
        Since:
        6.1
      • getHourMinuteSeparator

        java.lang.String getHourMinuteSeparator()
        Returns the value of the property 'hour minute separator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.
        Returns:
        The current value of the property 'hour minute separator'.
        Since:
        6.1
      • setHourMinuteSeparator

        void setHourMinuteSeparator​(java.lang.String newValue)
        Sets the value of the property 'hour minute separator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.
        Parameters:
        newValue - The new value of the property 'hour minute separator'.
        Since:
        6.1
      • setHourMinuteSeparatorFormula

        void setHourMinuteSeparatorFormula​(FormulaField newFormula)
        Sets the formula for the property 'hour minute separator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.
        Parameters:
        newFormula - The new formula for the property 'hour minute separator'.
        Since:
        6.1
      • getHourMinuteSeparatorFormula

        FormulaField getHourMinuteSeparatorFormula()
        Returns the formula for the property 'hour minute separator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.
        Returns:
        FormulaField The current formula for the property 'hour minute separator'.
        Since:
        6.1
      • setMinuteSecondSeparator

        void setMinuteSecondSeparator​(java.lang.String newValue)
        Sets the value of the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.
        Parameters:
        newValue - The new value of the property 'minute second separator'.
        Since:
        6.1
      • getMinuteSecondSeparator

        java.lang.String getMinuteSecondSeparator()
        Returns the value of the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.
        Returns:
        The current value of the property 'minute second separator'.
        Since:
        6.1
      • setMinuteSecondSeparatorFormula

        void setMinuteSecondSeparatorFormula​(FormulaField newFormula)
        Sets the formula for the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.
        Parameters:
        newFormula - The new formula for the property 'minute second separator'.
        Since:
        6.1
      • getMinuteSecondSeparatorFormula

        FormulaField getMinuteSecondSeparatorFormula()
        Returns the formula for the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.
        Returns:
        FormulaField The formula for the property 'minute second separator'.
        Since:
        6.1
      • setDateTimeOrder

        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.
        Parameters:
        newValue - The new value of the property 'date time order'.
        Since:
        6.1
        See Also:
        DATE_TIME_ORDER, TIME_DATE_ORDER, DATE_ONLY_ORDER, TIME_ONLY_ORDER
      • getDateTimeOrder

        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.
        Returns:
        The value of the property 'date time order'.
        Since:
        6.1
        See Also:
        DATE_TIME_ORDER, TIME_DATE_ORDER, DATE_ONLY_ORDER, TIME_ONLY_ORDER
      • setDateTimeOrderFormula

        void setDateTimeOrderFormula​(FormulaField newFormula)
        Sets the formula for the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.
        Parameters:
        newFormula - The new formula for the property 'date time order'.
        Since:
        6.1
        See Also:
        DATE_TIME_ORDER, TIME_DATE_ORDER, DATE_ONLY_ORDER, TIME_ONLY_ORDER
      • getDateTimeOrderFormula

        FormulaField getDateTimeOrderFormula()
        Returns the formula for the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.
        Returns:
        FormulaField The formula for the property 'date time order'.
        Since:
        6.1
        See Also:
        DATE_TIME_ORDER, TIME_DATE_ORDER, DATE_ONLY_ORDER, TIME_ONLY_ORDER
      • setDateTimeSeparator

        void setDateTimeSeparator​(java.lang.String newValue)
        Sets the value of the property 'date time separator'. Use this property to specify the character(s) for separation of date value and time value for a custom date/time format.
        Parameters:
        newValue - The new value of the property 'date time separator'.
        Since:
        6.1
      • getDateTimeSeparator

        java.lang.String getDateTimeSeparator()
        Returns the value of the property 'date time separator'. Use this property to specify the character(s) for separation of date value and time value for a custom date/time format.
        Returns:
        The value of the property 'date time separator'.
        Since:
        6.1
      • setDateTimeSeparatorFormula

        void setDateTimeSeparatorFormula​(FormulaField newFormula)
        Sets the formula for the property 'date time separator'. Use this property to specify the character(s) for separation of date value and time value for a custom date/time format.
        Parameters:
        newFormula - The new formula for the property 'date time separator'.
        Since:
        6.1
      • getDateTimeSeparatorFormula

        FormulaField getDateTimeSeparatorFormula()
        Returns the formula for the property 'date time separator'. Use this property to specify the character(s) for separation of date value and time value for a custom date/time format.
        Returns:
        FormulaField The formula for the property 'date time separator'.
        Since:
        6.1
      • getBooleanFormatOutputType

        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 false.
        Returns:
        The value of the property 'boolean format output type'.
        Since:
        6.1
        See Also:
        TRUE_OR_FALSE, T_OR_F, YES_OR_NO, Y_OR_N, ONE_OR_ZERO
      • setBooleanFormatOutputType

        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 false.
        Parameters:
        newValue - The new value for the property 'boolean format output type'.
        Since:
        6.1
        See Also:
        TRUE_OR_FALSE, T_OR_F, YES_OR_NO, Y_OR_N, ONE_OR_ZERO
      • setBooleanFormatOutputTypeFormula

        void setBooleanFormatOutputTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or false.
        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.1
        See Also:
        TRUE_OR_FALSE, T_OR_F, YES_OR_NO, Y_OR_N, ONE_OR_ZERO
      • getBooleanFormatOutputTypeFormula

        FormulaField getBooleanFormatOutputTypeFormula()
        Returns the formula for the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or false.
        Returns:
        FormulaField The formula for the property 'boolean format output type'.
        Since:
        10.1
      • getCurrencyPositionFormula

        FormulaField getCurrencyPositionFormula()
        Returns the formula for the property 'currency position type'. With this property you can specify the position of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency inside negative.
        Returns:
        FormulaField The formula for the property 'currency position type'.
        Since:
        6.1
      • setCurrencySymbol

        void setCurrencySymbol​(java.lang.String newValue)
        Sets the value of the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbol type' not to NO_SYMBOL and the property 'use system default format' is disabled.
        Parameters:
        newValue - The new value of the property 'currency symbol'.
        Since:
        6.1
      • getCurrencySymbol

        java.lang.String getCurrencySymbol()
        Returns the value of the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbol type' not to NO_SYMBOL and the property 'use system default format' is disabled.
        Returns:
        The value of the property 'currency symbol'.
        Since:
        6.1
      • setCurrencySymbolFormula

        void setCurrencySymbolFormula​(FormulaField newFormula)
        Sets the formula for the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbol type' not to NO_SYMBOL and the property 'use system default format' is disabled.
        Parameters:
        newFormula - The new formula for the property 'currency symbol'.
        Since:
        6.1
      • getCurrencySymbolFormula

        FormulaField getCurrencySymbolFormula()
        Returns the formula for the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbol type' not to NO_SYMBOL and the property 'use system default format' is disabled.
        Returns:
        The formula of the property 'currency symbol'
        Since:
        6.1
      • setCurrencySymbolType

        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'.
        Parameters:
        newValue - The new value of the property 'currency symbol type'.
        Since:
        6.1
        See Also:
        NO_SYMBOL, FIXED_SYMBOL, FLOATING_SYMBOL
      • getCurrencySymbolType

        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'.
        Returns:
        The value of the property 'currency symbol type'.
        Since:
        6.1
        See Also:
        NO_SYMBOL, FIXED_SYMBOL, FLOATING_SYMBOL
      • setCurrencySymbolTypeFormula

        void setCurrencySymbolTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.
        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.1
        See Also:
        NO_SYMBOL, FIXED_SYMBOL, FLOATING_SYMBOL
      • getCurrencySymbolTypeFormula

        FormulaField getCurrencySymbolTypeFormula()
        Returns the formula for the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.
        Returns:
        The formula for the property 'currency symbol type'.
        Since:
        6.1
      • setUseOneCurrencySymbolPerPage

        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 do not have a currency symbol on current page. This property will not take effect when property 'use system default' is set.
        Parameters:
        newValue - The new value of the property 'use one currency symbol per page'.
        Since:
        6.1
      • getUseOneCurrencySymbolPerPage

        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 do not have a currency symbol on current page. This property will not take effect when property 'use system default' is set.
        Returns:
        The value of the property 'use one currency symbol per page'.
        Since:
        6.1
      • setUseOneCurrencySymbolPerPageFormula

        void setUseOneCurrencySymbolPerPageFormula​(FormulaField newFormula)
        Sets the formula for the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field do not have a currency symbol on current page. This property will not take effect when property 'use system default' is set.
        Parameters:
        newFormula - The new formula for the property 'use one currency symbol per page'.
        Since:
        6.1
      • getUseOneCurrencySymbolPerPageFormula

        FormulaField getUseOneCurrencySymbolPerPageFormula()
        Returns the formula for the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field do not have a currency symbol on current page. This property will not take effect when property 'use system default' is set.
        Returns:
        FormulaField The formula for the property 'use one currency symbol per page'.
        Since:
        6.1
      • getNDecimalPlaces

        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.
        Returns:
        The value of the property 'n decimal places'.
        Since:
        6.1
        See Also:
        getRounding(), setNumberFormatType(int)
      • setNDecimalPlaces

        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.
        Parameters:
        newValue - The new value of the property 'n decimal places'.
        Since:
        6.1
        See Also:
        getRounding(), setNumberFormatType(int)
      • getNDecimalPlacesFormula

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

        void setNDecimalPlacesFormula​(FormulaField newFormula)
        Sets the formula for the property 'n decimal places'. This property allows you to set the number of decimal places (possible values are 0 to 10). Note that if your number format is a system default it is possible that your system default will override any manual setting here. In this case, set the number format type to 'use custom format' if you want your own settings.
        Parameters:
        newFormula - The new formula for the property 'n decimal places'.
        Since:
        6.1
        See Also:
        setNumberFormatType(int)
      • getDecimalSeparatorSymbol

        java.lang.String getDecimalSeparatorSymbol()
        Returns the value of the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.
        Returns:
        The value of the property 'decimal separators symbol'.
        Since:
        6.1
      • setDecimalSeparatorSymbol

        void setDecimalSeparatorSymbol​(java.lang.String newValue)
        Sets the value of the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.
        Parameters:
        newValue - The new value of the property 'decimal separators symbol'.
        Since:
        6.1
      • getDecimalSeparatorSymbolFormula

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

        void setDecimalSeparatorSymbolFormula​(FormulaField newFormula)
        Sets the formula for the property 'decimal separators symbol'. This property allows you to give the character(s) which should be used as decimal separators. If you have set the property 'use system default' a decimal point (.) is always used. Unset the property 'use system default' when you want to use your own.
        Parameters:
        newFormula - The new formula for the property 'decimal separators symbol'.
        Since:
        6.1
      • setReverseSignForDisplay

        void setReverseSignForDisplay​(boolean newValue)
        Sets the property 'use reverse sign for display'.
        Parameters:
        newValue - New value for the property 'use reverse sign for display'.
        Since:
        6.1
      • isReverseSignForDisplay

        boolean isReverseSignForDisplay()
        Checks the property 'use reverse sign for display'
        Returns:
        Whether the property 'use reverse sign for display' is on or off.
        Since:
        7.0
      • getReverseSignForDisplayFormula

        FormulaField getReverseSignForDisplayFormula()
        Returns the formula for the property 'use reverse sign for display'.
        Returns:
        FormulaField The formula of the property 'use reverse sign for display'.
        Since:
        6.1
      • setReverseSignForDisplayFormula

        void setReverseSignForDisplayFormula​(FormulaField newFormula)
        Sets the formula for the property 'use reverse sign for display'.
        Parameters:
        newFormula - The new formula for the property 'use reverse sign for display'.
        Since:
        6.1
      • setSuppressIfZero

        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.
        Parameters:
        newValue - The new value of the property 'suppress if zero'.
        Since:
        6.1
      • getSuppressIfZero

        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.
        Returns:
        The value of the property 'suppress if zero'.
        Since:
        6.1
      • setSuppressIfZeroFormula

        void setSuppressIfZeroFormula​(FormulaField newFormula)
        Sets the formula for the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.
        Parameters:
        newFormula - The new formula for the property 'suppress if zero'.
        Since:
        6.1
      • getSuppressIfZeroFormula

        FormulaField getSuppressIfZeroFormula()
        Returns the formula for the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.
        Returns:
        FormulaField The formula for the property 'suppress if zero'.
        Since:
        6.1
      • setUseThousandsSeparator

        void setUseThousandsSeparator​(boolean newValue)
        Sets the value of the property 'use thousands separator'. When this property is enabled a separator 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.
        Parameters:
        newValue - The new value of the property 'use thousands separator'.
        Since:
        6.1
      • getUseThousandsSeparator

        boolean getUseThousandsSeparator()
        Returns the value of the property 'use thousands separator'. When this property is enabled a separator 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.
        Returns:
        The value of the property 'use thousands separator'.
        Since:
        6.1
      • setUseThousandsSeparatorFormula

        void setUseThousandsSeparatorFormula​(FormulaField newFormula)
        Sets the formula for the property 'use thousands separator'. When this property is enabled a separator 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.
        Parameters:
        newFormula - The new formula for the property 'use thousands separator'.
        Since:
        6.1
      • getUseThousandsSeparatorFormula

        FormulaField getUseThousandsSeparatorFormula()
        Returns the formula for the property 'use thousands separator'. When this property is enabled a separator 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.
        Returns:
        FormulaField The formula for the property 'use thousands separator'.
        Since:
        6.1
      • setThousandsSeparatorSymbol

        void setThousandsSeparatorSymbol​(java.lang.String newValue)
        Sets the value of the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.
        Parameters:
        newValue - The new value of the property 'thousands separator symbol'.
        Since:
        6.1
      • getThousandsSeparatorSymbol

        java.lang.String getThousandsSeparatorSymbol()
        Returns the value of the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.
        Returns:
        The value of the property 'thousands separator symbol'.
        Since:
        6.1
      • setThousandsSeparatorSymbolFormula

        void setThousandsSeparatorSymbolFormula​(FormulaField newFormula)
        Sets the formula for the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.
        Parameters:
        newFormula - The new formula for the property 'thousands separator symbol'.
        Since:
        6.1
      • getThousandsSeparatorSymbolFormula

        FormulaField getThousandsSeparatorSymbolFormula()
        Returns the formula for the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.
        Returns:
        FormulaField The formula for the property 'thousands separator symbol'.
        Since:
        6.1
      • setRounding

        void setRounding​(int digits)
        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.
        Parameters:
        digits - position of digit to round to: negative numbers for after the decimal point, positive for before
        Since:
        10.0
      • getRounding

        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.
        Returns:
        digits position of digit to round to: negative numbers for after the decimal point, positive for before
        Since:
        10.0
      • setRoundingFormula

        void setRoundingFormula​(FormulaField newFormula)
        Sets the formula which provides the digit to round the number to. In order to round after the decimal point, use positive numbers. Otherwise use negative numbers. Examples would be "6" for rounding to millionth, "-2" for rounding to hundreds, "0" for rounding to whole numbers.
        Parameters:
        newFormula - formula providing the digits position of digit to round to: positive numbers for after the decimal point, negative for before
        Since:
        10.0
      • getRoundingFormula

        FormulaField getRoundingFormula()
        Returns the formula which provides the digit to round the number to. In order to round after the decimal point, use positive numbers. Otherwise use negative numbers. Examples would be "6" for rounding to millionth, "-2" for rounding to hundreds, "0" for rounding to whole numbers.
        Returns:
        The formula providing the digits position of digit to round to: positive numbers for after the decimal point, negative for before
        Since:
        10.0
      • setNegativeType

        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.
        Parameters:
        newValue - The new value of the property 'negative type'.
        Since:
        6.1
        See Also:
        NOT_NEGATIVE, LEADING_MINUS, TRAILING_MINUS, BRACKETED
      • getNegativeType

        int getNegativeType()
        Returns the value of the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.
        Returns:
        The current value of the property 'negative type'.
        Since:
        6.1
        See Also:
        NOT_NEGATIVE, LEADING_MINUS, TRAILING_MINUS, BRACKETED
      • setNegativeTypeFormula

        void setNegativeTypeFormula​(FormulaField newFormula)
        Sets the formula for the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.
        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.1
        See Also:
        NOT_NEGATIVE, LEADING_MINUS, TRAILING_MINUS, BRACKETED
      • getNegativeTypeFormula

        FormulaField getNegativeTypeFormula()
        Returns the formula for the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.
        Returns:
        FormulaField The formula for the property 'negative type'.
        Since:
        6.1
      • setUseLeadingZero

        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).
        Parameters:
        newValue - The new value of the property 'use leading zero'.
        Since:
        6.1
      • getUseLeadingZero

        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).
        Returns:
        The value of the property 'use leading zero'.
        Since:
        6.1
      • setUseLeadingZeroFormula

        void setUseLeadingZeroFormula​(FormulaField newFormula)
        Sets the formula for the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).
        Parameters:
        newFormula - The new formula for the property 'use leading zero'.
        Since:
        6.1
      • getUseLeadingZeroFormula

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

        void setZeroValueString​(java.lang.String newValue)
        Sets the value of the property 'zero value string'. If the value is null then there will be no custom zero value.
        Parameters:
        newValue - The new value of the property 'zero value string'.
        Since:
        6.1
      • getZeroValueString

        java.lang.String getZeroValueString()
        Returns the value of the property 'zero value string'.
        Returns:
        The value of the property 'zero value string'.
        Since:
        6.1
      • setAllowFieldClipping

        void setAllowFieldClipping​(boolean newValue)
        Specify how the field value is shown when the width of the element is smaller than the width of the string representation of the field. In this case if "allow field clipping" is enabled the value is shown incompletely - else the element is filled with '#' signs.
        Parameters:
        newValue - whether or not to allow the field's value to be clipped if necessary.
        Since:
        6.1
      • isAllowFieldClipping

        boolean isAllowFieldClipping()
        Returns true if allow field clipping is enabled, else false is returned.
        Returns:
        whether field clipping is allowed for this field.
        Since:
        7.0
      • setAllowFieldClippingFormula

        void setAllowFieldClippingFormula​(FormulaField newField)
        Sets a formula or null to specify the value of the allowed field clipping property by a formula.
        Parameters:
        newField - the formula which is to determine whether or not to allow field clipping for the field.
        Since:
        6.1
      • getAllowFieldClippingFormula

        FormulaField getAllowFieldClippingFormula()
        Returns the formula which specifies the value of the allowed field clipping property or null if not set.
        Returns:
        formula which determines whether or not field clipping is allowed for this field.
        Since:
        6.1
      • getNumeralLanguage

        int getNumeralLanguage()
        Returns the language of numerals for numbers, date, time and datetime values.
        Returns:
        One of the language constant or -1 for the report and locale default.
        Since:
        6.1
        See Also:
        setNumeralLanguage(int)
      • getManualFormatFormula

        FormulaField getManualFormatFormula()
        Returns 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.
        Returns:
        FormulaField The formula of the property 'manual format'.
        Since:
        7.0
      • setManualFormatFormula

        void setManualFormatFormula​(FormulaField newFormula)
        Returns 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.
        Parameters:
        newFormula - The new formula for the property 'manual format'.
        Since:
        7.0
      • getCurrencySeparator

        java.lang.String getCurrencySeparator()
        Returns the separator between the number value and currency symbol. The default value for this property is an space character.
        Returns:
        The separator to be displayed between the number value and the currency value.
        Since:
        7.0
      • setCurrencySeparator

        void setCurrencySeparator​(java.lang.String newCurrencySeparator)
        Sets the separator to be displayed between the number value and the currency value.
        Parameters:
        newCurrencySeparator - The separator to be used between number value and currency symbol.
        Since:
        7.0
      • getCurrencySeparatorFormula

        FormulaField getCurrencySeparatorFormula()
        Returns the formula for the property 'currency separator'. If this formula is not null it will be used to get the separator between the number value and the currency symbol otherwise the value of getCurrencySeparator() will be used.
        Returns:
        The formula which will be used to get the separator between the number value and the currency symbol or null if only the value of getCurrencySeparator() should be used.
        Since:
        7.0
      • setCurrencySeparatorFormula

        void setCurrencySeparatorFormula​(FormulaField newFormula)
        Sets the formula which should be used to retrieve the value for the separator between number value and currency symbol. The formula passed has to return a value of type string.
        Parameters:
        newFormula - The formula which should be used for the property 'currency separator' or null if no formula should be used.
        Since:
        7.0