Package io.jmix.reports.annotation

Annotation Interface ValueFormatDef

@Target(TYPE) @Retention(RUNTIME) @Repeatable(RepeatableValueFormatDef.class) public @interface ValueFormatDef
Defines a value format - element of the report structure. Value formats are used to fine-tune output formatting for any field produced by the report.
This annotation can be used several times on the report class if it has several value formats. Additional associated logic can be declared by creating a method annotated with ValueFormatDelegate.
Model object is ReportValueFormat.
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    band
    Name of the report band containing the field.
    String
    field
    Name of the field to be formatted.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    format
    Field format.

  • Element Details

    • band

      String band
      Name of the report band containing the field.

    • field

      String field
      Name of the field to be formatted.

    • format

      String format
      Field format. For number values specify the format according to the DecimalFormat rules, for dates - SimpleDateFormat. Built-in formats for inserting an image, html blocks and others are also available - check the documentation.
      Default:
      ""