Package com.inet.report

Class AbstractValueElement

java.lang.Object
com.inet.report.ReportComponent
com.inet.report.Element
com.inet.report.AbstractFontElement
com.inet.report.AbstractValueElement
All Implemented Interfaces:
FontProperties, GeneralProperties, NodeParser, com.inet.report.ReferenceHolder, ValueProperties, Serializable, Cloneable
Direct Known Subclasses:
FieldElement, FieldPart
public abstract class AbstractValueElement extends AbstractFontElement implements ValueProperties
This class is an abstract implementation of the interface ValueProperties.
Since:
6.0
See Also:

  • Method Details

    • getAmString

      public final String getAmString()
      Returns the value of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.
      Specified by:
      getAmString in interface ValueProperties
      Returns:
      The value of the property 'am string'.
      Since:
      6.0

    • setAmString

      public final void setAmString(String newValue)
      Sets the value of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.
      Specified by:
      setAmString in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'am string'.
      Since:
      6.0

    • getAmStringFormula

      public final FormulaField getAmStringFormula()
      Returns the formula of the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.
      Specified by:
      getAmStringFormula in interface ValueProperties
      Returns:
      FormulaField if a formula for this property was defined else null.
      Since:
      6.0

    • setAmStringFormula

      public final void setAmStringFormula(FormulaField newFormula)
      Sets the formula for the property 'am string'. Use this property to specify the character(s) you want to use to identify the time between midnight and noon.
      Specified by:
      setAmStringFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'am string'.
      Since:
      6.0

    • getPmString

      public final String getPmString()
      Returns the value of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.
      Specified by:
      getPmString in interface ValueProperties
      Returns:
      The value of the property 'pm string'.
      Since:
      6.0

    • setPmString

      public final void setPmString(String newValue)
      Sets the value of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.
      Specified by:
      setPmString in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'pm string'.
      Since:
      6.0

    • getPmStringFormula

      public final FormulaField getPmStringFormula()
      Returns the formula of the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.
      Specified by:
      getPmStringFormula in interface ValueProperties
      Returns:
      FormulaField if a formula for this property was defined else null.
      Since:
      6.0

    • setPmStringFormula

      public final void setPmStringFormula(FormulaField newFormula)
      Sets the formula for the property 'pm string'. Use this property to specify the character(s) you want to use to identify the time between noon and midnight.
      Specified by:
      setPmStringFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'pm string'.
      Since:
      6.0

    • setTimeBase

      public final void setTimeBase(int newValue)
      Sets the value of the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.
      Specified by:
      setTimeBase in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'time base'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.TWELVE_HOURS
      • ValuePropertiesConstants.TWENTY_FOUR_HOURS

    • getTimeBase

      public final int getTimeBase()
      Returns the value of the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.
      Specified by:
      getTimeBase in interface ValueProperties
      Returns:
      The value of the property 'time base'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.TWELVE_HOURS
      • ValuePropertiesConstants.TWENTY_FOUR_HOURS

    • setTimeBaseFormula

      public final void setTimeBaseFormula(FormulaField newFormula)
      Sets the formula for the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.
      Specified by:
      setTimeBaseFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'time base'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.TWELVE_HOURS
      • ValuePropertiesConstants.TWENTY_FOUR_HOURS

    • getTimeBaseFormula

      public final FormulaField getTimeBaseFormula()
      Returns the formula for the property 'time base'. Use this property to specify the representation of the hours in a custom time format field. The hours in a time field can be printed at base 12 and at base 24.
      Specified by:
      getTimeBaseFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'time base'.
      Since:
      6.0

    • getAmPmOrder

      public final int getAmPmOrder()
      Returns the value of the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.
      Specified by:
      getAmPmOrder in interface ValueProperties
      Returns:
      The current value of property.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.AM_PM_BEFORE
      • ValuePropertiesConstants.AM_PM_AFTER

    • setAmPmOrder

      public final void setAmPmOrder(int newValue)
      Sets the value of the property 'am pm order/type'. Use this option to specify the position of the am/pm-String in a custom time format field. You can place the am/pm-String before or after the time value.
      Specified by:
      setAmPmOrder in interface ValueProperties
      Parameters:
      newValue - The new value for property.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.AM_PM_BEFORE
      • ValuePropertiesConstants.AM_PM_AFTER

    • getAmPmOrderFormula

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

    • setAmPmOrderFormula

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

    • setHourType

      public final void setHourType(int newValue)
      Sets the value of the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.
      Specified by:
      setHourType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'hour type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NO_HOUR
      • ValuePropertiesConstants.NUMERIC_HOUR
      • ValuePropertiesConstants.NUMERIC_HOUR_NO_LEADING_ZERO

    • getHourType

      public final int getHourType()
      Returns the value of the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.
      Specified by:
      getHourType in interface ValueProperties
      Returns:
      The current value of the property 'hour type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NO_HOUR
      • ValuePropertiesConstants.NUMERIC_HOUR
      • ValuePropertiesConstants.NUMERIC_HOUR_NO_LEADING_ZERO

    • setHourTypeFormula

      public final void setHourTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.
      Specified by:
      setHourTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'hour type'. The result of the formula should be in range from 0 to 2.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NO_HOUR
      • ValuePropertiesConstants.NUMERIC_HOUR
      • ValuePropertiesConstants.NUMERIC_HOUR_NO_LEADING_ZERO

    • getHourTypeFormula

      public final FormulaField getHourTypeFormula()
      Returns the formula for the property 'hour type'. Use this property to specify the representation of the hour part of the time value in a custom time format.
      Specified by:
      getHourTypeFormula in interface ValueProperties
      Returns:
      FormulaField The current formula for the property 'hour type'.
      Since:
      6.0

    • setMinuteType

      public final void setMinuteType(int newValue)
      Sets the value of the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.
      Specified by:
      setMinuteType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'minute type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NO_MINUTE
      • ValuePropertiesConstants.NUMERIC_MINUTE
      • ValuePropertiesConstants.NUMERIC_MINUTE_NO_LEADING_ZERO

    • getMinuteType

      public final int getMinuteType()
      Returns the value of the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.
      Specified by:
      getMinuteType in interface ValueProperties
      Returns:
      The current value of the property 'minute type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NO_MINUTE
      • ValuePropertiesConstants.NUMERIC_MINUTE
      • ValuePropertiesConstants.NUMERIC_MINUTE_NO_LEADING_ZERO

    • setMinuteTypeFormula

      public final void setMinuteTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.
      Specified by:
      setMinuteTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'minute type'. The result of the formula should be in range from 0 to 2.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NO_MINUTE
      • ValuePropertiesConstants.NUMERIC_MINUTE
      • ValuePropertiesConstants.NUMERIC_MINUTE_NO_LEADING_ZERO

    • getMinuteTypeFormula

      public final FormulaField getMinuteTypeFormula()
      Returns the formula for the property 'minute type'. Use this property to specify the representation of the minute part of the time value in a custom time format.
      Specified by:
      getMinuteTypeFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'minute type'.
      Since:
      6.0

    • setSecondType

      public final void setSecondType(int newValue)
      Sets the value of the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.
      Specified by:
      setSecondType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'second type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NUMERIC_NO_SECOND
      • ValuePropertiesConstants.NUMERIC_SECOND
      • ValuePropertiesConstants.NUMERIC_NO_LEADING_ZERO

    • getSecondType

      public final int getSecondType()
      Returns the value of the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.
      Specified by:
      getSecondType in interface ValueProperties
      Returns:
      The current value of the property 'second type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NUMERIC_NO_SECOND
      • ValuePropertiesConstants.NUMERIC_SECOND
      • ValuePropertiesConstants.NUMERIC_NO_LEADING_ZERO

    • setSecondTypeFormula

      public final void setSecondTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.
      Specified by:
      setSecondTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'second type'. The result of the formula should be in range from 0 to 2.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NUMERIC_NO_SECOND
      • ValuePropertiesConstants.NUMERIC_SECOND
      • ValuePropertiesConstants.NUMERIC_NO_LEADING_ZERO

    • getSecondTypeFormula

      public final FormulaField getSecondTypeFormula()
      Returns the formula for the property 'second type'. Use this property to specify the representation of the second part of the time value in a custom time format.
      Specified by:
      getSecondTypeFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'second type'.
      Since:
      6.0

    • getHourMinuteSeparator

      public final String getHourMinuteSeparator()
      Returns the value of the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.
      Specified by:
      getHourMinuteSeparator in interface ValueProperties
      Returns:
      The current value of the property 'hour minute sepereator'.
      Since:
      6.1

    • setHourMinuteSeparator

      public final void setHourMinuteSeparator(String newValue)
      Sets the value of the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.
      Specified by:
      setHourMinuteSeparator in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'hour minute sepereator'.
      Since:
      6.1

    • setHourMinuteSeparatorFormula

      public final void setHourMinuteSeparatorFormula(FormulaField newFormula)
      Sets the formula for the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.
      Specified by:
      setHourMinuteSeparatorFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'hour minute sepereator'.
      Since:
      6.1

    • getHourMinuteSeparatorFormula

      public final FormulaField getHourMinuteSeparatorFormula()
      Returns the formula for the property 'hour minute sepereator'. Use this property to specify the character(s) which should be used to separate the hours and minutes in a custom time format field.
      Specified by:
      getHourMinuteSeparatorFormula in interface ValueProperties
      Returns:
      FormulaField The current formula for the property 'hour minute sepereator'.
      Since:
      6.1

    • setMinuteSecondSeparator

      public final void setMinuteSecondSeparator(String newValue)
      Sets the value of the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.
      Specified by:
      setMinuteSecondSeparator in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'minute second separator'.
      Since:
      6.1

    • getMinuteSecondSeparator

      public final String getMinuteSecondSeparator()
      Returns the value of the property 'minute second separator'. Use this property to specify the character(s) which should be used to separate the minutes and second in a custom time format field.
      Specified by:
      getMinuteSecondSeparator in interface ValueProperties
      Returns:
      The current value of the property 'minute second separator'.
      Since:
      6.1

    • setMinuteSecondSeparatorFormula

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

    • getMinuteSecondSeparatorFormula

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

    • getDateFormatType

      public final int getDateFormatType()
      Returns the date format type set for this element. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not have any effect.
      Specified by:
      getDateFormatType in interface ValueProperties
      Returns:
      The date format type set for this element.
      See Also:

    • setDateFormatType

      public final void setDateFormatType(int newValue)
      Sets the date format type to use for this element. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not take effect.
      Specified by:
      setDateFormatType in interface ValueProperties
      Parameters:
      newValue - The date format type set for this element
      See Also:

    • getDateFormatTypeFormula

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

    • setDateFormatTypeFormula

      public final void setDateFormatTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'date format type'. Use this property to specify whether you want to use the short default date format (e.g. "11/07/2007") or the long (e.g. "Wednesday, November 7, 2007") or if you want to create your own format. When this property is set to short or long default date format all other properties for date format will not take effect.
      Specified by:
      setDateFormatTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'date format type'. The result of the formula should be 0 (long), 1 (short), 2 (custom), or 3 (medium).
      See Also:

    • getDateWindowsDefaultTypeFormula

      @Deprecated public final FormulaField getDateWindowsDefaultTypeFormula()
      Deprecated.
      As of i-net Crystal-Clear 8.0, use getDateFormatTypeFormula() instead.
      FOR INTERNAL USE ONLY

    • setDateWindowsDefaultTypeFormula

      @Deprecated public final void setDateWindowsDefaultTypeFormula(FormulaField newFormula)
      Deprecated.
      As of i-net Crystal-Clear 8.0, use setDateFormatTypeFormula(FormulaField) instead.
      FOR INTERNAL USE ONLY

    • getTimeFormatType

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

    • setTimeFormatType

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

    • getTimeFormatTypeFormula

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

    • setTimeFormatTypeFormula

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

    • getNumberFormatType

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

    • setNumberFormatType

      public void setNumberFormatType(int newValue)
      Sets the number format type to use for this element. Use this property to specify whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.
      Specified by:
      setNumberFormatType in interface ValueProperties
      Parameters:
      newValue - The number format type to set for this element
      See Also:

    • getNumberFormatTypeFormula

      public FormulaField getNumberFormatTypeFormula()
      Returns the formula which returns the number format type to use for this element. This type specifies whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.
      Specified by:
      getNumberFormatTypeFormula in interface ValueProperties
      Returns:
      The formula field which returns the number format type to use for this element.
      See Also:

    • setNumberFormatTypeFormula

      public void setNumberFormatTypeFormula(FormulaField newFormula)
      Sets the formula which returns the number format type to use for this element. This type specifies whether you want to use one of the default number formats (which are determined through the current locale) or if you want to create your own custom format. If this property is set to a default format type, all other properties for number format will not have any effect.
      Specified by:
      setNumberFormatTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The formula field which returns the number format type to use for this element
      See Also:

    • getDateCalendarType

      public final int getDateCalendarType()
      Returns the value of the property 'date calendar type'. Use this property to choose a calendar.
      Specified by:
      getDateCalendarType in interface ValueProperties
      Returns:
      The value of the property 'date calendar type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.GREGORIAN_CALENDAR
      • ValuePropertiesConstants.GREGORIAN_US_CALENDAR
      • ValuePropertiesConstants.JAPANESE_CALENDAR
      • ValuePropertiesConstants.TAIWANESE_CALENDAR
      • ValuePropertiesConstants.KOREAN_CALENDAR
      • ValuePropertiesConstants.HIJRI_CALENDAR
      • ValuePropertiesConstants.THAI_CALENDAR

    • setDateCalendarType

      public final void setDateCalendarType(int newValue)
      Sets the value of the property 'date calendar type'. Use this property to choose a calendar.
      Specified by:
      setDateCalendarType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'date calendar type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.GREGORIAN_CALENDAR
      • ValuePropertiesConstants.GREGORIAN_US_CALENDAR
      • ValuePropertiesConstants.JAPANESE_CALENDAR
      • ValuePropertiesConstants.TAIWANESE_CALENDAR
      • ValuePropertiesConstants.KOREAN_CALENDAR
      • ValuePropertiesConstants.HIJRI_CALENDAR
      • ValuePropertiesConstants.THAI_CALENDAR

    • getDateCalendarTypeFormula

      public final FormulaField getDateCalendarTypeFormula()
      Returns the formula of the property 'date calendar type'. Use this property to choose a calendar.
      Specified by:
      getDateCalendarTypeFormula in interface ValueProperties
      Returns:
      FormulaField The formula of the property 'date calendar type'.
      Since:
      6.0

    • setDateCalendarTypeFormula

      public final void setDateCalendarTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'date calendar type'. Use this property to choose a calendar.
      Specified by:
      setDateCalendarTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula of the property 'date calendar type'. The result of the formula should be in range from 1 to 7.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.GREGORIAN_CALENDAR
      • ValuePropertiesConstants.GREGORIAN_US_CALENDAR
      • ValuePropertiesConstants.JAPANESE_CALENDAR
      • ValuePropertiesConstants.TAIWANESE_CALENDAR
      • ValuePropertiesConstants.KOREAN_CALENDAR
      • ValuePropertiesConstants.HIJRI_CALENDAR
      • ValuePropertiesConstants.THAI_CALENDAR

    • getDateEraType

      public final int getDateEraType()
      Returns the value of the property 'date era type'.
      Specified by:
      getDateEraType in interface ValueProperties
      Returns:
      The value of the property 'date era type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.SHORT_ERA
      • ValuePropertiesConstants.LONG_ERA
      • ValuePropertiesConstants.NO_ERA

    • setDateEraType

      public final void setDateEraType(int newValue)
      Sets the value of the property 'date era type'.
      Specified by:
      setDateEraType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'date era type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.SHORT_ERA
      • ValuePropertiesConstants.LONG_ERA
      • ValuePropertiesConstants.NO_ERA

    • getDateEraTypeFormula

      public final FormulaField getDateEraTypeFormula()
      Returns the formula of the property 'date era type'.
      Specified by:
      getDateEraTypeFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'date era type'.
      Since:
      6.0

    • setDateEraTypeFormula

      public final void setDateEraTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'date era type'.
      Specified by:
      setDateEraTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'date era type'. The result of the formula should be in range from 0 to 2.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.SHORT_ERA
      • ValuePropertiesConstants.LONG_ERA
      • ValuePropertiesConstants.NO_ERA

    • getDayType

      public final int getDayType()
      Returns the value of the property 'day type'. Use this property to specify the day representation of a custom date format.
      Specified by:
      getDayType in interface ValueProperties
      Returns:
      The value of the property 'day type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NUMERIC_DAY
      • ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY
      • ValuePropertiesConstants.NO_DAY

    • setDayType

      public final void setDayType(int newValue)
      Sets the value of the property 'day type'. Use this property to specify the day representation of a custom date format.
      Specified by:
      setDayType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'day type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NUMERIC_DAY
      • ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY
      • ValuePropertiesConstants.NO_DAY

    • getDayTypeFormula

      public final FormulaField getDayTypeFormula()
      Returns the formula for the property 'day type'. Use this property to specify the day representation of a custom date format.
      Specified by:
      getDayTypeFormula in interface ValueProperties
      Returns:
      FormulaField The formula of the property 'day type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NUMERIC_DAY
      • ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY
      • ValuePropertiesConstants.NO_DAY

    • setDayTypeFormula

      public final void setDayTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'day type'. Use this property to specify the day representation of a custom date format.
      Specified by:
      setDayTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'day type'. The result of the formula should be in range from 0 to 2.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NUMERIC_DAY
      • ValuePropertiesConstants.LEADING_ZERO_NUMERIC_DAY
      • ValuePropertiesConstants.NO_DAY

    • setMonthType

      public final void setMonthType(int newValue)
      Sets the value of the property 'month type'. Use this property to set the representation of the month part in a custom format date.
      Specified by:
      setMonthType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'month type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.LEADING_ZERO_NUMERIC_MONTH
      • ValuePropertiesConstants.LONG_MONTH
      • ValuePropertiesConstants.NO_MONTH
      • ValuePropertiesConstants.NUMERIC_MONTH
      • ValuePropertiesConstants.SHORT_MONTH

    • getMonthType

      public final int getMonthType()
      Returns the value of the property 'month type'. Use this property to set the representation of the month part in a custom format date.
      Specified by:
      getMonthType in interface ValueProperties
      Returns:
      The current value of the property 'month type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.LEADING_ZERO_NUMERIC_MONTH
      • ValuePropertiesConstants.LONG_MONTH
      • ValuePropertiesConstants.NO_MONTH
      • ValuePropertiesConstants.NUMERIC_MONTH
      • ValuePropertiesConstants.SHORT_MONTH

    • setMonthTypeFormula

      public final void setMonthTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'month type'. Use this property to set the representation of the month part in a custom format date.
      Specified by:
      setMonthTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'month type'. The result of the formula should be in range from 0 to 2.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.LEADING_ZERO_NUMERIC_MONTH
      • ValuePropertiesConstants.LONG_MONTH
      • ValuePropertiesConstants.NO_MONTH
      • ValuePropertiesConstants.NUMERIC_MONTH
      • ValuePropertiesConstants.SHORT_MONTH

    • getMonthTypeFormula

      public final FormulaField getMonthTypeFormula()
      Returns the formula for the property 'month type'. Use this property to set the representation of the month part in a custom format date.
      Specified by:
      getMonthTypeFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'month type'.
      Since:
      6.0

    • setYearType

      public final void setYearType(int newValue)
      Sets the value of the property 'year type'. Use this property to specify the year representation of a custom date format.
      Specified by:
      setYearType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'year type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.SHORT_YEAR
      • ValuePropertiesConstants.LONG_YEAR
      • ValuePropertiesConstants.NO_YEAR

    • getYearType

      public final int getYearType()
      Returns the value of the property 'year type'. Use this property to specify the year representation of a custom date format.
      Specified by:
      getYearType in interface ValueProperties
      Returns:
      The value of the property 'year type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.SHORT_YEAR
      • ValuePropertiesConstants.LONG_YEAR
      • ValuePropertiesConstants.NO_YEAR

    • setYearTypeFormula

      public final void setYearTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'year type'. Use this property to specify the year representation of a custom date format.
      Specified by:
      setYearTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'year type'. The result of the formula should be in range from 0 to 2.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.SHORT_YEAR
      • ValuePropertiesConstants.LONG_YEAR
      • ValuePropertiesConstants.NO_YEAR

    • getYearTypeFormula

      public final FormulaField getYearTypeFormula()
      Returns the formula for the property 'year type'. Use this property to specify the year representation of a custom date format.
      Specified by:
      getYearTypeFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'year type'.
      Since:
      6.0

    • getDayOfWeekPosition

      public final int getDayOfWeekPosition()
      Returns the value of the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.
      Specified by:
      getDayOfWeekPosition in interface ValueProperties
      Returns:
      The value of the property 'day of week position'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.LEADING_DAY_OF_WEEK
      • ValuePropertiesConstants.TRAILING_DAY_OF_WEEK

    • setDayOfWeekPosition

      public final void setDayOfWeekPosition(int newValue)
      Sets the value of the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.
      Specified by:
      setDayOfWeekPosition in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'day of week position'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.LEADING_DAY_OF_WEEK
      • ValuePropertiesConstants.TRAILING_DAY_OF_WEEK

    • getDayOfWeekPositionFormula

      public final FormulaField getDayOfWeekPositionFormula()
      Returns the formula for the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.
      Specified by:
      getDayOfWeekPositionFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'day of week position'.
      Since:
      6.0

    • setDayOfWeekPositionFormula

      public final void setDayOfWeekPositionFormula(FormulaField newFormula)
      Sets the formula for the property 'day of week position'. Use this property to specify the day of week position. It can be either leading or trailing position.
      Specified by:
      setDayOfWeekPositionFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'day of week position'. The result of the formula should be in range from 0 to 1.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.LEADING_DAY_OF_WEEK
      • ValuePropertiesConstants.TRAILING_DAY_OF_WEEK

    • getDayOfWeekEnclosure

      public final int getDayOfWeekEnclosure()
      Returns the value of the property 'day of week enclosure'.
      Specified by:
      getDayOfWeekEnclosure in interface ValueProperties
      Returns:
      The current value of the property 'day of week enclosure'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_NONE
      • ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_PARENTHESIS
      • ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_ANGLE
      • ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_SQUARED

    • setDayOfWeekEnclosure

      public final void setDayOfWeekEnclosure(int newValue)
      Sets the value of the property 'day of week enclosure'. Use this property to specify the enclosure of the week day name.
      Specified by:
      setDayOfWeekEnclosure in interface ValueProperties
      Parameters:
      newValue - The value of the property 'day of week enclosure'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_NONE
      • ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_PARENTHESIS
      • ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_ANGLE
      • ValuePropertiesConstants.DAY_OF_WEEK_ENCLOSURE_SQUARED

    • getDayOfWeekEnclosureFormula

      public final FormulaField getDayOfWeekEnclosureFormula()
      Returns the formula for the property 'day of week enclosure'.
      Specified by:
      getDayOfWeekEnclosureFormula in interface ValueProperties
      Returns:
      The formula for the property 'day of week enclosure'.
      Since:
      6.0

    • setDayOfWeekEnclosureFormula

      public final void setDayOfWeekEnclosureFormula(FormulaField newFormula)
      Sets the formula for the property 'day of week enclosure'. Use this property to specify the enclosure of the week day name.
      Specified by:
      setDayOfWeekEnclosureFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'week day enclosure'.
      Since:
      6.0

    • setDayOfWeekSeparator

      public final void setDayOfWeekSeparator(String newValue)
      Sets the value of the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.
      Specified by:
      setDayOfWeekSeparator in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'day of week separator'.
      Since:
      6.1

    • getDayOfWeekSeparator

      public final String getDayOfWeekSeparator()
      Returns the value of the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.
      Specified by:
      getDayOfWeekSeparator in interface ValueProperties
      Returns:
      The current value of the property 'day of week separator'.
      Since:
      6.1

    • setDayOfWeekSeparatorFormula

      public final void setDayOfWeekSeparatorFormula(FormulaField newFormula)
      Sets the formula for the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.
      Specified by:
      setDayOfWeekSeparatorFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'day of week separator'.
      Since:
      6.1

    • getDayOfWeekSeparatorFormula

      public final FormulaField getDayOfWeekSeparatorFormula()
      Returns the formula for the property 'day of week separator'. Use this property to specify the character(s) how the day of week name should be separated from the date itself.
      Specified by:
      getDayOfWeekSeparatorFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'day of week separator'.
      Since:
      6.1

    • getDayOfWeekType

      public final int getDayOfWeekType()
      Returns the value of the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.
      Specified by:
      getDayOfWeekType in interface ValueProperties
      Returns:
      The value of the property 'day of week type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.SHORT_DAY_OF_WEEK
      • ValuePropertiesConstants.LONG_DAY_OF_WEEK
      • ValuePropertiesConstants.NO_DAY_OF_WEEK

    • setDayOfWeekType

      public final void setDayOfWeekType(int newValue)
      Sets the value of the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.
      Specified by:
      setDayOfWeekType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'day of week type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.SHORT_DAY_OF_WEEK
      • ValuePropertiesConstants.LONG_DAY_OF_WEEK
      • ValuePropertiesConstants.NO_DAY_OF_WEEK

    • getDayOfWeekTypeFormula

      public final FormulaField getDayOfWeekTypeFormula()
      Returns the formula for the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.
      Specified by:
      getDayOfWeekTypeFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'day of week type'.
      Since:
      6.0

    • setDayOfWeekTypeFormula

      public final void setDayOfWeekTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'day of week type'. Use this property to specify the representation of the day of week in a custom date format.
      Specified by:
      setDayOfWeekTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'day of week type'. The result of the formula should be in range from 0 to 2.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.SHORT_DAY_OF_WEEK
      • ValuePropertiesConstants.LONG_DAY_OF_WEEK
      • ValuePropertiesConstants.NO_DAY_OF_WEEK

    • getDateOrder

      public final int getDateOrder()
      Returns the value of the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.
      Specified by:
      getDateOrder in interface ValueProperties
      Returns:
      The value of the property 'date order'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.YEAR_MONTH_DAY
      • ValuePropertiesConstants.DAY_MONTH_YEAR
      • ValuePropertiesConstants.MONTH_DAY_YEAR

    • setDateOrder

      public final void setDateOrder(int newValue)
      Sets the value of the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.
      Specified by:
      setDateOrder in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'date order'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.YEAR_MONTH_DAY
      • ValuePropertiesConstants.DAY_MONTH_YEAR
      • ValuePropertiesConstants.MONTH_DAY_YEAR

    • getDateOrderFormula

      public final FormulaField getDateOrderFormula()
      Returns the formula for the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.
      Specified by:
      getDateOrderFormula in interface ValueProperties
      Returns:
      FormulaField The formula of the property 'date order'.
      Since:
      6.0

    • setDateOrderFormula

      public final void setDateOrderFormula(FormulaField newFormula)
      Sets the formula for the property 'date order'. Use this property to specify the order of year, month and day representation for a custom date format.
      Specified by:
      setDateOrderFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'date order'. The result of the formula should be in range from 0 to 2.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.YEAR_MONTH_DAY
      • ValuePropertiesConstants.DAY_MONTH_YEAR
      • ValuePropertiesConstants.MONTH_DAY_YEAR

    • getDatePrefixSeparator

      public final String getDatePrefixSeparator()
      Returns the value of the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.
      Specified by:
      getDatePrefixSeparator in interface ValueProperties
      Returns:
      The value of the property 'date prefix separator'.
      Since:
      6.1

    • setDatePrefixSeparator

      public final void setDatePrefixSeparator(String newValue)
      Sets the value of the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.
      Specified by:
      setDatePrefixSeparator in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'date prefix separator'.
      Since:
      6.1

    • getDatePrefixSeparatorFormula

      public final FormulaField getDatePrefixSeparatorFormula()
      Returns the formula for the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.
      Specified by:
      getDatePrefixSeparatorFormula in interface ValueProperties
      Returns:
      FormulaField The formula of the property 'date prefix separator'.
      Since:
      6.1

    • setDatePrefixSeparatorFormula

      public final void setDatePrefixSeparatorFormula(FormulaField newFormula)
      Sets the formula for the property 'date prefix separator'. Use this property to create a date prefix for date in a custom date format.
      Specified by:
      setDatePrefixSeparatorFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'date prefix separator'.
      Since:
      6.1

    • getDateFirstSeparator

      public final String getDateFirstSeparator()
      Returns the value of the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.
      Specified by:
      getDateFirstSeparator in interface ValueProperties
      Returns:
      The value of the property 'date firts separator'.
      Since:
      6.1

    • setDateFirstSeparator

      public final void setDateFirstSeparator(String newValue)
      Sets the value of the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.
      Specified by:
      setDateFirstSeparator in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'date first separator'.
      Since:
      6.1

    • getDateFirstSeparatorFormula

      public final FormulaField getDateFirstSeparatorFormula()
      Returns the formula for the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.
      Specified by:
      getDateFirstSeparatorFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'date first separator'.
      Since:
      6.1

    • setDateFirstSeparatorFormula

      public final void setDateFirstSeparatorFormula(FormulaField newFormula)
      Sets the formula for the property 'date first separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the first and the second part.
      Specified by:
      setDateFirstSeparatorFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'date first separator'.
      Since:
      6.1

    • getDateSecondSeparator

      public final String getDateSecondSeparator()
      Returns the value of the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.
      Specified by:
      getDateSecondSeparator in interface ValueProperties
      Returns:
      The value of the property 'date second separator'.
      Since:
      6.1

    • setDateSecondSeparator

      public final void setDateSecondSeparator(String newValue)
      Sets the value of the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.
      Specified by:
      setDateSecondSeparator in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'date second separator'.
      Since:
      6.1

    • getDateSecondSeparatorFormula

      public final FormulaField getDateSecondSeparatorFormula()
      Returns the formula for the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.
      Specified by:
      getDateSecondSeparatorFormula in interface ValueProperties
      Returns:
      FormulaField The formula of the property 'date second separator'.
      Since:
      6.1

    • setDateSecondSeparatorFormula

      public final void setDateSecondSeparatorFormula(FormulaField newFormula)
      Sets the formula for the property 'date second separator'. Each date can be separated into three parts. Use this property to specify the character(s) which separate the second and the third part.
      Specified by:
      setDateSecondSeparatorFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'date second separator'.
      Since:
      6.1

    • getDateSuffixSeparator

      public final String getDateSuffixSeparator()
      Returns the value of the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.
      Specified by:
      getDateSuffixSeparator in interface ValueProperties
      Returns:
      The value of the property 'date suffix separator'.
      Since:
      6.1

    • setDateSuffixSeparator

      public final void setDateSuffixSeparator(String newValue)
      Sets the value of the property 'date suffix separator'. Use this property to specify the character(s) in a custom date format that should follows the dates in your date field.
      Specified by:
      setDateSuffixSeparator in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'date suffix separator'.
      Since:
      6.1

    • getDateSuffixSeparatorFormula

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

    • setDateSuffixSeparatorFormula

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

    • setDateTimeOrder

      public final void setDateTimeOrder(int newValue)
      Sets the value of the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.
      Specified by:
      setDateTimeOrder in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'date time order'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.DATE_TIME_ORDER
      • ValuePropertiesConstants.TIME_DATE_ORDER
      • ValuePropertiesConstants.DATE_ONLY_ORDER
      • ValuePropertiesConstants.TIME_ONLY_ORDER
      • ValuePropertiesConstants.DATE_TIME_SYSTEM_ORDER

    • getDateTimeOrder

      public final int getDateTimeOrder()
      Returns the value of the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.
      Specified by:
      getDateTimeOrder in interface ValueProperties
      Returns:
      The value of the property 'date time order'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.DATE_TIME_ORDER
      • ValuePropertiesConstants.TIME_DATE_ORDER
      • ValuePropertiesConstants.DATE_ONLY_ORDER
      • ValuePropertiesConstants.TIME_ONLY_ORDER
      • ValuePropertiesConstants.DATE_TIME_SYSTEM_ORDER

    • setDateTimeOrderFormula

      public final void setDateTimeOrderFormula(FormulaField newFormula)
      Sets the formula for the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.
      Specified by:
      setDateTimeOrderFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'date time order'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.DATE_TIME_ORDER
      • ValuePropertiesConstants.TIME_DATE_ORDER
      • ValuePropertiesConstants.DATE_ONLY_ORDER
      • ValuePropertiesConstants.TIME_ONLY_ORDER
      • ValuePropertiesConstants.DATE_TIME_SYSTEM_ORDER

    • getDateTimeOrderFormula

      public final FormulaField getDateTimeOrderFormula()
      Returns the formula for the property 'date time order'. Use this property to specify the order of date and time in a custom date/time format date/time field.
      Specified by:
      getDateTimeOrderFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'date time order'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.DATE_TIME_ORDER
      • ValuePropertiesConstants.TIME_DATE_ORDER
      • ValuePropertiesConstants.DATE_ONLY_ORDER
      • ValuePropertiesConstants.TIME_ONLY_ORDER
      • ValuePropertiesConstants.DATE_TIME_SYSTEM_ORDER

    • setDateTimeSeparator

      public final void setDateTimeSeparator(String newValue)
      Sets the value of the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.
      Specified by:
      setDateTimeSeparator in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'date time separator'.
      Since:
      6.1

    • getDateTimeSeparator

      public final String getDateTimeSeparator()
      Returns the value of the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.
      Specified by:
      getDateTimeSeparator in interface ValueProperties
      Returns:
      The value of the property 'date time separator'.
      Since:
      6.1

    • setDateTimeSeparatorFormula

      public final void setDateTimeSeparatorFormula(FormulaField newFormula)
      Sets the formula for the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.
      Specified by:
      setDateTimeSeparatorFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'date time separator'.
      Since:
      6.1

    • getDateTimeSeparatorFormula

      public final FormulaField getDateTimeSeparatorFormula()
      Returns the formula for the property 'date time separator'. Use this property to specify the character(s) for seperation of date value and time value for a custom date/time format.
      Specified by:
      getDateTimeSeparatorFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'date time separator'.
      Since:
      6.1

    • getBooleanFormatOutputType

      public final int getBooleanFormatOutputType()
      Returns the value of the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or fasle.
      Specified by:
      getBooleanFormatOutputType in interface ValueProperties
      Returns:
      The value of the property 'boolean format output type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.TRUE_OR_FALSE
      • ValuePropertiesConstants.T_OR_F
      • ValuePropertiesConstants.YES_OR_NO
      • ValuePropertiesConstants.Y_OR_N
      • ValuePropertiesConstants.ONE_OR_ZERO

    • setBooleanFormatOutputType

      public final void setBooleanFormatOutputType(int newValue)
      Sets the value of the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or fasle.
      Specified by:
      setBooleanFormatOutputType in interface ValueProperties
      Parameters:
      newValue - The new value for the property 'boolean format output type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.TRUE_OR_FALSE
      • ValuePropertiesConstants.T_OR_F
      • ValuePropertiesConstants.YES_OR_NO
      • ValuePropertiesConstants.Y_OR_N
      • ValuePropertiesConstants.ONE_OR_ZERO

    • setBooleanFormatOutputTypeFormula

      public final void setBooleanFormatOutputTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or fasle.
      Specified by:
      setBooleanFormatOutputTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'boolean format output type'. The result of the formula should be in range from 0 to 4.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.TRUE_OR_FALSE
      • ValuePropertiesConstants.T_OR_F
      • ValuePropertiesConstants.YES_OR_NO
      • ValuePropertiesConstants.Y_OR_N
      • ValuePropertiesConstants.ONE_OR_ZERO

    • getBooleanFormatOutputTypeFormula

      public final FormulaField getBooleanFormatOutputTypeFormula()
      Returns the formula for the property 'boolean format output type'. With this property you can choose the output type of your boolean fields, i.e. "0 or 1" or "T or F" instead of true or false.
      Specified by:
      getBooleanFormatOutputTypeFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'boolean format output type'.

    • getCurrencyPosition

      public int getCurrencyPosition()
      Returns the value of the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency inside negative.
      Specified by:
      getCurrencyPosition in interface ValueProperties
      Returns:
      The value of the property 'currency position type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.LEADING_CURRENCY_INSIDE_NEGATIVE
      • ValuePropertiesConstants.LEADING_CURRENCY_OUTSIDE_NEGATIVE
      • ValuePropertiesConstants.TRAILING_CURRENCY_INSIDE_NEGATIVE
      • ValuePropertiesConstants.TRAILING_CURRENCY_OUTSIDE_NEGATIVE

    • setCurrencyPosition

      public final void setCurrencyPosition(int newValue)
      Sets the value of the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency outside negative.
      Specified by:
      setCurrencyPosition in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'currency position type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.LEADING_CURRENCY_INSIDE_NEGATIVE
      • ValuePropertiesConstants.LEADING_CURRENCY_OUTSIDE_NEGATIVE
      • ValuePropertiesConstants.TRAILING_CURRENCY_INSIDE_NEGATIVE
      • ValuePropertiesConstants.TRAILING_CURRENCY_OUTSIDE_NEGATIVE

    • getCurrencyPositionFormula

      public final FormulaField getCurrencyPositionFormula()
      Returns the formula for the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency inside negative.
      Specified by:
      getCurrencyPositionFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'currency position type'.
      Since:
      6.0

    • setCurrencyPositionFormula

      public final void setCurrencyPositionFormula(FormulaField newFormula)
      Sets the formula for the property 'currency position type'. With this property you can specify the postion of the currency symbol. Available options are leading currency inside negative, leading currency outside negative, trailing currency inside negative and trailing currency inside negative.
      Specified by:
      setCurrencyPositionFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'currency position type', where the result of the formula should be in range 0 to 3.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.LEADING_CURRENCY_INSIDE_NEGATIVE
      • ValuePropertiesConstants.LEADING_CURRENCY_OUTSIDE_NEGATIVE
      • ValuePropertiesConstants.TRAILING_CURRENCY_INSIDE_NEGATIVE
      • ValuePropertiesConstants.TRAILING_CURRENCY_OUTSIDE_NEGATIVE

    • setCurrencySymbol

      public void setCurrencySymbol(String newValue)
      Sets the value of the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.
      Specified by:
      setCurrencySymbol in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'currency symbol'.
      Since:
      6.0

    • getCurrencySymbol

      public String getCurrencySymbol()
      Returns the value of the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.
      Specified by:
      getCurrencySymbol in interface ValueProperties
      Returns:
      The value of the property 'currency symbol'.
      Since:
      6.0

    • setCurrencySymbolFormula

      public final void setCurrencySymbolFormula(FormulaField newFormula)
      Sets the formula for the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.
      Specified by:
      setCurrencySymbolFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'currency symbol'.
      Since:
      6.0

    • getCurrencySymbolFormula

      public final FormulaField getCurrencySymbolFormula()
      Returns the formula for the property 'currency symbol'. Use this property to set the character(s) that should used for the currency symbol. This takes effects only when you have set the property 'currency symbopl type' not to NO_SYMBOL and the property 'use system default format' is disabled.
      Specified by:
      getCurrencySymbolFormula in interface ValueProperties
      Returns:
      Formula field for the property "currency symbol"
      Since:
      6.0

    • setCurrencySymbolType

      public void setCurrencySymbolType(int newValue)
      Sets the value of the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.
      Specified by:
      setCurrencySymbolType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'currency symbol type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NO_SYMBOL
      • ValuePropertiesConstants.FIXED_SYMBOL
      • ValuePropertiesConstants.FLOATING_SYMBOL

    • getCurrencySymbolType

      public int getCurrencySymbolType()
      Returns the value of the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.
      Specified by:
      getCurrencySymbolType in interface ValueProperties
      Returns:
      The value of the property 'currency symbol type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NO_SYMBOL
      • ValuePropertiesConstants.FIXED_SYMBOL
      • ValuePropertiesConstants.FLOATING_SYMBOL

    • setCurrencySymbolTypeFormula

      public final void setCurrencySymbolTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.
      Specified by:
      setCurrencySymbolTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'currency symbol type'. The result of the formula should be in range from 0 to 2.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NO_SYMBOL
      • ValuePropertiesConstants.FIXED_SYMBOL
      • ValuePropertiesConstants.FLOATING_SYMBOL

    • getCurrencySymbolTypeFormula

      public FormulaField getCurrencySymbolTypeFormula()
      Returns the formula for the property 'currency symbol type'. This property enables you to add a currency symbol to your number or currency fields. The symbol is set with property 'currency symbol'. For currency fields the use of a currency sign is the default, for number fields you have to unset the property 'use system default format'.
      Specified by:
      getCurrencySymbolTypeFormula in interface ValueProperties
      Returns:
      Formula Field for the property "currency symbol type"
      Since:
      6.0

    • setUseOneCurrencySymbolPerPage

      public final void setUseOneCurrencySymbolPerPage(boolean newValue)
      Sets the value of the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.
      Specified by:
      setUseOneCurrencySymbolPerPage in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'use one currency symbol per page'.
      Since:
      6.0

    • getUseOneCurrencySymbolPerPage

      public final boolean getUseOneCurrencySymbolPerPage()
      Returns the value of the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.
      Specified by:
      getUseOneCurrencySymbolPerPage in interface ValueProperties
      Returns:
      The value of the property 'use one currency symbol per page'.
      Since:
      6.0

    • setUseOneCurrencySymbolPerPageFormula

      public final void setUseOneCurrencySymbolPerPageFormula(FormulaField newFormula)
      Sets the formula for the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.
      Specified by:
      setUseOneCurrencySymbolPerPageFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'use one currency symbol per page'.
      Since:
      6.0

    • getUseOneCurrencySymbolPerPageFormula

      public final FormulaField getUseOneCurrencySymbolPerPageFormula()
      Returns the formula for the property 'use one currency symbol per page'. When this property is enabled only the first printed value of the field on page has a currency symbol. The next values of the field does not have a currency symbol on the current page. This property will not take effect when property 'use system default' is set.
      Specified by:
      getUseOneCurrencySymbolPerPageFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'use one currency symbol per page'.
      Since:
      6.0

    • getNDecimalPlaces

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

      This does not affect the rounding of the value. In most cases, it is advisable to set the rounding to the negated value.

      Specified by:
      getNDecimalPlaces in interface ValueProperties
      Returns:
      The value of the property 'n decimal places'.
      See Also:

    • setNDecimalPlaces

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

      This does not affect the rounding of the value. In most cases, it is advisable to set the rounding to the negated value.

      Specified by:
      setNDecimalPlaces in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'n decimal places'.
      See Also:

    • getNDecimalPlacesFormula

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

    • setNDecimalPlacesFormula

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

    • getDecimalSeparatorSymbol

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

    • setDecimalSeparatorSymbol

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

    • getDecimalSeparatorSymbolFormula

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

    • setDecimalSeparatorSymbolFormula

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

    • setReverseSignForDisplay

      public final void setReverseSignForDisplay(boolean newValue)
      Sets the property 'use reverse sign for display'.
      Specified by:
      setReverseSignForDisplay in interface ValueProperties
      Parameters:
      newValue - New value for the property 'use reverse sign for display'.

    • isReverseSignForDisplay

      public final boolean isReverseSignForDisplay()
      Checks the property 'use reverse sign for display'
      Specified by:
      isReverseSignForDisplay in interface ValueProperties
      Returns:
      Whether the property 'use reverse sign for display' is on or off.
      Since:
      7.0

    • getReverseSignForDisplayFormula

      public final FormulaField getReverseSignForDisplayFormula()
      Returns the formula for the property 'use reverse sign for display'.
      Specified by:
      getReverseSignForDisplayFormula in interface ValueProperties
      Returns:
      FormulaField The formula of the property 'use reverse sign for display'.

    • setReverseSignForDisplayFormula

      public final void setReverseSignForDisplayFormula(FormulaField newFormula)
      Sets the formula for the property 'use reverse sign for display'.
      Specified by:
      setReverseSignForDisplayFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'use reverse sign for display'.

    • setSuppressIfZero

      public final void setSuppressIfZero(boolean newValue)
      Sets the value of the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.
      Specified by:
      setSuppressIfZero in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'suppress if zero'.
      Since:
      6.0

    • getSuppressIfZero

      public final boolean getSuppressIfZero()
      Returns the value of the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.
      Specified by:
      getSuppressIfZero in interface ValueProperties
      Returns:
      The value of the property 'suppress if zero'.
      Since:
      6.0

    • setSuppressIfZeroFormula

      public final void setSuppressIfZeroFormula(FormulaField newFormula)
      Sets the formula for the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.
      Specified by:
      setSuppressIfZeroFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'suppress if zero'.
      Since:
      6.0

    • getSuppressIfZeroFormula

      public final FormulaField getSuppressIfZeroFormula()
      Returns the formula for the property 'suppress if zero'. When this property is enabled, nothing is printed each time when the field is evaluated to zero.
      Specified by:
      getSuppressIfZeroFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'suppress if zero'.
      Since:
      6.0

    • setUseThousandsSeparator

      public final void setUseThousandsSeparator(boolean newValue)
      Sets the value of the property 'use thousands separator'. When this property is enabled a sepearator sysmbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.
      Specified by:
      setUseThousandsSeparator in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'use thousands separator'.
      Since:
      6.1

    • getUseThousandsSeparator

      public final boolean getUseThousandsSeparator()
      Returns the value of the property 'use thousands separator'. When this property is enabled a sepearator symbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.
      Specified by:
      getUseThousandsSeparator in interface ValueProperties
      Returns:
      The value of the property 'use thousands separator'.
      Since:
      6.1

    • setUseThousandsSeparatorFormula

      public final void setUseThousandsSeparatorFormula(FormulaField newFormula)
      Sets the formula for the property 'use thousands separator'. When this property is enabled a sepearator symbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.
      Specified by:
      setUseThousandsSeparatorFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'use thousands separator'.
      Since:
      6.1

    • getUseThousandsSeparatorFormula

      public final FormulaField getUseThousandsSeparatorFormula()
      Returns the formula for the property 'use thousands separator'. When this property is enabled a sepearator symbol will be placed before each thousand digit, i.e. 1,000.00 or 1,000,000.00 ... . The default is a comma; you can change it with property 'thousands separator symbol'. This property take no effect when property 'use system default' is enabled.
      Specified by:
      getUseThousandsSeparatorFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'use thousands separator'.
      Since:
      6.1

    • setThousandsSeparatorSymbol

      public final void setThousandsSeparatorSymbol(String newValue)
      Sets the value of the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.
      Specified by:
      setThousandsSeparatorSymbol in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'thousands separator symbol'.
      Since:
      6.1

    • getThousandsSeparatorSymbol

      public final String getThousandsSeparatorSymbol()
      Returns the value of the property 'thousands separator symbol'. If the property 'use system default' is disabled and the property 'use thousands separator' in enabled this character(s) were used for.
      Specified by:
      getThousandsSeparatorSymbol in interface ValueProperties
      Returns:
      The value of the property 'thousands separator symbol'.
      Since:
      6.1

    • setThousandsSeparatorSymbolFormula

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

    • getThousandsSeparatorSymbolFormula

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

    • setRounding

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

      This does not affect the formatting of the value. In most cases, it is advisable to set the NDecimalPlaces to the negated value.

      Specified by:
      setRounding in interface ValueProperties
      Parameters:
      newValue - position of digit to round to: negative numbers for after the decimal point, positive for before
      See Also:

    • getRounding

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

      This does not affect the formatting of the value. In most cases, it is advisable to set the NDecimalPlaces to the negated value.

      Specified by:
      getRounding in interface ValueProperties
      Returns:
      digits position of digit to round to: negative numbers for after the decimal point, positive for before
      See Also:

    • setRoundingFormula

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

    • getRoundingFormula

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

    • setRoundingMode

      public final void setRoundingMode(int newValue)
      Sets the rounding mode. The default mode is ROUND_HALF_EVEN. This property has only an effect if 'use system default' is disabled.
      Specified by:
      setRoundingMode in interface ValueProperties
      Parameters:
      newValue - the rounding mode to be used for rounding numbers.
      See Also:

    • getRoundingMode

      public final int getRoundingMode()
      Returns the rounding mode for this element.
      Specified by:
      getRoundingMode in interface ValueProperties
      Returns:
      the current rounding mode
      See Also:

    • setRoundingModeFormula

      public final void setRoundingModeFormula(FormulaField newFormula)
      Sets the formula for the property 'rounding mode'. When property 'use system default' is disabled, you can set the rounding algorithm.
      Specified by:
      setRoundingModeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'rounding type'. The result of the formula should be in range from 0 to 7.
      See Also:

    • getRoundingModeFormula

      public final FormulaField getRoundingModeFormula()
      Returns the formula for the rounding mode, can be null if the formula is not set.
      Specified by:
      getRoundingModeFormula in interface ValueProperties
      Returns:
      the formula or null if not set.
      See Also:

    • setNegativeType

      public void setNegativeType(int newValue)
      Sets the value of the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.
      Specified by:
      setNegativeType in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'negative type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NOT_NEGATIVE
      • ValuePropertiesConstants.LEADING_MINUS
      • ValuePropertiesConstants.TRAILING_MINUS
      • ValuePropertiesConstants.BRACKETED

    • getNegativeType

      public int getNegativeType()
      Returns the value of the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.
      Specified by:
      getNegativeType in interface ValueProperties
      Returns:
      The current value of the property 'negative type'.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NOT_NEGATIVE
      • ValuePropertiesConstants.LEADING_MINUS
      • ValuePropertiesConstants.TRAILING_MINUS
      • ValuePropertiesConstants.BRACKETED

    • setNegativeTypeFormula

      public void setNegativeTypeFormula(FormulaField newFormula)
      Sets the formula for the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.
      Specified by:
      setNegativeTypeFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'negative type'. The result of the formula should be in range from 0 to 3.
      Since:
      6.0
      See Also:
      • ValuePropertiesConstants.NOT_NEGATIVE
      • ValuePropertiesConstants.LEADING_MINUS
      • ValuePropertiesConstants.TRAILING_MINUS
      • ValuePropertiesConstants.BRACKETED

    • getNegativeTypeFormula

      public FormulaField getNegativeTypeFormula()
      Returns the formula for the property 'negative type'. With this property you can specify the appearance of numbers if there are negative.
      Specified by:
      getNegativeTypeFormula in interface ValueProperties
      Returns:
      FormulaField The formula for the property 'negative type'.
      Since:
      6.0

    • setUseLeadingZero

      public final void setUseLeadingZero(boolean newValue)
      Sets the value of the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).
      Specified by:
      setUseLeadingZero in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'use leading zero'.
      Since:
      6.0

    • getUseLeadingZero

      public final boolean getUseLeadingZero()
      Returns the value of the property 'use leading zero'. When this property is enabled and the value of the field is lesser than 1 a leading zero will be printed before the decimal separator symbol (0.001, 0.888, 0.4). Otherwise the number will be printed with a decimal separator symbol only (.001, .888, .04).
      Specified by:
      getUseLeadingZero in interface ValueProperties
      Returns:
      The value of the property 'use leading zero'.
      Since:
      6.0

    • setUseLeadingZeroFormula

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

    • getUseLeadingZeroFormula

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

    • setZeroValueString

      public final void setZeroValueString(String newValue)
      Sets the value of the property 'zero value string'. If the value is null then there will be no custom zero value.
      Specified by:
      setZeroValueString in interface ValueProperties
      Parameters:
      newValue - The new value of the property 'zero value string'.
      Since:
      6.0

    • getZeroValueString

      public final String getZeroValueString()
      Returns the value of the property 'zero value string'.
      Specified by:
      getZeroValueString in interface ValueProperties
      Returns:
      The value of the property 'zero value string'.
      Since:
      6.0

    • setNumeralLanguage

      public final void setNumeralLanguage(int language)
      Sets the language of the numerals in number, date, time or datetime values.
      Specified by:
      setNumeralLanguage in interface ValueProperties
      Parameters:
      language - one of the language constant values or -1 for the default of the current report and locale.
      See Also:

    • getNumeralLanguage

      public final int getNumeralLanguage()
      Returns the language of numerals for numbers, date, time and datetime values.
      Specified by:
      getNumeralLanguage in interface ValueProperties
      Returns:
      One of the language constant or -1 for the report and locale default.
      See Also:

    • setAllowFieldClipping

      public final void setAllowFieldClipping(boolean newValue)
      Sets the value of the property 'allow field clipping'. When this property is enabled and the number value of the field is larger then the clip rectangle then the value is cutting. If it is disable then only a count of number sign '#' are printed in the clip rectangle.
      Specified by:
      setAllowFieldClipping in interface ValueProperties
      Parameters:
      newValue - The new value of the property.
      Since:
      6.0
      See Also:

    • isAllowFieldClipping

      public final boolean isAllowFieldClipping()
      Returns true if allow field clipping is enabled, else false is returned.
      Specified by:
      isAllowFieldClipping in interface ValueProperties
      Returns:
      whether field clipping is allowed for this field.
      Since:
      7.0

    • setAllowFieldClippingFormula

      public final void setAllowFieldClippingFormula(FormulaField newField)
      Set the formula for the property 'allow field clipping'.
      Specified by:
      setAllowFieldClippingFormula in interface ValueProperties
      Parameters:
      newField - Formula Field to set for the property "allow field clipping"
      Since:
      6.0
      See Also:

    • getAllowFieldClippingFormula

      public final FormulaField getAllowFieldClippingFormula()
      Get the formula for the property 'allow field clipping'.
      Specified by:
      getAllowFieldClippingFormula in interface ValueProperties
      Returns:
      Formula Field for the property "allow field clipping"
      Since:
      6.0
      See Also:

    • getCurrencySeparator

      public final String getCurrencySeparator()
      Returns the separator between the number value and currency symbol. The default value for this property is an space character.
      Specified by:
      getCurrencySeparator in interface ValueProperties
      Returns:
      The separator to be displayed between the number value and the currency value.
      Since:
      7.0

    • setCurrencySeparator

      public final void setCurrencySeparator(String newCurrencySeparator)
      Sets the separator to be displayed between the number value and the currency value.
      Specified by:
      setCurrencySeparator in interface ValueProperties
      Parameters:
      newCurrencySeparator - The separator to be used between number value and currency symbol.
      Since:
      7.0

    • getCurrencySeparatorFormula

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

    • setCurrencySeparatorFormula

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

    • setField

      public final void setField(Field newField)
      Sets the field definition element (for example, DatabaseField element, prompt field element).
      Overrides:
      setField in class Element
      Parameters:
      newField - The new field element of the property 'field'.

    • getPropertyFormulas

      public List<FormulaField> getPropertyFormulas()
      Returns a list with all property formulas that are set for this report element. This includes property formulas for any type of sub-component but excludes formulas for any descendant ReportComponent of this one. To get the property formulas for descendant ReportComponent use ReportComponent.getSubComponents()
      Overrides:
      getPropertyFormulas in class AbstractFontElement
      Returns:
      List of property formulas

    • getManualFormatFormula

      public FormulaField getManualFormatFormula()
      Gets the formula of the property 'manual format'. Use this property to specify a formula to manually format the value of this element. If this formula is not null, it will be used to manually format the element and will override any number, date, or other formatting settings. This formula must return a string value to be valid.
      Specified by:
      getManualFormatFormula in interface ValueProperties
      Returns:
      FormulaField The formula of the property 'manual format'.
      Since:
      6.1

    • setManualFormatFormula

      public void setManualFormatFormula(FormulaField newFormula)
      Gets the formula of the property 'manual format'. Use this property to specify a formula to manually format the value of this element. If this formula is not null, it will be used to manually format the element and will override any number, date, or other formatting settings. This formula must return a string value to be valid.
      Specified by:
      setManualFormatFormula in interface ValueProperties
      Parameters:
      newFormula - The new formula for the property 'manual format'.
      Since:
      6.1

    • parseElement

      public NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String,Object> parserMap) throws FatalParserException
      FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY FOR INTERNAL USE ONLY Internal method for reading report XML

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

      Specified by:
      parseElement in interface NodeParser
      Overrides:
      parseElement in class AbstractFontElement
      Parameters:
      group - XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.
      tag - The XMLTag to be parsed
      atts - The set of attributes in the current XMLTag
      parserMap - The map of current Parser.
      Returns:
      The NodeParser sub-element if one needed to be created, or null if none was created.
      Throws:
      FatalParserException - if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.