|
Richfaces UI Components UI 4.1.0.20110910-M2 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.richfaces.renderkit.util.RendererUtils
public final class RendererUtils
Util class for common render operations - render passthru html attributes, iterate over child components etc.
| Field Summary | |
|---|---|
static java.lang.String |
DUMMY_FORM_ID
|
| Constructor Summary | |
|---|---|
protected |
RendererUtils()
|
| Method Summary | |
|---|---|
protected java.lang.Object |
attributeValue(java.lang.String name,
java.lang.Object value)
Convert attribute value to proper object. |
java.lang.String |
clientId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
Simplified version of encodeId |
java.lang.String |
correctForIdReference(java.lang.String forAttr,
javax.faces.component.UIComponent component)
If target component contains generated id and for doesn't, correct for id |
java.util.Map<java.lang.String,java.lang.Object> |
createParametersMap(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
|
java.lang.Object |
createParameterValue(javax.faces.component.UIParameter parameter)
Returns value of the parameter. |
void |
encodeAttribute(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.Object property,
java.lang.String attributeName)
|
void |
encodeAttribute(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String attribute)
|
void |
encodeAttributes(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String attrs)
Encode attributes given by comma-separated string list. |
void |
encodeAttributesFromArray(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String[] attrs)
|
void |
encodeBeginForm(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
javax.faces.context.ResponseWriter writer,
java.lang.String clientId)
|
void |
encodeBeginFormIfNessesary(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
|
void |
encodeChildren(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
|
void |
encodeCustomId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
Encode id attribute with clientId component property. |
void |
encodeEndForm(javax.faces.context.FacesContext context,
javax.faces.context.ResponseWriter writer)
|
void |
encodeEndFormIfNessesary(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
|
void |
encodeId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
Encode id attribute with clientId component property |
void |
encodeId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String attribute)
Encode clientId to custom attribute ( for example, to control name ) |
void |
encodePassThru(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String defaultHtmlEvent)
Encode common pass-thru html attributes. |
void |
encodePassThruAttribute(javax.faces.context.FacesContext context,
java.util.Map<java.lang.String,java.lang.Object> attributes,
javax.faces.context.ResponseWriter writer,
java.lang.String attribute)
Encode one pass-thru attribute, with plain/boolean/url value, got from properly component attribute. |
void |
encodePassThruWithExclusions(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String exclusions,
java.lang.String defaultHtmlEvent)
Encode pass-through attributes except specified ones |
void |
encodePassThruWithExclusionsArray(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String[] exclusions,
java.lang.String defaultHtmlEvent)
|
java.lang.String |
encodePctOrPx(java.lang.String value)
formats given value to |
java.lang.String |
encodePx(java.lang.String value)
|
javax.faces.component.UIComponent |
findComponentFor(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String id)
|
javax.faces.component.UIComponent |
findComponentFor(javax.faces.component.UIComponent component,
java.lang.String id)
|
java.lang.String |
getActionUrl(javax.faces.context.FacesContext facesContext)
|
protected java.lang.Object |
getComponentAttributeName(java.lang.Object key)
Convert HTML attribute name to component property name. |
static RendererUtils |
getInstance()
Use this method to get singleton instance of RendererUtils |
javax.faces.component.UIComponent |
getNestingForm(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
Find nested form for given component |
boolean |
hasExplicitId(javax.faces.component.UIComponent component)
|
boolean |
isBooleanAttribute(javax.faces.component.UIComponent component,
java.lang.String name)
Get boolean value of logical attribute |
boolean |
isEmpty(java.lang.Object o)
Checks if the argument passed in is empty or not. |
void |
writeScript(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.Object script)
Wtrie JavaScript with start/end elements and type. |
static void |
writeState(javax.faces.context.FacesContext context)
Write state saving markers to context, include MyFaces view sequence. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String DUMMY_FORM_ID
| Constructor Detail |
|---|
protected RendererUtils()
| Method Detail |
|---|
public static RendererUtils getInstance()
public void encodeId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
throws java.io.IOException
context - component -
java.io.IOException
public void encodeId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String attribute)
throws java.io.IOException
context - component - attribute -
java.io.IOException
public void encodeCustomId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
throws java.io.IOException
context - component -
java.io.IOExceptionpublic java.lang.Object createParameterValue(javax.faces.component.UIParameter parameter)
JavaScriptParameter, NoEcape
attribute is applied.
parameter - instance of UIParameter
Object parameter value
public java.util.Map<java.lang.String,java.lang.Object> createParametersMap(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
public void encodePassThru(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String defaultHtmlEvent)
throws java.io.IOException
context - component -
java.io.IOException
public void encodePassThruWithExclusions(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String exclusions,
java.lang.String defaultHtmlEvent)
throws java.io.IOException
context - component - exclusions -
java.io.IOException
public void encodePassThruWithExclusionsArray(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String[] exclusions,
java.lang.String defaultHtmlEvent)
throws java.io.IOException
java.io.IOException
public void encodePassThruAttribute(javax.faces.context.FacesContext context,
java.util.Map<java.lang.String,java.lang.Object> attributes,
javax.faces.context.ResponseWriter writer,
java.lang.String attribute)
throws java.io.IOException
context - writer - attribute -
java.io.IOException
public void encodeAttributesFromArray(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String[] attrs)
throws java.io.IOException
java.io.IOException
public void encodeAttributes(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String attrs)
throws java.io.IOException
context - current JSF contextcomponent - for with render attributes valuesattrs - comma separated list of attributes
java.io.IOException
public void encodeAttribute(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.Object property,
java.lang.String attributeName)
throws java.io.IOException
context - component - property - attributeName -
java.io.IOException
public void encodeAttribute(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String attribute)
throws java.io.IOException
java.io.IOExceptionpublic boolean isEmpty(java.lang.Object o)
null
o - object to check for emptiness
true if the argument is empty, false otherwiseprotected java.lang.Object getComponentAttributeName(java.lang.Object key)
key -
protected java.lang.Object attributeValue(java.lang.String name,
java.lang.Object value)
name - attribute name.value -
public boolean isBooleanAttribute(javax.faces.component.UIComponent component,
java.lang.String name)
component - name - attribute name
public java.lang.String encodePx(java.lang.String value)
public java.lang.String encodePctOrPx(java.lang.String value)
value -
public javax.faces.component.UIComponent getNestingForm(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
component -
UIForm component, or null
public void encodeBeginFormIfNessesary(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
throws java.io.IOException
context - component -
java.io.IOException
public void encodeBeginForm(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
javax.faces.context.ResponseWriter writer,
java.lang.String clientId)
throws java.io.IOException
context - component - writer - clientId -
java.io.IOException
public void encodeEndFormIfNessesary(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
throws java.io.IOException
context - component -
java.io.IOException
public static void writeState(javax.faces.context.FacesContext context)
throws java.io.IOException
context -
java.io.IOException
public void encodeEndForm(javax.faces.context.FacesContext context,
javax.faces.context.ResponseWriter writer)
throws java.io.IOException
context - writer -
java.io.IOExceptionpublic java.lang.String getActionUrl(javax.faces.context.FacesContext facesContext)
facesContext -
public java.lang.String clientId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
encodeId
context - component -
public void writeScript(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.Object script)
throws java.io.IOException
context - component - script -
java.io.IOException
public java.lang.String correctForIdReference(java.lang.String forAttr,
javax.faces.component.UIComponent component)
forAttr - component -
public void encodeChildren(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
throws java.io.IOException
java.io.IOExceptionpublic boolean hasExplicitId(javax.faces.component.UIComponent component)
public javax.faces.component.UIComponent findComponentFor(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component,
java.lang.String id)
public javax.faces.component.UIComponent findComponentFor(javax.faces.component.UIComponent component,
java.lang.String id)
component - id -
|
Richfaces UI Components UI 4.1.0.20110910-M2 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||