Interface ClientBehaviorHolder
-
public interface ClientBehaviorHolder
The ClientBehaviorHolder interface may be implemented by any concrete
UIComponent
that wishes to support client behaviors as defined byClientBehavior
.- Since:
- 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addClientBehavior(java.lang.String eventName, ClientBehavior behavior)
Attaches aClientBehavior
to the component implementing this interface for the specified event.java.util.Map<java.lang.String,java.util.List<ClientBehavior>>
getClientBehaviors()
Returns a non-null, unmodifiableMap
that contains the theClientBehavior
s that have been attached to the component implementing this interface.java.lang.String
getDefaultEventName()
Returns the default event name for thisClientBehaviorHolder
implementation.java.util.Collection<java.lang.String>
getEventNames()
Returns a non-null, unmodifiableCollection
containing the names of the logical events supported by the component implementing this interface.
-
-
-
Method Detail
-
addClientBehavior
void addClientBehavior(java.lang.String eventName, ClientBehavior behavior)
Attaches a
ClientBehavior
to the component implementing this interface for the specified event. Valid event names for a UIComponent implementation are defined byClientBehaviorHolder.getEventNames()
.- Parameters:
eventName
- the logical name of the client-side event to attach the behavior to.behavior
- theClientBehavior
instance to attach for the specified event name.- Since:
- 2.0
-
getEventNames
java.util.Collection<java.lang.String> getEventNames()
Returns a non-null, unmodifiable
Collection
containing the names of the logical events supported by the component implementing this interface.- Since:
- 2.0
-
getClientBehaviors
java.util.Map<java.lang.String,java.util.List<ClientBehavior>> getClientBehaviors()
Returns a non-null, unmodifiable
Map
that contains the theClientBehavior
s that have been attached to the component implementing this interface. The keys in thisMap
are event names defined bygetEventNames()
.- Since:
- 2.0
-
getDefaultEventName
java.lang.String getDefaultEventName()
Returns the default event name for this
ClientBehaviorHolder
implementation. This must be one of the event names returned bygetEventNames()
or null if the component does not have a default event.- Since:
- 2.0
-
-