de.aristaflow.adept2.model.common.viewer

Annotation Type Attribute

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Attribute

Annotates a method of a view interface, including the name of the attribute.

Author:

Kevin Goeser

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	ATTRIBUTE_NO_DEFAULT_VALUE Constant expressing that no default value is provided.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name Returns the name of the attribute.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	defaultValue Returns the default value of an optional attribute.
java.lang.String	description Returns the description of the attribute.
java.lang.String	label
boolean	localised Returns true, if the field is translatable (only valid for strings).
Attribute.Type	type

Field Detail

ATTRIBUTE_NO_DEFAULT_VALUE

public static final java.lang.String ATTRIBUTE_NO_DEFAULT_VALUE

Constant expressing that no default value is provided.

Element Detail

name

public abstract java.lang.String name

Returns the name of the attribute.

Returns:

The name of the attribute.

label

public abstract java.lang.String label

Returns:

A label, e.g. for the UI formatted name.

Default:

"ATTRIBUTE_NO_DEFAULT_VALUE"

description

public abstract java.lang.String description

Returns the description of the attribute.

Returns:

The description of the attribute.

Default:

""

type

public abstract Attribute.Type type

Returns:

A type specialisation.

Default:

de.aristaflow.adept2.model.common.viewer.Attribute.Type.DEFAULT

defaultValue

public abstract java.lang.String defaultValue

Returns the default value of an optional attribute.

Returns:

The default value of an optional attribute.

Default:

"ATTRIBUTE_NO_DEFAULT_VALUE"

localised

public abstract boolean localised

Returns true, if the field is translatable (only valid for strings).

Returns:

True, if the field is translatable (only valid for strings).

Default:

false