org.richfaces.cdk.annotations
Annotation Type Attribute

@Retention(value=CLASS)
@Target(value={FIELD,METHOD})
@Inherited
public @interface Attribute

Used to define Java class field or bean property getter method as JSF attribute. It used on the abstract method, all necessary code for attribute, including state save/restore code, will be generated by CDK.

Author:

asmirnov@exadel.com

Optional Element Summary

Alias[]	aliases Attribute aliases.
String	defaultValue Attribute default value.
Description	description Attribute description to include in generated faces-config.xml and taglibs.
EventName[]	events Event descriptions for ClientBehavior binding.
boolean	generate Tells CDK to generate getter and setter for attribute.
boolean	hidden Tells CDK to not include attribute in the VDL tag.
boolean	literal Restricts attribute to literal values only ( no EL expressions ).
boolean	passThrough If true, attribute used as pass through html attribue, eg.
boolean	readOnly Marks attribute as read-only ( no setter method ).
boolean	required Marks attribute as required.
Signature	signature Method signature for attributes with EL method reference type, either MethodBinding or MethodExpression.
String	suggestedValue Used by IDE to suggest attribute value.

literal

public abstract boolean literal

Restricts attribute to literal values only ( no EL expressions ).

Returns:

Default:

false

hidden

public abstract boolean hidden

Tells CDK to not include attribute in the VDL tag.

Returns:

Default:

false

readOnly

public abstract boolean readOnly

Marks attribute as read-only ( no setter method ).

Returns:

Default:

false

passThrough

public abstract boolean passThrough

If true, attribute used as pass through html attribue, eg. rendered directly into html without any transformations.

Returns:

Default:

false

required

public abstract boolean required

Marks attribute as required. Generated tag handler should check its presence.

Returns:

Default:

false

generate

public abstract boolean generate

Tells CDK to generate getter and setter for attribute.

Returns:

Default:

true

defaultValue

public abstract String defaultValue

Attribute default value. Should be valid Java code that can be used in field initialiser of function call.

Returns:

Default:

""

suggestedValue

public abstract String suggestedValue

Used by IDE to suggest attribute value.

Returns:

Default:

""

description

public abstract Description description

Attribute description to include in generated faces-config.xml and taglibs.

Returns:

Default:

@org.richfaces.cdk.annotations.Description

signature

public abstract Signature signature

Method signature for attributes with EL method reference type, either MethodBinding or MethodExpression.

Returns:

Default:

@org.richfaces.cdk.annotations.Signature(returnType=org.richfaces.cdk.annotations.Signature.NONE.class)

events

public abstract EventName[] events

Event descriptions for ClientBehavior binding.

Returns:

Default:

{}

aliases

public abstract Alias[] aliases

Attribute aliases.

Returns:

Default:

{}