org.primefaces.extensions.component.sheet

Class SheetRenderer

java.lang.Object

javax.faces.render.Renderer

org.primefaces.renderkit.CoreRenderer

org.primefaces.extensions.component.sheet.SheetRenderer

public class SheetRenderer
extends org.primefaces.renderkit.CoreRenderer

The Sheet renderer.

Since:

6.2

Author:

Mark Lassiter / Melloware

Field Summary

Fields inherited from class javax.faces.render.Renderer

PASSTHROUGH_RENDERER_LOCALNAME_KEY

Constructor Summary

Constructors

Constructor and Description
SheetRenderer()

Method Summary

Modifier and Type	Method and Description
void	decode(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Overrides decode and to parse the request parameters for the two hidden input fields: clientid_input: any new changes provided by the user clientid_selection: the user's cell selections These are JSON values and are parsed into our submitted values data on the Sheet component.
protected void	decodeBehaviors(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Decodes client behaviors (ajax events).
protected void	decodeFilters(javax.faces.context.FacesContext context, Sheet sheet, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String clientId) Decodes the filter values
void	encodeBegin(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Encodes the Sheet component
protected void	encodeColHeaders(javax.faces.context.FacesContext context, Sheet sheet, org.primefaces.util.WidgetBuilder wb) Encode the column headers
protected void	encodeColOptions(javax.faces.context.FacesContext context, Sheet sheet, org.primefaces.util.WidgetBuilder wb) Encode the column options
protected void	encodeData(javax.faces.context.FacesContext context, Sheet sheet, org.primefaces.util.WidgetBuilder wb) Encode the row data.
protected void	encodeFilterValues(javax.faces.context.FacesContext context, javax.faces.context.ResponseWriter responseWriter, Sheet sheet, java.lang.String clientId) Encodes the filter values.
protected void	encodeFilterVar(javax.faces.context.FacesContext context, Sheet sheet, org.primefaces.util.WidgetBuilder wb) Encodes a javascript filter var that informs the col header event of the column's filtering options.
protected void	encodeInvalidData(javax.faces.context.FacesContext context, Sheet sheet, org.primefaces.util.WidgetBuilder wb) Encodes the necessary JS to render invalid data.
protected void	encodeJavascript(javax.faces.context.FacesContext context, Sheet sheet, javax.faces.context.ResponseWriter responseWriter) Encodes the Javascript for the sheet.
protected void	encodeMarkup(javax.faces.context.FacesContext context, Sheet sheet, javax.faces.context.ResponseWriter responseWriter) Encodes the HTML markup for the sheet.
protected void	encodeOptionalAttr(org.primefaces.util.WidgetBuilder wb, java.lang.String attrName, java.lang.String value) Encodes an optional attribute to the widget builder specified.
protected void	encodeOptionalNativeAttr(org.primefaces.util.WidgetBuilder wb, java.lang.String attrName, java.lang.Object value) Encodes an optional native attribute (unquoted).
protected void	encodeRow(javax.faces.context.FacesContext context, java.lang.String rowKey, JavascriptVarBuilder vbData, JavascriptVarBuilder vbRowStyle, JavascriptVarBuilder vbStyle, JavascriptVarBuilder vbReadOnly, Sheet sheet, java.lang.Object data, int rowIndex) Encode a single row.
protected void	encodeSortVar(javax.faces.context.FacesContext context, Sheet sheet, org.primefaces.util.WidgetBuilder wb) Encodes a javascript sort var that informs the col header event of the column's sorting options.
protected void	endScript(javax.faces.context.ResponseWriter writer) Stop script element.
boolean	getRendersChildren() We render the columns (the children).
protected void	startScript(javax.faces.context.ResponseWriter writer, java.lang.String clientId) Start script element.

Methods inherited from class org.primefaces.renderkit.CoreRenderer

buildAjaxRequest, buildDomEvent, buildNonAjaxRequest, encodeClientBehaviors, escapeText, getEventBehaviors, getHighlighter, getResourceRequestPath, getResourceURL, getWidgetBuilder, isGrouped, isValueBlank, renderChild, renderChildren, renderDomEvent, renderDomEvents, renderDynamicPassThruAttributes, renderOnchange, renderOnclick, renderPassThruAttributes, renderPassThruAttributes, renderValidationMetadata, shouldRenderAttribute, shouldWriteId

Methods inherited from class javax.faces.render.Renderer

convertClientId, encodeChildren, encodeEnd, getConvertedValue

Methods inherited from class java.lang.Object

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

Constructor Detail

SheetRenderer

public SheetRenderer()

Method Detail

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context,
                        javax.faces.component.UIComponent component)
                 throws java.io.IOException

Encodes the Sheet component

Overrides:

encodeBegin in class javax.faces.render.Renderer

Throws:

java.io.IOException

encodeMarkup

protected void encodeMarkup(javax.faces.context.FacesContext context,
                            Sheet sheet,
                            javax.faces.context.ResponseWriter responseWriter)
                     throws java.io.IOException

Encodes the HTML markup for the sheet.

Parameters:

context -

sheet -

Throws:

java.io.IOException

encodeOptionalAttr

protected void encodeOptionalAttr(org.primefaces.util.WidgetBuilder wb,
                                  java.lang.String attrName,
                                  java.lang.String value)
                           throws java.io.IOException

Encodes an optional attribute to the widget builder specified.

Parameters:

wb - the WidgetBuilder to append to

attrName - the attribute name

value - the value

Throws:

java.io.IOException

encodeOptionalNativeAttr

protected void encodeOptionalNativeAttr(org.primefaces.util.WidgetBuilder wb,
                                        java.lang.String attrName,
                                        java.lang.Object value)
                                 throws java.io.IOException

Encodes an optional native attribute (unquoted).

Parameters:

wb - the WidgetBuilder to append to

attrName - the attribute name

value - the value

Throws:

java.io.IOException

encodeJavascript

protected void encodeJavascript(javax.faces.context.FacesContext context,
                                Sheet sheet,
                                javax.faces.context.ResponseWriter responseWriter)
                         throws java.io.IOException

Encodes the Javascript for the sheet.

Parameters:

context -

sheet -

Throws:

java.io.IOException

encodeInvalidData

protected void encodeInvalidData(javax.faces.context.FacesContext context,
                                 Sheet sheet,
                                 org.primefaces.util.WidgetBuilder wb)
                          throws java.io.IOException

Encodes the necessary JS to render invalid data.

Throws:

java.io.IOException

encodeColHeaders

protected void encodeColHeaders(javax.faces.context.FacesContext context,
                                Sheet sheet,
                                org.primefaces.util.WidgetBuilder wb)
                         throws java.io.IOException

Encode the column headers

Parameters:

context -

sheet -

wb -

Throws:

java.io.IOException

encodeColOptions

protected void encodeColOptions(javax.faces.context.FacesContext context,
                                Sheet sheet,
                                org.primefaces.util.WidgetBuilder wb)
                         throws java.io.IOException

Encode the column options

Parameters:

context -

sheet -

wb -

Throws:

java.io.IOException

encodeData

protected void encodeData(javax.faces.context.FacesContext context,
                          Sheet sheet,
                          org.primefaces.util.WidgetBuilder wb)
                   throws java.io.IOException

Encode the row data. Builds row data, style data and read only object. TODO figure out how to clean this up without having to iterate over data more than once and still keep it thread safe (no private member field use).

Parameters:

context -

sheet -

wb -

Throws:

java.io.IOException

encodeRow

protected void encodeRow(javax.faces.context.FacesContext context,
                         java.lang.String rowKey,
                         JavascriptVarBuilder vbData,
                         JavascriptVarBuilder vbRowStyle,
                         JavascriptVarBuilder vbStyle,
                         JavascriptVarBuilder vbReadOnly,
                         Sheet sheet,
                         java.lang.Object data,
                         int rowIndex)
                  throws java.io.IOException

Encode a single row.

Parameters:

context -

vbData -

vbRowStyle -

vbStyle -

vbReadOnly -

sheet -

data -

rowIndex -

Throws:

java.io.IOException

encodeFilterValues

protected void encodeFilterValues(javax.faces.context.FacesContext context,
                                  javax.faces.context.ResponseWriter responseWriter,
                                  Sheet sheet,
                                  java.lang.String clientId)
                           throws java.io.IOException

Encodes the filter values.

Parameters:

context -

responseWriter -

sheet -

Throws:

java.io.IOException

encodeFilterVar

protected void encodeFilterVar(javax.faces.context.FacesContext context,
                               Sheet sheet,
                               org.primefaces.util.WidgetBuilder wb)
                        throws java.io.IOException

Encodes a javascript filter var that informs the col header event of the column's filtering options. The var is an array in the form:

 ["false","true",["option 1", "option 2"]]
 

False indicates no filtering for the column. True indicates simple input text filter. Array of values indicates a drop down filter with the listed options.

Parameters:

context -

sheet -

wb -

Throws:

java.io.IOException

encodeSortVar

protected void encodeSortVar(javax.faces.context.FacesContext context,
                             Sheet sheet,
                             org.primefaces.util.WidgetBuilder wb)
                      throws java.io.IOException

Encodes a javascript sort var that informs the col header event of the column's sorting options. The var is an array of boolean indicating whether or not the column is sortable.

Parameters:

context -

sheet -

wb -

Throws:

java.io.IOException

decode

public void decode(javax.faces.context.FacesContext context,
                   javax.faces.component.UIComponent component)

Overrides decode and to parse the request parameters for the two hidden input fields:

• clientid_input: any new changes provided by the user
• clientid_selection: the user's cell selections

These are JSON values and are parsed into our submitted values data on the Sheet component.

Overrides:

decode in class javax.faces.render.Renderer

Parameters:

context -

decodeFilters

protected void decodeFilters(javax.faces.context.FacesContext context,
                             Sheet sheet,
                             java.util.Map<java.lang.String,java.lang.String> params,
                             java.lang.String clientId)

Decodes the filter values

Parameters:

context -

sheet -

params -

clientId -

decodeBehaviors

protected void decodeBehaviors(javax.faces.context.FacesContext context,
                               javax.faces.component.UIComponent component)

Decodes client behaviors (ajax events).

Overrides:

decodeBehaviors in class org.primefaces.renderkit.CoreRenderer

Parameters:

context - the FacesContext

component - the Component being decodes

startScript

protected void startScript(javax.faces.context.ResponseWriter writer,
                           java.lang.String clientId)
                    throws java.io.IOException

Start script element.

Overrides:

startScript in class org.primefaces.renderkit.CoreRenderer

Parameters:

writer -

clientId -

Throws:

java.io.IOException

endScript

protected void endScript(javax.faces.context.ResponseWriter writer)
                  throws java.io.IOException

Stop script element.

Overrides:

endScript in class org.primefaces.renderkit.CoreRenderer

Parameters:

writer -

Throws:

java.io.IOException

getRendersChildren

public boolean getRendersChildren()

We render the columns (the children).

Overrides:

getRendersChildren in class javax.faces.render.Renderer