org.sakaiproject.jsf.util

Class RendererUtil

java.lang.Object

org.sakaiproject.jsf.util.RendererUtil

public class RendererUtil
extends Object

Common static utility methods that help in implementing JSF tags.

Method Summary

Modifier and Type	Method and Description
static void	encodeRecursive(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Helper method for recursively encoding a component.
static Object	getAttribute(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String name) Return the attribute value - handles getting the value from a ValueBinding if necessary.
static Object	getDefaultedAttribute(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String name, Object defaultValue) Same as getAttribute, but if not found, we return a default value.
static String	getFormId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Return the form ID of the form containing the given component
static boolean	isDisabledOrReadonly(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) If renderer supports disabled or readonly attributes use this method to obtain an early exit from decode method.
static String	makeSwitchString(String rawSwitch, boolean supportOnOff, boolean supportTrueFalse, boolean supportYesNo, boolean returnOnOff, boolean returnYesNo, boolean defaultValue) Switch handling utility.
static Map	mapComponentAttributes(Collection collection, javax.faces.component.UIComponent component) Get a Map of String key/value pairs from a UIComponent for all attributes keys in a collection
static Map	mapComponentAttributes(String[] attributeNames, javax.faces.component.UIComponent component) Get String key/value pairs from a UIComponent for all attributes keys in an array
static void	renderMenu(javax.faces.context.ResponseWriter out, List items, int selected, String clientId, String styleClass, javax.faces.component.UIComponent component) Given a List of SelectItems render the select options
static void	setAttribute(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, String name, Object value) Sets component attribute value - if a ValueBinding exists for that attribute, set through the binding; otherwise, set the value directly on the component.
static void	writeAttr(Writer inWriter, String inAttr, String inAttrValue)
static void	writeAttributes(Map attributeMap, javax.faces.context.FacesContext context)
static void	writeAttributes(Map attributeMap, javax.faces.context.ResponseWriter writer)
static void	writeExternalCSSDependencies(javax.faces.context.FacesContext context, javax.faces.context.ResponseWriter writer, String key, String path)
static void	writeExternalJSDependencies(javax.faces.context.FacesContext context, javax.faces.context.ResponseWriter writer, String key, String path)
static void	writePassthroughAttributes(String[] passthrus, boolean writeNullAttrs, javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) write passthough attributes on the current element
static void	writePassthroughs(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Write default HTML passthrough attributes
static void	writeSmartExternalScripts(javax.faces.context.FacesContext context, String gateKey, String gateValue, String contextBasePath, String[] scriptPaths) Renders a script that includes an external JavaScript that gets added to the document through a document.write() if a gatekeeper value is NOT set.
static void	writeSmartExternalScripts(javax.faces.context.ResponseWriter writer, String gateKey, String gateValue, String contextBasePath, String[] scriptPaths) Renders a script that includes an external JavaScript that gets added to the document through a document.write() if a gatekeeper value is NOT set.

Methods inherited from class java.lang.Object

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

Method Detail

setAttribute

public static void setAttribute(javax.faces.context.FacesContext context,
                                javax.faces.component.UIComponent component,
                                String name,
                                Object value)

Sets component attribute value - if a ValueBinding exists for that attribute, set through the binding; otherwise, set the value directly on the component.

getAttribute

public static Object getAttribute(javax.faces.context.FacesContext context,
                                  javax.faces.component.UIComponent component,
                                  String name)

Return the attribute value - handles getting the value from a ValueBinding if necessary. This is necessary because of a difference in the Sun JSF RI versus the MyFaces RI. The Sun RI component.getAttributes().get(attrName) will automatically return value bindings, whereas the MyFaces implmentation requires getting values from ValueBinding seperately.

getDefaultedAttribute

public static Object getDefaultedAttribute(javax.faces.context.FacesContext context,
                                           javax.faces.component.UIComponent component,
                                           String name,
                                           Object defaultValue)

Same as getAttribute, but if not found, we return a default value.

encodeRecursive

public static void encodeRecursive(javax.faces.context.FacesContext context,
                                   javax.faces.component.UIComponent component)
                            throws IOException

Helper method for recursively encoding a component.

Parameters:

context - the given FacesContext

component - the UIComponent to render

Throws:

IOException

isDisabledOrReadonly

public static boolean isDisabledOrReadonly(javax.faces.context.FacesContext context,
                                           javax.faces.component.UIComponent component)

If renderer supports disabled or readonly attributes use this method to obtain an early exit from decode method. Good idea to include it anyway, compnent will continue to work when these properties are added.

writePassthroughs

public static void writePassthroughs(javax.faces.context.FacesContext context,
                                     javax.faces.component.UIComponent component)
                              throws IOException

Write default HTML passthrough attributes

Throws:

IOException

writePassthroughAttributes

public static void writePassthroughAttributes(String[] passthrus,
                                              boolean writeNullAttrs,
                                              javax.faces.context.FacesContext context,
                                              javax.faces.component.UIComponent component)
                                       throws IOException

write passthough attributes on the current element

Throws:

IOException

writeAttributes

public static void writeAttributes(Map attributeMap,
                                   javax.faces.context.ResponseWriter writer)
                            throws IOException

Parameters:

attributeMap - String key/value pairs

writer - response writer

Throws:

IOException

writeAttributes

public static void writeAttributes(Map attributeMap,
                                   javax.faces.context.FacesContext context)
                            throws IOException

Parameters:

attributeMap - String key/value pairs

context - Faces context

component - the UIComponent

Throws:

IOException

writeSmartExternalScripts

public static void writeSmartExternalScripts(javax.faces.context.FacesContext context,
                                             String gateKey,
                                             String gateValue,
                                             String contextBasePath,
                                             String[] scriptPaths)
                                      throws IOException

Renders a script that includes an external JavaScript that gets added to the document through a document.write() if a gatekeeper value is NOT set. This effectively makes the script inclusion a per request JavaScript singleton.

Parameters:

gateKey - for key value pair

gateValue - value for key value pair for gatekeeper

contextBasePath - the web app with the script

scriptPath - the webapp-relative path

Throws:

IOException

writeSmartExternalScripts

public static void writeSmartExternalScripts(javax.faces.context.ResponseWriter writer,
                                             String gateKey,
                                             String gateValue,
                                             String contextBasePath,
                                             String[] scriptPaths)
                                      throws IOException

Renders a script that includes an external JavaScript that gets added to the document through a document.write() if a gatekeeper value is NOT set. This effectively makes the script inclusion a per request JavaScript singleton.

Parameters:

writer - the ResponseWriter

gateKey - for key value pair

gateValue - value for key value pair for gatekeeper

contextBasePath - the web app with the script

scriptPath - the webapp-relative path

Throws:

IOException

mapComponentAttributes

public static Map mapComponentAttributes(Collection collection,
                                         javax.faces.component.UIComponent component)

Get a Map of String key/value pairs from a UIComponent for all attributes keys in a collection

Parameters:

collection -

component -

Returns:

Map of String key/value pairs from a UIComponent for all keys in a collection

mapComponentAttributes

public static Map mapComponentAttributes(String[] attributeNames,
                                         javax.faces.component.UIComponent component)

Get String key/value pairs from a UIComponent for all attributes keys in an array

Parameters:

attributeNames -

component -

Returns:

Map of String key/value pairs from a UIComponent for all keys in a collection

makeSwitchString

public static String makeSwitchString(String rawSwitch,
                                      boolean supportOnOff,
                                      boolean supportTrueFalse,
                                      boolean supportYesNo,
                                      boolean returnOnOff,
                                      boolean returnYesNo,
                                      boolean defaultValue)

Switch handling utility.

Parameters:

rawSwitch - String input string

supportOnOff - boolean can input string be on, off?

supportTrueFalse - boolean can input string be true, false?

supportYesNo - boolean can input string be yes, no?

returnOnOff - boolean output on, off instead of true false

returnYesNo - boolean output yes, no instead of true false

defaultValue - boolean if unknown, return true or false?

Returns:

String raw swrich sring translated to correct switch value or default

renderMenu

public static void renderMenu(javax.faces.context.ResponseWriter out,
                              List items,
                              int selected,
                              String clientId,
                              String styleClass,
                              javax.faces.component.UIComponent component)
                       throws IOException

Given a List of SelectItems render the select options

Parameters:

out -

items - List of SelectItems

selected - seelcted choice

clientId - the id

styleClass - the optional style class

component - the component being rendered

Throws:

IOException

getFormId

public static String getFormId(javax.faces.context.FacesContext context,
                               javax.faces.component.UIComponent component)

Return the form ID of the form containing the given component

writeExternalJSDependencies

public static void writeExternalJSDependencies(javax.faces.context.FacesContext context,
                                               javax.faces.context.ResponseWriter writer,
                                               String key,
                                               String path)
                                        throws IOException

Parameters:

context - FacesContext for the request we are processing

writer - ResponseWriter to be used

key - key to use to look up the value in the request

path - path to the file

Throws:

IOException - if an input/output error occurs while rendering

writeExternalCSSDependencies

public static void writeExternalCSSDependencies(javax.faces.context.FacesContext context,
                                                javax.faces.context.ResponseWriter writer,
                                                String key,
                                                String path)
                                         throws IOException

Parameters:

context - FacesContext for the request we are processing

writer - ResponseWriter to be used

key - key to use to look up the value in the request

path - path to the file

Throws:

IOException - if an input/output error occurs while rendering

writeAttr

public static void writeAttr(Writer inWriter,
                             String inAttr,
                             String inAttrValue)
                      throws IOException

Throws:

IOException