Package org.openxava.annotations

Annotation Type DescriptionsList

@Repeatable(DescriptionsLists.class)
@Retention(RUNTIME)
@Target({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

Optional Elements

Modifier and Type	Optional Element	Description
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.Class	filter	Allows to define the logic to fill the values of the parameters used in the condition (the ?).
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.
boolean	showReferenceView	Shows the descriptions list combo and a detail view of the reference at the same time.

Element Detail

forViews

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

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

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

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

java.lang.String condition

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

Default:

""

filter

java.lang.Class filter

Allows to define the logic to fill the values of the parameters used in the condition (the ?). It must implement IFilter and you can use here the same filters used for @Tab.

Since:

6.4

Default:

org.openxava.filters.VoidFilter.class

orderByKey

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

java.lang.String order

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

Default:

""

showReferenceView

boolean showReferenceView

Shows the descriptions list combo and a detail view of the reference at the same time. The reference view is read only and its value changed when the combo is changed by the user. The view used is the one specified in @ReferenceView.

Since:

5.5

Default:

false

forTabs

java.lang.String forTabs

List of comma separated tab names where this annotation applies.

Default:

""

notForTabs

java.lang.String notForTabs

List of comma separated tab names where this annotation applies.

Default:

""