| |||||||
FRAMES NO FRAMES |
Declares an attribute that may be given to an instance of the composite component tag for this composite component. There may be zero or many of these inside of the <composite:interface
> section. This element may be nested within other <composite:attribute>
elements to convey a usage contract that includes nested properties.
Please see summary page for a usage example.
The top level component in which this element is ultimately nested must be a NamingContainer
. There are certain component properties that must not be exposed using this element. The motivation for this restriction is that the mapping of markup attributes to component properties/attributes does not allow for these attributes to be set. The following properties must not be exposed using this element.
binding
id
inView
parent
rendered
rendererType
transient
Tag Information | |
Tag Class | None |
TagExtraInfo Class | None |
Body Content | JSP |
Display Name | None |
Attributes | ||||
Name | Required | Request-time | Type | Description |
name | true | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The name of the attribute as it must appear on the composite component tag in the using page. If the value of the name attribute is equal to (without the quotes) “action”, “actionListener”, “validator”, or “valueChangeListener”, the action described in ViewHandler.retargetMethodExpressions() must be taken to handle the attribute. In these cases, the |
targets | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| If this element has a |
targetAttributeName | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| This attribute allows the name of the attribute exposed to the using page to differ from the one actually used in the implementation. For example, consider a composite component that contains two buttons, one that means "submit" and one that means "cancel". It is natural to want to declare two composite component attributes to allow these buttons to be customized, for example, "submitAction" and "cancelAction". For both of these buttons, the method expression should be retargeted to the inner button's "action" attribute. This scenario would be expressed as follows. <cc:interface> |
default | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| If this attribute is not required, and a value is not supplied by the page author, use this as the default value. |
displayName | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| The name to display in a tool palette containing this component. The value of this attribute will be set as the value for this property on the composite component bean descriptor. |
required | false | false | javax.el.ValueExpression
(must evaluate to boolean )
| True if the page author must supply a value for this attribute. The default value is false. |
preferred | false | false | javax.el.ValueExpression
(must evaluate to boolean )
| Is this a "preferred" component. The value of this attribute will be set as the value for this property on the composite component bean descriptor. |
expert | false | false | javax.el.ValueExpression
(must evaluate to boolean )
| Is this component only for expert users? The value of this attribute will be set as the value for this property on the composite component bean descriptor. |
shortDescription | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| A short description of the purpose of this component. The value of this attribute will be set as the value for this property on the composite component bean descriptor. |
method-signature | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Declares that this attribute must be a PENDING: when this file is generated from the web-facesuicomponent_2_0.xsd, we will not need to copy the content here manually. Provides the signature of the Java method. The syntax of the method-signature element is as follows (taken from function-signature in web-jsptaglibrary_2_1.xsd): MethodSignature ::= ReturnType S MethodName S? '(' S? Parameters? S? ')' ReturnType ::= Type MethodName ::= Identifier Parameters ::= Parameter | ( Parameter S? ',' S? Parameters ) Parameter ::= Type Where:
Example:
|
type | false | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Declares that this attribute must be a |
hidden | false | false | javax.el.ValueExpression
(must evaluate to boolean )
| The "hidden" flag is used to identify features that are intended only for tool use, and which should not be exposed to humans. |
Variables | No Variables Defined. |
| |||||||
FRAMES NO FRAMES |