Class UIDebug
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
org.apache.myfaces.view.facelets.tag.ui.UIDebug
- All Implemented Interfaces:
PartialStateHolder
,StateHolder
,TransientStateHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
@JSFComponent(name="ui:debug")
@JSFJspProperty(name="binding",
tagExcluded=true)
public final class UIDebug
extends UIComponentBase
The debug tag will capture the component tree and variables when it is encoded,
storing the data for retrieval later. You may launch the debug window at any time
from your browser by pressing 'CTRL' + 'SHIFT' + 'D' (by default).
The debug tag doesn't need to be used with the facelet.DEVELOPMENT parameter.
The best place to put this tag is in your site's main template where it can be
enabled/disabled across your whole application.
If your application uses multiple windows, you might want to assign different
hot keys to each one.
- Version:
- $Id$
- Author:
- Jacob Hookom
-
Field Summary
FieldsFields inherited from class jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
debugRequest
(FacesContext faces) void
encodeBegin
(FacesContext faces) The hot key to use in combination with 'CTRL' + 'SHIFT' to launch the debug window.getId()
void
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
Methods inherited from class jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
Field Details
-
COMPONENT_TYPE
- See Also:
-
COMPONENT_FAMILY
- See Also:
-
DEFAULT_HOTKEY
- See Also:
-
-
Constructor Details
-
UIDebug
public UIDebug()
-
-
Method Details
-
getFamily
- Specified by:
getFamily
in classUIComponent
-
getChildren
- Overrides:
getChildren
in classUIComponentBase
-
encodeBegin
- Overrides:
encodeBegin
in classUIComponentBase
- Throws:
IOException
-
debugRequest
-
getId
- Overrides:
getId
in classUIComponentBase
-
getHotkey
The hot key to use in combination with 'CTRL' + 'SHIFT' to launch the debug window. By default, when the debug tag is used, you may launch the debug window with 'CTRL' + 'SHIFT' + 'D'. This value cannot be an EL expression.- Returns:
-
setHotkey
-