Events

Alpaca allows you to bind event handlers to containers and individual fields that are triggered either directly or via propagation.

Event handlers can be registered in the following ways:

• Configuration driven by specifying functions within Alpaca options
• Using the postRender method and calling on() for individual fields
• By extending Alpaca Field implementation classes

This document covers how to set these up.

Event Types

In general, event handlers are invoked with the this reference set to the field instance being handled. This lets you use this.getValue() to get the current value of the field and also gives you a way to access observables and traverse through to other fields in the hierarchy. The event object itself is also passed as an argument to event handlers so that you can control the lifecycle of the event before it makes its way through the DOM.

All event handlers are synchronous in nature (similar to actual DOM event handlers).

<!-- "mouseover" -->
<tr>
    <td>
        mouseover
    </td>
    <td>
        Field
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        The mouse moved over the dom element for a field
    </td>
</tr>

<!-- "mouseout" -->
<tr>
    <td>
        mouseout
    </td>
    <td>
        Field
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        The mouse moved out of the dom element for a field
    </td>
</tr>

<!-- "change" -->
<tr>
    <td>
        change
    </td>
    <td>
        ControlField
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        The value of the field changed
    </td>
</tr>

<!-- "focus" -->
<tr>
    <td>
        focus
    </td>
    <td>
        ControlField
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        The control field has received focus
    </td>
</tr>

<!-- "blur" -->
<tr>
    <td>
        blur
    </td>
    <td>
        ControlField
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        The control field has lost focus
    </td>
</tr>

<!-- "keypress" -->
<tr>
    <td>
        keypress
    </td>
    <td>
        ControlField
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        A key was pressed in the control field
    </td>
</tr>

<!-- "keydown" -->
<tr>
    <td>
        keydown
    </td>
    <td>
        ControlField
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        A key was pressed down in the control field
    </td>
</tr>

<!-- "keyup" -->
<tr>
    <td>
        keyup
    </td>
    <td>
        ControlField
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        A key was released in the control field
    </td>
</tr>

<!-- "click" -->
<tr>
    <td>
        click
    </td>
    <td>
        ControlField
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        The left mouse button was clicked in the control field
    </td>
</tr>

<!-- "move" -->
<tr>
    <td>
        move
    </td>
    <td>
        ContainerField
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        A child item was moved.
    </td>
</tr>

<!-- "add" -->
<tr>
    <td>
        add
    </td>
    <td>
        ContainerField
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        A child item was added.
    </td>
</tr>

<!-- "remove" -->
<tr>
    <td>
        remove
    </td>
    <td>
        ContainerField
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        A child item was removed.
    </td>
</tr>

<!-- "ready" -->
<tr>
    <td>
        ready
    </td>
    <td>
        Field
    </td>
    <td>
        <ul>
            <li>event</li>
        </ul>
    </td>
    <td>
        The DOM element backing the field was injected into the display.
    </td>
</tr>

Configuration Driven

For any field, you can specify an events sub-object that declares handlers by event name.

Here is an example where we register a whole set of event handlers for different kinds of events. These all dump out to console. Open up your dev tools to look at the console output.

Using the postRender callback

For any field, you can register an event handler by calling on for the field instance.

In this example, we register two event handlers.

• The first one listens for the change event on the title field.
• The second one listens for the change event on the top level container field.

Both get notified. When the child field changes its value, it changes the top field's value as well.

Extending Field implementation classes

You can extend the base field classes that Alpaca offers and register event handlers directly.