org.omnifaces.component.output
Class ResourceInclude

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by org.omnifaces.component.output.OutputFamily
              extended by org.omnifaces.component.output.ResourceInclude
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

public class ResourceInclude
extends OutputFamily

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
static java.lang.String COMPONENT_TYPE
          The component type.
 
Fields inherited from class org.omnifaces.component.output.OutputFamily
COMPONENT_FAMILY
 
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
ResourceInclude()
           
 
Method Summary
 void encodeBegin(javax.faces.context.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.
 
Methods inherited from class org.omnifaces.component.output.OutputFamily
getFamily, getRendersChildren
 
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 java.lang.String COMPONENT_TYPE
The component type.

See Also:
Constant Field Values
Constructor Detail

ResourceInclude

public ResourceInclude()
Method Detail

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.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 javax.faces.component.UIComponentBase
Throws:
java.io.IOException