com.axelor.db.annotations

Annotation Type Widget

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

Provides information about UI widget representing this field.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	copyable Whether to copy this field when creating duplicate record.
boolean	defaultNow Whether the field should use current date/datetime as default value.
String	help Help text.
boolean	hidden Whether to hide widget by default.
boolean	image Use image widget for this binary field.
boolean	massUpdate Whether to allow mass update on this field.
boolean	multiline Should be used with String fields to mark whether to use multiline text widget.
boolean	password Use password widget for this string field.
boolean	readonly Whether the widget should be set readonly.
String[]	search List of the columns to be used to search this record.
String	selection The name of the selection.
String	title Title for the UI widget.
boolean	translatable Whether the field value is translatable.

Element Detail

title

public abstract String title

Title for the UI widget.

Returns:

the title

Default:

""

help

public abstract String help

Help text.

Returns:

help text

Default:

""

readonly

public abstract boolean readonly

Whether the widget should be set readonly.

Returns:

true if marked as readonly, default is false

Default:

false

hidden

public abstract boolean hidden

Whether to hide widget by default.

Returns:

true if marked as hidden, default is false

Default:

false

multiline

public abstract boolean multiline

Should be used with String fields to mark whether to use multiline text widget.

Returns:

true if marked as multiline, default is false

Default:

false

image

public abstract boolean image

Use image widget for this binary field.

Returns:

true if marked as image, default is false

Default:

false

password

public abstract boolean password

Use password widget for this string field.

Returns:

true if marked as password, default is false

Default:

false

massUpdate

public abstract boolean massUpdate

Whether to allow mass update on this field.

Returns:

true if marked for mass update, default is false

Default:

false

copyable

public abstract boolean copyable

Whether to copy this field when creating duplicate record.

Returns:

true if marked as copyable, default is true

Default:

true

translatable

public abstract boolean translatable

Whether the field value is translatable.

Returns:

true if marked as translatable, default is false

Default:

false

defaultNow

public abstract boolean defaultNow

Whether the field should use current date/datetime as default value.

Returns:

true if "now" is given as defaultValue

Default:

false

search

public abstract String[] search

List of the columns to be used to search this record.

Used by auto-complete widget. By default the same column will be searched. Also, in case of virtual column (computed values) specify the actual searchable columns.

Returns:

array if fields on which to search, default is empty

Default:

{}

selection

public abstract String selection

The name of the selection.

Returns:

name of the selection, default is empty

Default:

""