Tag name: <af:clientAttribute>

The clientAttribute tag specifies the name/value for an attribute which will both be made available both on the server-side (Faces) component as well on on the client-side equivalent. This tag will be ignored for any server-rendered components, as it is only supported for the rich client. ClientAttributes are not synchronized to the server since unknown attributes from the client are not synchronized to the server.

When using af:clientAttribute the bonus attribute can be accessed on the client through AdfUIComponent.getProperty("<bonusAttributeName>"). The rich client framework takes care of marshaling the attribute value to the client. Our marshaling layer supports marshaling of a range of object types such as Boolean, CharSequence, Character, Integer, Byte, Color, Date, Double, Float, Long, Number, Short, Array, Map, Set, Collection. Any other object type besides the ones listed above are not encoded, instead a String "null" is encoded and a warning will be logged. In order to avoid excessive marshaling overhead, clients are encouraged to use client-side bonus attributes sparingly. af:clientAttribute should only be used for bonus (application-defined) attributes. If you need access to standard component attributes on the client, instead of using af:clientAttribute, simply set clientComponent="true".


Name Type Supports EL? Description
name String No the name of the attribute
value Object Yes the value of the attribute