org.openxava.annotations
Annotation Type DescriptionsList

@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
public @interface DescriptionsList

With @DescriptionsList you can instruct OpenXava to visualize references as a descriptions list (actually a combo).

Applies to references.

This can be useful, if there are only a few elements and these elements have a significant name or description. Example:

  @DescriptionsList
  @ManyToOne
  private DrivingLicence drivingLicence;
 

Author:

Javier Paniza

Optional Element Summary

java.lang.String	condition Allows to specify a condition (with SQL style) to filter the values that are shown in the description list.
java.lang.String	depends Indicates that the list content depends on another value displayed.
java.lang.String	descriptionProperties The property (or properties) to show in the list.
java.lang.String	forTabs List of comma separated tab names where this annotation applies.
java.lang.String	forViews List of comma separated view names where this annotation applies.
java.lang.String	notForTabs List of comma separated tab names where this annotation applies.
java.lang.String	notForViews List of comma separated view names where this annotation does not apply.
java.lang.String	order Allows to specify an order (with SQL style) for the values that are shown in the description list.
boolean	orderByKey By default the data is ordered by description, but if you set this property to true it will be ordered by key.

forViews

public abstract java.lang.String forViews

List of comma separated view names where this annotation applies.

Exclusive with notForViews.
If both forViews and notForViews are omitted then this annotation apply to all views.
You can use the string "DEFAULT" for referencing to the default view (the view with no name).

Default:

""

notForViews

public abstract java.lang.String notForViews

List of comma separated view names where this annotation does not apply.

Exclusive with forViews.
If both forViews and notForViews are omitted then this annotation apply to all views.
You can use the string "DEFAULT" for referencing to the default view (the view with no name).

Default:

""

descriptionProperties

public abstract java.lang.String descriptionProperties

The property (or properties) to show in the list.

If not specified, the property named description, descripcion, name or nombre is assumed. If the referenced object does not have a property called this way then it is required to specify a property name here.
It's possible to indicate several properties separated by commas.

Default:

""

depends

public abstract java.lang.String depends

Indicates that the list content depends on another value displayed.

It's used in together with condition. It can be achieve that the list content depends on another value displayed in the main view (if you simply type the name of the member) or in the same view (if you type this. before the name of the member).

Default:

""

condition

public abstract java.lang.String condition

Allows to specify a condition (with SQL style) to filter the values that are shown in the description list.

Default:

""

orderByKey

public abstract boolean orderByKey

By default the data is ordered by description, but if you set this property to true it will be ordered by key.

Default:

false

order

public abstract java.lang.String order

Allows to specify an order (with SQL style) for the values that are shown in the description list.

Default:

""

forTabs

public abstract java.lang.String forTabs

List of comma separated tab names where this annotation applies.

Default:

""

notForTabs

public abstract java.lang.String notForTabs

List of comma separated tab names where this annotation applies.

Default:

""