org.openxava.annotations

Annotation Type Tab

@Repeatable(value=Tabs.class)
 @Retention(value=RUNTIME)
 @Target(value=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 and Description
java.lang.String	baseCondition Condition to be fulfilled by the displayed data.
java.lang.String	defaultOrder To specify the initial order for data.
java.lang.String	editor Editor from default-editors.xml or editors.xml used for default list format.
java.lang.String	editors Editors from default-editors.xml or editors.xml used for all the list format.
java.lang.Class	filter Allows to define programmatically some logic to apply to the values entered by user when he filters the list data.
java.lang.String	name You can define several tabs in a entity, and set a name for each one.
java.lang.String	properties The list of properties to show initially.
RowStyle[]	rowStyles A simple way to specify a different visual style for some rows.

Element Detail

name

public abstract java.lang.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

public abstract RowStyle[] rowStyles

A simple way to specify a different visual style for some rows.

Normally to emphasize rows that fulfill certain condition.

Default:

{}

properties

public abstract java.lang.String properties

The list of properties to show initially.

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

Default:

""

filter

public abstract java.lang.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

public abstract java.lang.String baseCondition

Condition to be fulfilled by the displayed data.

It's added to the user condition if needed.

Default:

""

defaultOrder

public abstract java.lang.String defaultOrder

To specify the initial order for data.

Default:

""

editor

public abstract java.lang.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

public abstract java.lang.String editors

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

It replace all editors.

Default:

""