Package org.apache.myfaces.view.facelets.tag.ui

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

Fields

Modifier and Type	Field	Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_HOTKEY

Fields 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

Constructor	Description
UIDebug()

Method Summary

Modifier and Type	Method	Description
static boolean	debugRequest(FacesContext faces)
void	encodeBegin(FacesContext faces)
List<UIComponent>	getChildren()
String	getFamily()
String	getHotkey()	The hot key to use in combination with 'CTRL' + 'SHIFT' to launch the debug window.
String	getId()
void	setHotkey(String hotkey)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

DEFAULT_HOTKEY

public static final String DEFAULT_HOTKEY

See Also:

Constant Field Values

Constructor Detail

UIDebug

public UIDebug()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

getChildren

public List<UIComponent> getChildren()

Overrides:

getChildren in class UIComponentBase

encodeBegin

public void encodeBegin(FacesContext faces)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

debugRequest

public static boolean debugRequest(FacesContext faces)

getId

@JSFProperty(tagExcluded=true)
public String getId()

Overrides:

getId in 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:

setHotkey

public void setHotkey(String hotkey)