...
A component may declare as part of its options
structure, a top-level structure named events
whose keys correspond to event types that this component wishes to support, and whose values are either null
or the string values "unicast"
or "preventable"
corresponding to the accepted arguments for getEventFirer
. As part of the normal construction process of fluid.initView()
, the top-level that
object for the component will automatically have constructed a corresponding event firer object for each one of these events.
For example, the events
section of the default options for the Reorderer component indicates that the Reorderer supports 6 events of the listed types, of which one, onBeginMove
represents a "preventable" event - a listener may countermand the beginMove effect by returning true
when the event is received. If the top-level that
constructed by fluid.initView()
is stored in a variable named thatReorderer
, these events and firers will be accessible at its top level by making a call for example of the form thatReorderer.onSelect.fire(item)
.
...
Both as part of defaults, and also as supplied instantion options, a fluid components also component can accept a structure named listeners
, whose keys are taken from the set listed in the events
structure above, and whose values are either single listeners or arrays of listeners. For example, the following structure as part of an options object:
Code Block | ||||
---|---|---|---|---|
| ||||
listeners: { onMove: function(item, requestedPosition) { fluid.moduleLayout.updateLayout(item, requestedPosition.element, requestedPosition.position, layout); } } |
represents indicates that the literally supplied listener should be registered for the event onMove
.
...