org.apache.myfaces.view.facelets.tag.ui
Class UIDebug

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.apache.myfaces.view.facelets.tag.ui.UIDebug

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

@JSFComponent(name="ui:debug")
@JSFJspProperty(name="binding",
                tagExcluded=true)
public final class UIDebug
extends javax.faces.component.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: UIDebug.java,v 1.6 2008/07/13 19:01:41 rlubke Exp $

Author:

Jacob Hookom

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_HOTKEY

Fields inherited from class javax.faces.component.UIComponent

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

UIDebug()

Method Summary

static boolean	debugRequest(javax.faces.context.FacesContext faces)
void	encodeBegin(javax.faces.context.FacesContext faces)
java.util.List<javax.faces.component.UIComponent>	getChildren()
java.lang.String	getFamily()
java.lang.String	getHotkey() The hot key to use in combination with 'CTRL' + 'SHIFT' to launch the debug window.
java.lang.String	getId()
void	setHotkey(java.lang.String hotkey)

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree

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 java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

DEFAULT_HOTKEY

public static final java.lang.String DEFAULT_HOTKEY

See Also:

Constant Field Values

Constructor Detail

UIDebug

public UIDebug()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getChildren

public java.util.List<javax.faces.component.UIComponent> getChildren()

Overrides:

getChildren in class javax.faces.component.UIComponentBase

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext faces)
                 throws java.io.IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

java.io.IOException

debugRequest

public static boolean debugRequest(javax.faces.context.FacesContext faces)

getId

@JSFProperty(tagExcluded=true)
public java.lang.String getId()

Overrides:

getId in class javax.faces.component.UIComponentBase

getHotkey

@JSFProperty
public java.lang.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(java.lang.String hotkey)