org.omnifaces.component.output

Class ResourceInclude

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.omnifaces.component.output.ResourceInclude

All Implemented Interfaces:

EventListener, PartialStateHolder, StateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class ResourceInclude
extends UIComponentBase

This component is used to catch the output from a JSP/Servlet resource and render it as output to the JSF writer. In effect, this allows you to include both Servlets and JSP pages in e.g. Facelets.

Author:

Arjan Tijms, Bauke Scholtz

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY The standard component family.
static String	COMPONENT_TYPE The component type.

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

Constructors

Constructor and Description
ResourceInclude()

Method Summary

Methods

Modifier and Type	Method and Description
void	encodeBegin(FacesContext context) Create a dispatcher for the resource given by the component's path attribute, catch its output and write it to the JSF response writer.
String	getFamily() Returns COMPONENT_FAMILY.
boolean	getRendersChildren() Returns true.

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, 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, initialStateMarked, 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 String COMPONENT_TYPE

The component type.

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

The standard component family.

See Also:

Constant Field Values

Constructor Detail

ResourceInclude

public ResourceInclude()

Method Detail

getFamily

public String getFamily()

Returns COMPONENT_FAMILY.

Specified by:

getFamily in class UIComponent

getRendersChildren

public boolean getRendersChildren()

Returns true.

Overrides:

getRendersChildren in class UIComponentBase

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Create a dispatcher for the resource given by the component's path attribute, catch its output and write it to the JSF response writer.

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException