org.springframework.extensions.webscripts.jsf
Class UIWebScript

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent
              org.springframework.extensions.webscripts.jsf.UIWebScript

All Implemented Interfaces:

javax.faces.component.StateHolder

public class UIWebScript
extends SelfRenderingComponent

JSF Component implementation for the WebScript component.

Responsible for generating a JSF Component specific WebScriptRuntime instance and executing the specified WebScript against the runtime.

Author:

Kevin Roast

Nested Class Summary

static class

UIWebScript.WebScriptEvent Class representing the clicking of a webscript url action.

Constructor Summary

UIWebScript()
Default constructor

Method Summary

void	broadcast(javax.faces.event.FacesEvent event)
void	decode(javax.faces.context.FacesContext context)
void	encodeBegin(javax.faces.context.FacesContext context)
Object	getContext()
String	getFamily()
String	getScriptUrl()
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
void	setContext(Object context)
void	setScriptUrl(String scriptUrl) Set the scriptUrl

Methods inherited from class org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

outputAttribute

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Constructor Detail

UIWebScript

public UIWebScript()

Default constructor

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

See Also:

UIComponent.getFamily()

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase

See Also:

StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

See Also:

StateHolder.saveState(javax.faces.context.FacesContext)

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

decode

public void decode(javax.faces.context.FacesContext context)

Overrides:

decode in class javax.faces.component.UIComponentBase

encodeBegin

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

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeBegin(javax.faces.context.FacesContext)

setScriptUrl

public void setScriptUrl(String scriptUrl)

Set the scriptUrl

Parameters:

scriptUrl - the scriptUrl

getScriptUrl

public String getScriptUrl()

Returns:

the scriptUrl

getContext

public Object getContext()

Returns:

the user defined script context object

setContext

public void setContext(Object context)

Parameters:

context - the user defined script context to set