Create new RichFaces Documentation Jira issue

This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.orgCommunity Documentation

6.13.  < a4j:log >

The <a4j:log > component generates JavaScript for opening of the window with client-side debug information on an Ajax request.

Table 6.25. a4j : log attributes

Attribute NameDescription
bindingThe attribute takes a value-binding expression for a component property of a backing bean
dirDirection indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left)
heightHeight of pop-up. Default value is "600".
hotkeyKeyboard key for activate ( in combination with CTRL+SHIFT ) log window. Default value is "L"
idEvery component may have a unique id that is automatically created if omitted
langCode describing the language used in the generated markup for this component
levelLog level. The possible values are "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "ALL". Component sets level 'ALL' by default.
nameName of pop-up window. Default value is "LogWindow"
onclickHTML: a script expression; a pointer button is clicked
ondblclickHTML: a script expression; a pointer button is double-clicked
onkeydownHTML: a script expression; a key is pressed down
onkeypressHTML: a script expression; a key is pressed and released
onkeyupHTML: a script expression; a key is released
onmousedownHTML: script expression; a pointer button is pressed down
onmousemoveHTML: a script expression; a pointer is moved within
onmouseoutHTML: a script expression; a pointer is moved away
onmouseoverHTML: a script expression; a pointer is moved onto
onmouseupHTML: script expression; a pointer button is released
popupRenders log as pop-up window or as div element on the page. Default value is "true".
renderedIf "false", this component is not rendered
styleCSS style(s) is/are to be applied when this component is rendered
styleClassCorresponds to the HTML class attribute
titleAdvisory title information about markup elements generated for this component
widthWidth of pop-up. Default value is "800".

Table 6.26. Component identification parameters

NameValue
component-typeorg.ajax4jsf.Log
component-familyorg.ajax4jsf.Log
component-classorg.ajax4jsf.component.html.AjaxLog
renderer-typeorg.ajax4jsf.LogRenderer

To create the simplest variant on a page use the following syntax:


<a4j:log popup="false" level="ALL" style="width: 800px; height: 300px;"></a4j:log>

Then, in order to open a log window, press "CTRL+SHIFT+L" on a page with the component.

Example:

import org.ajax4jsf.component.html.AjaxLog;

...
AjaxLog myLog = new AjaxLog();
...

Usage of the appropriate component attributes could change a representation level of debug information as well as the hot key for a window opening.

The hot key could be changed with the "hotkey" attribute, where it's necessary to define one letter that together with "CTRL+SHIFT" opens a window.

The "level" attribute with several possible values ("FATAL", "ERROR", "WARN", "INFO", "ALL") could change a logging level.

The log could be generated not only in a new window, but also on the current page in a separate <div> , this is also controlled with the "popup" attribute on the component.

Example:


<a4j:log level="ALL" popup="false" width="400" height="200"/>

The component defined this way is decoded on a page as <div> inside a page, where all the information beginning with informational message is generated.

On the component LiveDemo page you can see the example of <a4j:log> usage and sources for the given example.