When the ui:debug tag is placed in an XHTML
page, it creates a component and adds it to the
component tree. That debug component captures debugging information,
namely the current state of the component
tree and the scoped variables in the application, when the component
is rendered. If the user presses CTRL + SHIFT + d,
Faces opens a window that shows the debugging information captured by
the debug component.
Typically, the best place to put the ui:debug
tag is in an application's main template, which
lets developers enable or disable viewing of debugging information
in one central location. Additionally, page
authors can change the hotkey (which by default is CTRL + SHIFT + d,
where the d stands for debug) to CTRL + SHIFT + ?,
where ? represents the key specified as the value of the hotkey
attribute.
You can use the rendered attribute to
control whether the debug component is rendered.
Using an EL expression as the value for the rendered
attribute lets you control whether
debug output is enabled for multiple views based on a single bean
property.
Note ui:debug only works when the ProjectStage is set to Development.
| Name | Required | Type | Description |
|---|---|---|---|
hotkey | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
Defines a single character, that, pressed in conjunction with CTRL and SHIFT, will display the Faces debug window. By default, the hotkey is 'd'. The value for the hotkey attribute cannot be an EL expression. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
Controls whether the debug component is rendered. Valid values for this attribute are either the strings "true" or "false" or an EL expression that evaluates to either "true" or "false". If this attribute's value is "false" or the value is an EL expression that evaluates to "false", the debug component is not rendered in the page, the hotkey attribute is disregarded, and users cannot open the debugging information window with a hotkey. |