|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Documented @Target(value=TYPE) @Retention(value=SOURCE) public @interface JSFJspProperty
Defines a logical property of a component that is accessed via the component's Attributes map, rather than javaBean getter/setter methods.
These logical properties are accessible from views (eg available as JSP tag attributes) just like properties declared with the JSFProperty annotation.
A class or interface that defines just one logical property may use this annotation directly; to declare more than one logical property should use the JSFJspProperties annotation to group a set of these. Classes that implement interfaces with this annotation, or subclass a base class that has this annotation, will inherit the declared attributes.
This annotation should only be applied to classes that also have the JSFComponent and JSFValidator annotation.
Optional Element Summary | |
---|---|
String |
desc
A short description of the purpose of this attribute. |
boolean |
inheritedTag
Indicate if this property is inherited from a parent tag class or not. |
boolean |
literalOnly
Indicate that the getter and setter does not evaluate EL or ValueBinding expressions. |
String |
longDesc
A long description of the purpose of this attribute. |
String |
name
The name that identifies this attribute. |
boolean |
required
Define whether this attribute is mandatory for the associated component, ie whether it is an error to create an instance of the component and not to provide a value for this attribute. |
String |
returnType
The type of this attribute. |
boolean |
stateHolder
Use saveAttachedXXX and restoreAttachedXXX to save and restore state |
boolean |
tagExcluded
Define if this tag is excluded from tld. |
public abstract String name
This String is the key used to look up the attribute in the component's Attributes map.
Examples: border, id, value
public abstract String returnType
This must be a fully-qualified class name of a java type.
TODO: doesn't the JSF spec also allow short-cuts for common types here?
public abstract boolean required
public abstract boolean tagExcluded
This is very ugly feature, and should be used as little as possible. It allows a parent class (or interface) to declare logical properties, then a subclass to "undeclare" them. This is completely broken OO design, but is required in a few rare cases by the JSF specification.
public abstract String longDesc
This is commonly shown as help in IDEs.
public abstract String desc
This is commonly shown as a "tool tip" or popup-help in IDEs.
public abstract boolean inheritedTag
public abstract boolean stateHolder
public abstract boolean literalOnly
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |