[ajax] List of <p:ajax> events

I've searched the Internet and I cannot find a list of <p:ajax> events. Can anyone provide a complete list of events for the <p:ajax> tag?

I'm particularly interested if there is an onblur event or something similar.

Unfortunatelly, Ajax events are poorly documented and I haven't found any comprehensive list. For example, User Guide v. 3.5 lists itemChange event for p:autoComplete, but forgets to mention change event.

If you want to find out which events are supported:

1. Download and unpack primefaces source jar
2. Find the JavaScript file, where your component is defined (for example, most form components such as SelectOneMenu are defined in forms.js)
3. Search for this.cfg.behaviors references

For example, this section is responsible for launching toggleSelect event in SelectCheckboxMenu component:

fireToggleSelectEvent: function(checked) {
    if(this.cfg.behaviors) {
        var toggleSelectBehavior = this.cfg.behaviors['toggleSelect'];

        if(toggleSelectBehavior) {
            var ext = {
                params: [{name: this.id + '_checked', value: checked}]
            }
        }

        toggleSelectBehavior.call(this, null, ext);
    }
},

I've got the list in debug mode; first I saw the point at which the error was thrown

javax.faces.view.facelets.TagException: /showcase/partial_submit.xhtml @26,36 Event:changed is not supported. org.primefaces.component.behavior.ajax.AjaxBehaviorHandler.applyAttachedObject(AjaxBehaviorHandler.java:179) org.primefaces.component.behavior.ajax.AjaxBehaviorHandler.apply(AjaxBehaviorHandler.java:157)

and then I debugged AjaxBehaviorHandler

so if you want discover the right list of supported event, you can generate an error (using an event name that is wrong), and follow this way

As the list of possible events is not tied to p:ajax itself but to the component it is used with, you'll have to ask the component for which ajax events it supports.

There are multiple ways to determine the ajax events for a given component:

1) Ask the component in xhtml:

You can output the list directly in xhtml by binding that component to a request scoped variable and printing the eventNames property:

<p:autoComplete binding="#{ac}"></p:autoComplete>
<h:outputText value="#{ac.eventNames}" />

This outputs

[blur, change, valueChange, click, dblclick, focus, keydown, keypress, keyup,
 mousedown, mousemove, mouseout, mouseover, mouseup, select, itemSelect,
 itemUnselect, query, moreText, clear]

2) Ask the component in java code:

Figure out the component implementation class and invoke its' implementation of javax.faces.component.UIComponentBase.getEventNames() method:

import javax.faces.component.UIComponentBase;

public class SomeTest {

    public static void main(String[] args) {
        dumpEvents(new org.primefaces.component.inputtext.InputText());
        dumpEvents(new org.primefaces.component.autocomplete.AutoComplete());
        dumpEvents(new org.primefaces.component.datatable.DataTable());
    }

    private static void dumpEvents(UIComponentBase comp) {
        System.out.println(
                comp + ":\n\tdefaultEvent: " + comp.getDefaultEventName() + ";\n\tEvents: " + comp.getEventNames());
    }

}

This outputs:

org.primefaces.component.inputtext.InputText@239963d8:
    defaultEvent: valueChange;
    Events: [blur, change, valueChange, click, dblclick, focus, keydown, keypress, keyup, mousedown, mousemove, mouseout, mouseover, mouseup, select]
org.primefaces.component.autocomplete.AutoComplete@72d818d1:
    defaultEvent: valueChange;
    Events: [blur, change, valueChange, click, dblclick, focus, keydown, keypress, keyup, mousedown, mousemove, mouseout, mouseover, mouseup, select, itemSelect, itemUnselect, query, moreText, clear]
org.primefaces.component.datatable.DataTable@614ddd49:
    defaultEvent: null;
    Events: [rowUnselect, colReorder, tap, rowEditInit, toggleSelect, cellEditInit, sort, rowToggle, cellEdit, rowSelectRadio, filter, cellEditCancel, rowSelect, contextMenu, taphold, rowReorder, colResize, rowUnselectCheckbox, rowDblselect, rowEdit, page, rowEditCancel, virtualScroll, rowSelectCheckbox]

3) 'rtfm' ;-)

Best option is to look into the documentation of the particular component in use as hopefully provided by the component developers, not limited to PrimeFaces btw. (p:ajax can be attached to any component providing ajax behaviors).

The advantage over previous suggestions is that the documentation not only provides the event names, but also enhanced description of the event potentially enriched with an event type class that can be caught by a listener.

For example the org.primefaces.event.SelectEvent in case of

<p:ajax event="itemSelect" listener="#{anyBean.onItemSelect}"/>

and listener method signature public void onItemSelect(SelectEvent) provides additional event contextual data.

Where there is no explicit list of ajax events on a compoment in the PrimeFaces documentation, the list of on* javascript callbacks can be used as events by removing the 'on' and using the remainder as an event name. The other answers in this question provides help on these plain dom events too.

Here's what I found during debug.

You might want to look at "JavaScript HTML DOM Events" for a general overview of events:

http://www.w3schools.com/jsref/dom_obj_event.asp

PrimeFaces is built on jQuery, so here's jQuery's "Events" documentation:

http://api.jquery.com/category/events/

http://api.jquery.com/category/events/form-events/

http://api.jquery.com/category/events/keyboard-events/

http://api.jquery.com/category/events/mouse-events/

http://api.jquery.com/category/events/browser-events/

Below, I've listed some of the more common events, with comments about where they can be used (taken from jQuery documentation).

Mouse Events

(Any HTML element can receive these events.)

click

dblclick

mousedown

mousemove

mouseover

mouseout

mouseup

Keyboard Events

(These events can be attached to any element, but the event is only sent to the element that has the focus. Focusable elements can vary between browsers, but form elements can always get focus so are reasonable candidates for these event types.)

keydown

keypress

keyup

Form Events

blur (In recent browsers, the domain of the event has been extended to include all element types.)

change (This event is limited to <input> elements, <textarea> boxes and <select> elements.)

focus (This event is implicitly applicable to a limited set of elements, such as form elements (<input>, <select>, etc.) and links (<a href>). In recent browser versions, the event can be extended to include all element types by explicitly setting the element's tabindex property. An element can gain focus via keyboard commands, such as the Tab key, or by mouse clicks on the element.)

select (This event is limited to <input type="text"> fields and <textarea> boxes.)

submit (It can only be attached to <form> elements.)

Schedule provides various ajax behavior events to respond user actions.

• "dateSelect" org.primefaces.event.SelectEvent When a date is selected.
• "eventSelect" org.primefaces.event.SelectEvent When an event is selected.
• "eventMove" org.primefaces.event.ScheduleEntryMoveEvent When an event is moved.
• "eventResize" org.primefaces.event.ScheduleEntryResizeEvent When an event is resized.
• "viewChange" org.primefaces.event.SelectEvent When a view is changed.
• "toggleSelect" org.primefaces.event.ToggleSelectEvent When toggle all checkbox changes
• "expand" org.primefaces.event.NodeExpandEvent When a node is expanded.
• "collapse" org.primefaces.event.NodeCollapseEvent When a node is collapsed.
• "select" org.primefaces.event.NodeSelectEvent When a node is selected.-
• "collapse" org.primefaces.event.NodeUnselectEvent When a node is unselected
• "expand org.primefaces.event.NodeExpandEvent When a node is expanded.
• "unselect" org.primefaces.event.NodeUnselectEvent When a node is unselected.
• "colResize" org.primefaces.event.ColumnResizeEvent When a column is resized
• "page" org.primefaces.event.data.PageEvent On pagination.
• "sort" org.primefaces.event.data.SortEvent When a column is sorted.
• "filter" org.primefaces.event.data.FilterEvent On filtering.
• "rowSelect" org.primefaces.event.SelectEvent When a row is being selected.
• "rowUnselect" org.primefaces.event.UnselectEvent When a row is being unselected.
• "rowEdit" org.primefaces.event.RowEditEvent When a row is edited.
• "rowEditInit" org.primefaces.event.RowEditEvent When a row switches to edit mode
• "rowEditCancel" org.primefaces.event.RowEditEvent When row edit is cancelled.
• "colResize" org.primefaces.event.ColumnResizeEvent When a column is being selected.
• "toggleSelect" org.primefaces.event.ToggleSelectEvent When header checkbox is toggled.
• "colReorder" - When columns are reordered.
• "rowSelectRadio" org.primefaces.event.SelectEvent Row selection with radio.
• "rowSelectCheckbox" org.primefaces.event.SelectEvent Row selection with checkbox.
• "rowUnselectCheckbox" org.primefaces.event.UnselectEvent Row unselection with checkbox.
• "rowDblselect" org.primefaces.event.SelectEvent Row selection with double click.
• "rowToggle" org.primefaces.event.ToggleEvent Row expand or collapse.
• "contextMenu" org.primefaces.event.SelectEvent ContextMenu display.
• "cellEdit" org.primefaces.event.CellEditEvent When a cell is edited.
• "rowReorder" org.primefaces.event.ReorderEvent On row reorder.

there is more in here https://www.primefaces.org/docs/guide/primefaces_user_guide_5_0.pdf