Package io.jmix.reports.yarg.structure

Interface ReportFieldFormat

All Superinterfaces:
Serializable
All Known Implementing Classes:
ReportValueFormat
public interface ReportFieldFormat extends Serializable
This interface describes a format for certain result field.

  • Method Details

    • getName

      String getName()
      Returns:
      formatted field name. Should also contain all parent band names. Example: Band1.Band2.field1

    • getFormat

      String getFormat()
      Returns:
      format string Example: ##,# for decimals, dd-MM-yyyy for dates, etc.

    • getCustomFormatter

      @Nullable CustomValueFormatter<?> getCustomFormatter()
      Returns:
      custom formatter object. If it exists, it takes precedence over other format options.

    • isGroovyScript

      Boolean isGroovyScript()
      Returns:
      boolean true if the groovy script, otherwise false