org.jboss.forge.addon.ui.metadata

Annotation Type WithAttributes

@Documented
 @Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface WithAttributes

Allows configuration of InputComponent injected fields

Author:

George Gastaldi, Lincoln Baxter, III

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	label The label of this InputComponent.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	defaultValue The default value for this InputComponent.
boolean	deprecated Is this InputComponent deprecated?
String	deprecatedMessage The deprecated message for this InputComponent
String	description The description for this InputComponent.
boolean	enabled Return true if this InputComponent is enabled.
String	name The parameter name for this InputComponent
String	note The note for this InputComponent.
boolean	required If true, the value of this object must not be null.
String	requiredMessage The message to display during validation when this InputComponent value is set to null.
char	shortName The programmatic name of this InputComponent.
String	type The InputType for this InputComponent.

Element Detail

label

public abstract String label

The label of this InputComponent.

name

public abstract String name

The parameter name for this InputComponent

Default:

""

shortName

public abstract char shortName

The programmatic name of this InputComponent. This is typically a shorthand or alternate name used for keyboard shortcuts or command line flags.

Default:

32

required

public abstract boolean required

If true, the value of this object must not be null.

Default:

false

requiredMessage

public abstract String requiredMessage

The message to display during validation when this InputComponent value is set to null.

Default:

""

description

public abstract String description

The description for this InputComponent.

Default:

""

enabled

public abstract boolean enabled

Return true if this InputComponent is enabled.

Default:

true

type

public abstract String type

The InputType for this InputComponent.

Default:

"org.jboss.forge.inputType.DEFAULT"

defaultValue

public abstract String defaultValue

The default value for this InputComponent.

Default:

""

note

public abstract String note

The note for this InputComponent.

Default:

""

deprecated

public abstract boolean deprecated

Is this InputComponent deprecated?

Default:

false

deprecatedMessage

public abstract String deprecatedMessage

The deprecated message for this InputComponent

Default:

""