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 UIComponentBaseThe 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 SummaryFields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPEstatic StringDEFAULT_HOTKEY- 
Fields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
 
- 
 - 
Constructor SummaryConstructors Constructor Description UIDebug()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static booleandebugRequest(FacesContext faces)voidencodeBegin(FacesContext faces)List<UIComponent>getChildren()StringgetFamily()StringgetHotkey()The hot key to use in combination with 'CTRL' + 'SHIFT' to launch the debug window.StringgetId()voidsetHotkey(String hotkey)- 
Methods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, 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.UIComponentgetClientId, 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 Detail- 
COMPONENT_TYPEpublic static final String COMPONENT_TYPE - See Also:
- Constant Field Values
 
 - 
COMPONENT_FAMILYpublic static final String COMPONENT_FAMILY - See Also:
- Constant Field Values
 
 - 
DEFAULT_HOTKEYpublic static final String DEFAULT_HOTKEY - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getFamilypublic String getFamily() - Specified by:
- getFamilyin class- UIComponent
 
 - 
getChildrenpublic List<UIComponent> getChildren() - Overrides:
- getChildrenin class- UIComponentBase
 
 - 
encodeBeginpublic void encodeBegin(FacesContext faces) throws IOException - Overrides:
- encodeBeginin class- UIComponentBase
- Throws:
- IOException
 
 - 
debugRequestpublic static boolean debugRequest(FacesContext faces) 
 - 
getId@JSFProperty(tagExcluded=true) public String getId() - Overrides:
- getIdin class- UIComponentBase
 
 - 
getHotkey@JSFProperty public String 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:
 
 - 
setHotkeypublic void setHotkey(String hotkey) 
 
- 
 
-