org.apache.myfaces.buildtools.maven2.plugin.builder.annotation
Annotation Type JSFProperty


@Documented
@Target(value=METHOD)
@Retention(value=SOURCE)
public @interface JSFProperty

Define that this getter or setter method define a property.

Version:
$Revision: 955479 $ $Date: 2010-06-16 23:34:37 -0500 (Wed, 16 Jun 2010) $
Author:
Leonardo Uribe (latest modification by $Author: lu4242 $)

Optional Element Summary
 java.lang.String clientEvent
          Indicate if this property is a client event that should be returned by ClientBehaviorHolder.getEventNames().
 java.lang.String defaultValue
          The default value to set if this property is generated.
 java.lang.String deferredValueType
          Indicate the type that values should be cast on tld.
 java.lang.String desc
          Short description
 boolean faceletsOnly
           
 boolean inheritedTag
          Indicate if this property is inherited from a parent tag class or not.
 boolean istransient
          Indicate if the property is not saved and restored its state.
 java.lang.String jspName
          The name used in jsp pages to make reference to this property (used on tld).
 boolean literalOnly
          Indicate that the getter and setter does not evaluate EL or ValueBinding expressions.
 boolean localMethod
          Indicate if it should be generated a method like getLocalXXX to retrieve the local value of the property directly (without evaluate ValueBinding or ValueExpression).
 java.lang.String localMethodScope
          Define the scope to be used when generating the method getLocalXXX.
 java.lang.String methodSignature
          CSV full names of the types that are params for methods using this MethodBinding or MethodExpression param
 boolean partialStateHolder
           
 boolean required
          (true|false) Define if the property is required or not.
 java.lang.String returnSignature
          The full name of the return type for MethodBinding or MethodExpression it uses
 boolean rtexprvalue
          (true|false) This value is put on the tld when applies.
 boolean setMethod
          Indicate if it should be generated a method like isSetXXX, used when it is necessary to check if a boolean type property was set programatically (using setXXX method) or not.
 java.lang.String setMethodScope
          Define the scope to be used when generating the method isSetXXX.
 boolean stateHolder
          Use saveAttachedXXX and restoreAttachedXXX to save and restore state
 boolean tagExcluded
          Define if this tag is excluded from tld.
 

required

public abstract boolean required
(true|false) Define if the property is required or not. Default:false

Default:
false

istransient

public abstract boolean istransient
Indicate if the property is not saved and restored its state.

Default:
false

stateHolder

public abstract boolean stateHolder
Use saveAttachedXXX and restoreAttachedXXX to save and restore state

Default:
false

literalOnly

public abstract boolean literalOnly
Indicate that the getter and setter does not evaluate EL or ValueBinding expressions.

Default:
false

tagExcluded

public abstract boolean tagExcluded
Define if this tag is excluded from tld.

Default:
false

localMethod

public abstract boolean localMethod
Indicate if it should be generated a method like getLocalXXX to retrieve the local value of the property directly (without evaluate ValueBinding or ValueExpression). If there is no generation of component class this property has any effect.

Default:
false

localMethodScope

public abstract java.lang.String localMethodScope
Define the scope to be used when generating the method getLocalXXX. The default to be applied is "protected".

Default:
""

setMethod

public abstract boolean setMethod
Indicate if it should be generated a method like isSetXXX, used when it is necessary to check if a boolean type property was set programatically (using setXXX method) or not. If there is no generation of component class this property has any effect.

Default:
false

setMethodScope

public abstract java.lang.String setMethodScope
Define the scope to be used when generating the method isSetXXX. The default to be applied is "protected".

Default:
""

jspName

public abstract java.lang.String jspName
The name used in jsp pages to make reference to this property (used on tld).

Default:
""

rtexprvalue

public abstract boolean rtexprvalue
(true|false) This value is put on the tld when applies.

Default:
false

desc

public abstract java.lang.String desc
Short description

Default:
""

inheritedTag

public abstract boolean inheritedTag
Indicate if this property is inherited from a parent tag class or not.

Returns:
Default:
false

returnSignature

public abstract java.lang.String returnSignature
The full name of the return type for MethodBinding or MethodExpression it uses

Default:
""

methodSignature

public abstract java.lang.String methodSignature
CSV full names of the types that are params for methods using this MethodBinding or MethodExpression param

Default:
""

defaultValue

public abstract java.lang.String defaultValue
The default value to set if this property is generated.

Default:
""

deferredValueType

public abstract java.lang.String deferredValueType
Indicate the type that values should be cast on tld. This param only applies on jsf 1.2 (it is supposed that the className is javax.el.ValueExpression to apply it), because in jsf 1.1, values on tag class are considered to be String.

Since:
1.0.3
Default:
""

clientEvent

public abstract java.lang.String clientEvent
Indicate if this property is a client event that should be returned by ClientBehaviorHolder.getEventNames(). This property is by default "", it is JSF 2.0 specific, and the component holding it must implement javax.faces.component.behavior.ClientBehaviorHolder interface.

Since:
1.0.4
Default:
""

partialStateHolder

public abstract boolean partialStateHolder
Since:
1.0.5
Default:
false

faceletsOnly

public abstract boolean faceletsOnly
Since:
1.0.5
Default:
false


Copyright © 2001-2011 The Apache Software Foundation. All Rights Reserved.