Package overit.geocall.ui

Annotation Interface Component.ConfigurableAttribute

Enclosing class:

Component

@Target(TYPE)
@Retention(RUNTIME)
@Repeatable(ConfigurableAttributes.class)
@Documented
public static @interface Component.ConfigurableAttribute

Annotation used to define a UIProperty for a specific Component. The UI Attributes defined will be showed into the configurability panel to allow the user to configure the graphical representation for the Component
It is possible to define the name, the label, the DataType, the children (if you want to manage the attribute as a lookup) the properties for the attribute (for example fullsize="true" if you want that the attribute will be displayed in fullsize mode into the configurability panel) and declare if the attribute is allowed for the static fields or not.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	Component.ConfigurableAttribute.Ignore	Define one or more attribute that the component must ignore form its parent. The value specified in this annotation must be related to the name() attribute for the Component.ConfigurableAttribute annotation defined into the parent object
static @interface	Component.ConfigurableAttribute.IgnoreAll	Define that the components must ignore all the parent attributes.
static @interface	Component.ConfigurableAttribute.Property
static @interface	Component.ConfigurableAttribute.Value

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	label	The Label that will be showed for the attribute
String	name	The name that identifies the attribute

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	onlyExtended	Gets if the attribute is allowed for the static fields or not.
boolean	overrideParent	Gets if the attribute overridden the parent attribute
Component.ConfigurableAttribute.Property[]	properties	The properties defined for the attribute (for example fullsize="true" if you want that the attribute will be displayed in fullsize mode into the configurability panel)
String	type	The type of the attribute
Component.ConfigurableAttribute.Value[]	values	The list of the children for the attribute (if you want to manage the attribute as a lookup)

Element Details

name

String name

The name that identifies the attribute

Returns:

The name that identifies the attribute

label

String label

The Label that will be showed for the attribute

Returns:

The Label that will be showed for the attribute

type

String type

The type of the attribute

Returns:

The type of the attribute

Default:

"STRING"

values

Component.ConfigurableAttribute.Value[] values

The list of the children for the attribute (if you want to manage the attribute as a lookup)

Returns:

The list of the children for the attribute

Default:

{}

properties

Component.ConfigurableAttribute.Property[] properties

The properties defined for the attribute (for example fullsize="true" if you want that the attribute will be displayed in fullsize mode into the configurability panel)

Returns:

The properties defined for the attribute

Default:

{}

onlyExtended

boolean onlyExtended

Gets if the attribute is allowed for the static fields or not.

Returns:

true if the attribute is not allowed for the static fields, false otherwise

Default:

false

overrideParent

boolean overrideParent

Gets if the attribute overridden the parent attribute

Returns:

true if the attribute overridden the parent attribute, false otherwise

Default:

false