io.jmix.dashboardsui.annotation

Annotation Type DashboardWidget

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface DashboardWidget

Indicates that an annotated class is a widget type. Such classes must be inherited from the Widget

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	editFragmentId Contains fragment ID for editing a widget.
java.lang.String	name The name for widget-edit screen, can be localized in main message.properties by pattern: dashboard-widget.{name} = {localization message}
java.lang.String	value

Element Detail

name

@AliasFor(value="value")
public abstract java.lang.String name

The name for widget-edit screen, can be localized in main message.properties by pattern: dashboard-widget.{name} = {localization message}

Returns:

name for widget-edit screen

Default:

""

value

@AliasFor(value="name")
public abstract java.lang.String value

Returns:

alias for name()

Default:

""

editFragmentId

public abstract java.lang.String editFragmentId

Contains fragment ID for editing a widget. This fragment is embedded in the "widget-edit" screen

Returns:

fragment ID for editing a widget

Default:

""