While learning JSF-2.2 with PrimeFaces 5.3 I came across javascript events handlers like the one used with onComplete attribute:

function handelSmptmSaveRequest(xhr, status, args) {
                            if (args.validationFailed) {
                                PF('smptmDlgWv').jq.effect("shake", {
                                    times : 5
                                }, 100);
                            } else {
                                PF('smptmDlgWv').hide();
                            }
                        }

I have multiple questions here:

1. What are the input variable xhr, status, args and where are they defined, and where do they get their values from?
2. Is this the only handler I need to use with jsf ponents events such as onBlur or onClick, and how can I learn them?
3. Is there any documentation for this? I came from Java SE where every thing is documented and explained, where to look for javascript documentations and how?

Edit1 This appears to be Ajax callbacks defined by PrimeFaces, and They're announced here /?p=830 but there is still a problem, though the PF showcase has some examples of usage, but I can't fine do documentation for these functions, I'm adding ajax tag for the question.

While learning JSF-2.2 with PrimeFaces 5.3 I came across javascript events handlers like the one used with onComplete attribute:

function handelSmptmSaveRequest(xhr, status, args) {
                            if (args.validationFailed) {
                                PF('smptmDlgWv').jq.effect("shake", {
                                    times : 5
                                }, 100);
                            } else {
                                PF('smptmDlgWv').hide();
                            }
                        }

I have multiple questions here:

1. What are the input variable xhr, status, args and where are they defined, and where do they get their values from?
2. Is this the only handler I need to use with jsf ponents events such as onBlur or onClick, and how can I learn them?
3. Is there any documentation for this? I came from Java SE where every thing is documented and explained, where to look for javascript documentations and how?

Edit1 This appears to be Ajax callbacks defined by PrimeFaces, and They're announced here http://blog.primefaces/?p=830 but there is still a problem, though the PF showcase has some examples of usage, but I can't fine do documentation for these functions, I'm adding ajax tag for the question.

• javascript
• ajax
• jsf
• primefaces

• 1 Please, one question per question. And regarding 1 (and 3): start by searching the PrimeFaces documentation for 'xhr'... – Kukeltje Commented Aug 25, 2016 at 8:17
• 1 @Kukeltje I found no documentation for this, maybe I'm not searching the right way, I hope some one with experience can show me the way. – alibttb Commented Aug 26, 2016 at 10:41
• It is worth starting with jQuery UI as PrimeFaces utilizes jQuery UI under the hood. – Tiny Commented Sep 16, 2016 at 8:56
• 1 This might answer some of your questions: blog.hatemalimam./intro-to-primefaces-widgetvar – Hatem Alimam Commented Sep 16, 2016 at 16:57
• There can be simply no documentation for this API if it is mostly used as internal. In this case parameter values and meaning can be figured out by debugging. You put a breakpoint inside the function and go up the stack trace to the origins of the call. At least this is how I would approach the issue. – Aleksandr Erokhin Commented Sep 19, 2016 at 6:40

1 Answer 1

Here is the PrimeFaces 5.3 documentation, in PDF form. (Here are docs for all versions.)

Page 536 documents the parameters for the onplete(xhr, status, args) function:

Javascript callback to process when ajax request pletes. Takes three arguments, xmlhttprequest, status string and optional arguments provided by RequestContext API.

XMLHttpRequest is the vanilla JS Object that we all know and love.

RequestContext is defined on page 588 of the PrimeFaces 5.3 documentation:

RequestContext is a simple utility that provides useful goodies such as adding parameters to ajax callback functions. RequestContext is available in both ajax and non-ajax requests.