org.uberfire.preferences.shared.annotations

Annotation Type Property

@Inherited
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface Property

Annotation used to mark preference beans properties.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	bundleKey Defines a bundle key that will be used to internationalize the property's label wherever is necessary.
PropertyFormOptions[]	formOptions Defines options that will be applied to the automatically generated form field.
PropertyFormType	formType Defines the type of field to be used in the default form.
String	helpBundleKey Defines a help bundle key that will be used to internationalize the property's help text wherever is necessary.
boolean	shared Defines whether or not this property should be shared by its parents.
Class<? extends PropertyValidator>[]	validators Defines validators that will be applied to the field on automatically generated forms.

Element Detail

formType

public abstract PropertyFormType formType

Defines the type of field to be used in the default form. The default is TEXT. You should only specify this if you are using the default form for preferences edition, otherwise it will have no effect.

Returns:

The property type to be used.

Default:

org.uberfire.preferences.shared.PropertyFormType.TEXT

shared

public abstract boolean shared

Defines whether or not this property should be shared by its parents. Defaults to false.

Returns:

The property sharing strategy.

Default:

false

bundleKey

public abstract String bundleKey

Defines a bundle key that will be used to internationalize the property's label wherever is necessary. It's expected that the TranslationService will have access to the key translation.

Returns:

The property bundle key.

Default:

""

helpBundleKey

public abstract String helpBundleKey

Defines a help bundle key that will be used to internationalize the property's help text wherever is necessary. It's expected that the TranslationService will have access to the key translation.

Returns:

The property help bundle key.

Default:

""

formOptions

public abstract PropertyFormOptions[] formOptions

Defines options that will be applied to the automatically generated form field.

Returns:

The form options to be used.

Default:

{}

validators

public abstract Class<? extends PropertyValidator>[] validators

Defines validators that will be applied to the field on automatically generated forms.

Returns:

The validators to be applied.

Default:

{}