Top Fields Constructors Methods
com.sun.faces.facelets.tag.ui

public final Class UIDebug

extends UIComponentBase
Class Inheritance
Imports
com.sun.faces.facelets.util.DevTools, .FastWriter, javax.faces.component.UIComponentBase, javax.faces.context.FacesContext, .ResponseWriter, javax.servlet.http.HttpServletResponse, java.io.IOException, java.util.ArrayList, .LinkedHashMap, .List, .Map

Author
Jacob Hookom

Field Summary

Modifier and TypeField and Description
public static final String
public static final String
public static final String
private String
private static final String
private static long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public static boolean
public void
encodeBegin(FacesContext
FacesContext for the response we are creating
facesContext
)

Overrides javax.faces.component.UIComponentBase.encodeBegin.

If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext.

private static String
public List<E>
getChildren()

Overrides javax.faces.component.UIComponentBase.getChildren.

Return a mutable List representing the child UIComponents associated with this component.

public String
getFamily()

Implements abstract javax.faces.component.UIComponent.getFamily.

Return the identifier of the component family to which this component belongs.

public String
public void
setHotkey(String hotkey)

private static String
Inherited from javax.faces.component.UIComponentBase:
addClientBehavioraddFacesListenerbroadcastclearInitialStatedecodeencodeChildrenencodeEndfindComponentgetAttributesgetChildCountgetClientBehaviorsgetClientIdgetDefaultEventNamegetEventNamesgetFacesContextgetFacesListenersgetFacetgetFacetCountgetFacetsgetFacetsAndChildrengetIdgetListenersForEventClassgetParentgetPassThroughAttributesgetRenderergetRendererTypegetRendersChildrengetValueBindinginvokeOnComponentisRenderedisTransientmarkInitialStateprocessDecodesprocessRestoreStateprocessSaveStateprocessUpdatesprocessValidatorsqueueEventremoveFacesListenerrestoreAttachedStaterestoreStatesaveAttachedStatesaveStatesetIdsetParentsetRenderedsetRendererTypesetTransientsetValueBindingsubscribeToEventunsubscribeFromEvent

Field Detail

COMPONENT_FAMILYback to summary
public static final String COMPONENT_FAMILY
COMPONENT_TYPEback to summary
public static final String COMPONENT_TYPE
DEFAULT_HOTKEYback to summary
public static final String DEFAULT_HOTKEY
hotkeyback to summary
private String hotkey
KEYback to summary
private static final String KEY
nextIdback to summary
private static long nextId

Constructor Detail

UIDebugback to summary
public UIDebug()

Method Detail

debugRequestback to summary
public static boolean debugRequest(FacesContext faces)
encodeBeginback to summary
public void encodeBegin(FacesContext facesContext) throws IOException

Overrides javax.faces.component.UIComponentBase.encodeBegin.

Doc from javax.faces.component.UIComponent.encodeBegin.

If our rendered property is true, render the beginning of the current state of this UIComponent to the response contained in the specified FacesContext. Call pushComponentToEL(javax.faces.context.FacesContext, javax.faces.component.UIComponent). Call javax.faces.application.Application#publishEvent, passing javax.faces.event.PreRenderComponentEvent.class as the first argument and the component instance to be rendered as the second argument.

If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer#encodeBegin(FacesContext, UIComponent).

If our rendered property is false, call pushComponentToEL(javax.faces.context.FacesContext, javax.faces.component.UIComponent) and return immediately.

Parameters
facesContext:FacesContext

FacesContext for the response we are creating

Annotations
@Override
Exceptions
IOException:
if an input/output error occurs while rendering
fetchDebugOutputback to summary
private static String fetchDebugOutput(FacesContext faces, String id)
getChildrenback to summary
public List<E> getChildren()

Overrides javax.faces.component.UIComponentBase.getChildren.

Doc from javax.faces.component.UIComponent.getChildren.

Return a mutable List representing the child UIComponents associated with this component. The returned implementation must support all of the standard and optional List methods, plus support the following additional requirements:

Returns:List<E>

the list of children.

Annotations
@Override
getFamilyback to summary
public String getFamily()

Implements abstract javax.faces.component.UIComponent.getFamily.

Doc from javax.faces.component.UIComponent.getFamily.

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance. Note this method should NOT return null

Returns:String

the component family (not null).

Annotations
@Override
getHotkeyback to summary
public String getHotkey()
setHotkeyback to summary
public void setHotkey(String hotkey)
writeDebugOutputback to summary
private static String writeDebugOutput(FacesContext faces) throws IOException