Package org.openxava.annotations

Annotation Interface Tab

@Repeatable(Tabs.class) @Retention(RUNTIME) @Target(TYPE) public @interface Tab
Define the behavior for tabular data presentation (List mode).

Applies to entities.

Example: 

  @Tab(name="ActiveYear",
    filter=ActiveYearFilter.class,          
    properties="year, number, customer.number, customer.name, amountsSum, vat, detailsCount, paid, importance",
    baseCondition="${year} = ?"
  )
Author:
Javier Paniza

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    baseCondition
    Condition to be fulfilled by the displayed data.
    String
    defaultOrder
    To specify the initial order for data.
    String
    editableProperties
    List of properties that can be edited inline by the user.
    String
    editor
    Editor from default-editors.xml or editors.xml used for default list format.
    String
    editors
    Editors from default-editors.xml or editors.xml used for all the list format.
    Class
    filter
    Allows to define programmatically some logic to apply to the values entered by user when he filters the list data.
    String
    name
    You can define several tabs in a entity, and set a name for each one.
    String
    properties
    The list of properties to show initially.
    RowStyle[]
    rowStyles
    A simple way to specify a different visual style for some rows.

  • Element Details

    • name

      String name
      You can define several tabs in a entity, and set a name for each one.

      This name is used to indicate the tab that you want to use (usually in application.xml).

      Default:
      ""

    • rowStyles

      RowStyle[] rowStyles
      A simple way to specify a different visual style for some rows.

      Normally to emphasize rows that fulfill certain condition.

      Default:
      {}

    • properties

      String properties
      The list of properties to show initially.

      Can be qualified (that is you can specify referenceName.propertyName at any depth level).

      Default:
      ""

    • editableProperties

      String editableProperties
      List of properties that can be edited inline by the user.

      Only plain editable properties are allowed. Qualified properties (from references), calculated properties,

      Since:
      7.6
      Default:
      ""

    • filter

      Class filter
      Allows to define programmatically some logic to apply to the values entered by user when he filters the list data.
      Default:
      org.openxava.filters.VoidFilter.class

    • baseCondition

      String baseCondition
      Condition to be fulfilled by the displayed data.

      It's added to the user condition if needed.

      Default:
      ""

    • defaultOrder

      String defaultOrder
      To specify the initial order for data.
      Default:
      ""

    • editor

      String editor
      Editor from default-editors.xml or editors.xml used for default list format.

      It replace the "List" editor but does not remove the other ones.

      Default:
      ""

    • editors

      String editors
      Editors from default-editors.xml or editors.xml used for all the list format.

      It replace all editors.

      Default:
      ""