org.primefaces.extensions.component.sheet

Class Sheet

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.primefaces.extensions.component.sheet.Sheet

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.primefaces.component.api.Widget

public class Sheet
extends javax.faces.component.UIInput
implements javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, org.primefaces.component.api.Widget

Spreadsheet component wrappering the Handsontable jQuery UI component.

Since:

6.2

Author:

Mark Lassiter / Melloware

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	EVENT_CELL_SELECT
static java.lang.String	EVENT_CHANGE
static java.lang.String	EVENT_COLUMN_SELECT
static java.lang.String	EVENT_FILTER
static java.lang.String	EVENT_ROW_SELECT
static java.lang.String	EVENT_SORT

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
Sheet() Default constructor

Method Summary

Modifier and Type	Method and Description
protected void	appendUpdateEvent(java.lang.Object rowKey, int colIndex, java.lang.Object rowData, java.lang.Object oldValue, java.lang.Object newValue) Appends an update event
void	commitUpdates() Invoke this method to commit the most recent set of ajax updates and restart the tracking of changes.
protected org.primefaces.model.SortOrder	convertSortOrder() Convert to PF SortOrder enum since we are leveraging PF sorting code.
java.util.List<SheetColumn>	getColumns() The list of child columns.
java.lang.String	getCurrentColClass() The col style class to use for the selected col
java.lang.String	getCurrentRowClass() The row style class to use for the selected row
java.lang.String	getDefaultEventName()
java.lang.String	getEmptyMessage() The emptyMessage value.
java.lang.String	getErrorMessage() The error message to display when the sheet is in error.
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.Integer	getFixedCols() The fixed column count.
java.lang.Integer	getFixedRows() The fixed row count
java.lang.String	getFocusId() The focusId value.
java.lang.Integer	getHeight() The height of the sheet.
java.lang.String	getInvalidDataValue() Generates the bad data var value for this sheet.
java.util.List<SheetInvalidUpdate>	getInvalidUpdates() The list of invalid updates
java.lang.Object	getLocalValue(java.lang.String rowKey, int col) Retrieves the submitted value for the rowKey and col.
int	getMappedColumn(int renderIdx) Maps the rendered column index to the real column index.
int	getRenderIndexFromRealIdx(int realIdx) Provides the render column index based on the real index
java.lang.String	getRenderValueForCell(javax.faces.context.FacesContext context, java.lang.String rowKey, int col) Gets the render string for the value the given cell.
int	getRowCount() The number of rows in the value list.
protected java.lang.Object	getRowKeyValue(javax.faces.context.FacesContext context) Gets the rowKey for the current row
protected java.lang.String	getRowKeyValueAsString(javax.faces.context.FacesContext context) Gets the row key value as a string for the current row var.
protected java.lang.String	getRowKeyValueAsString(java.lang.Object key) Gets the row key value as a String suitable for use in javascript rendering.
java.lang.String	getRowStyleClass() The row style class to apply to each row
java.lang.Integer	getSelectedColumn() The currently selected column.
java.lang.Integer	getSelectedLastColumn() The currently selected column.
java.lang.Integer	getSelectedLastRow() The currently selected row.
java.lang.Integer	getSelectedRow() The currently selected row.
java.lang.String	getSelection() The selection value.
javax.el.ValueExpression	getSortByValueExpression() The current sortBy value expression in use.
int	getSortColRenderIndex() Gets the rendered col index of the column corresponding to the current sortBy.
java.util.List<java.lang.Object>	getSortedValues() The sorted list of values.
java.lang.String	getSortOrder() The sort direction
java.lang.String	getStretchH() The handsontable stretchH value.
java.lang.String	getStyleClass() The user's custom style class to be added to the div container for the sheet.
java.lang.Object	getSubmittedValue()
java.lang.String	getSubmittedValue(java.lang.String rowKey, int col) Retrieves the submitted value for the row and col.
java.util.List<SheetUpdate>	getUpdates() A list of updates from the last submission or ajax event.
java.lang.Object	getValue() Return the value of the Sheet.
java.lang.Object	getValueForCell(javax.faces.context.FacesContext context, java.lang.String rowKey, int col) Gets the object value of the row and col specified.
java.lang.String	getVar() Return the request-scope attribute under which the data object for the current row will be exposed when iterating.
java.lang.Integer	getWidth() The width of the sheet in pixels
boolean	isHasStyledCells() Returns true if any of the columns contain conditional styling.
java.lang.Boolean	isShowColumnHeaders() Flag indicating whether or not column headers are visible
java.lang.Boolean	isShowRowHeaders() The ShowRowHeaders flag
protected boolean	matchesFilter(java.lang.Object obj) Evaluates the specified item value against the column filters and if they match, returns true, otherwise false.
void	processValidators(javax.faces.context.FacesContext context)
protected void	reMapRows() Remaps the row keys to the sorted and filtered list.
protected void	renderBadUpdateScript(javax.faces.context.FacesContext context) Adds eval scripts to update the bad data array in the sheet to render validation failures produced by the most recent ajax update attempt.
protected void	renderRowUpdateScript(javax.faces.context.FacesContext context, java.util.Set<java.lang.String> dirtyRows) Adds eval scripts to the ajax response to update the rows dirtied by the most recent successful update request.
void	reset() Resets all filters, sorting and submitted values.
void	resetInvalidUpdates() Resets invalid updates
void	resetSort() Resets the sorting to the originally specified values (if any)
void	resetSubmitted() Resets the submitted values
java.lang.String	resolveWidgetVar()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state) Restores the state for the submitted, local and bad values.
java.lang.Object	saveState(javax.faces.context.FacesContext context) Saves the state of the submitted and local values and the bad updates.
void	setColumns(java.util.List<SheetColumn> columns) Updates the list of child columns.
void	setCurrentColClass(java.lang.String styleClass) Update the current row style class
void	setCurrentRowClass(java.lang.String styleClass) Update the current row style class
void	setEmptyMessage(java.lang.String value) Update the emptyMessage value for the component
void	setErrorMessage(java.lang.String value) Updates the errorMessage value.
void	setFixedCols(java.lang.Integer value) Updates the fixed columns count.
void	setFixedRows(java.lang.Integer value) Updates the fixed row count.
void	setFocusId(java.lang.String focusId) Updates the focusId value.
void	setHeight(java.lang.Integer value) Updates the height
void	setLocalValue(java.lang.String rowKey, int col, java.lang.Object value) Updates a local value.
void	setRowStyleClass(java.lang.String styleClass) Update the current row style class to apply to the row
void	setRowVar(javax.faces.context.FacesContext context, java.lang.String rowKey) Updates the row var for iterations over the list.
void	setSelectedColumn(java.lang.Integer col) Updates the selected column.
void	setSelectedLastColumn(java.lang.Integer col) Updates the selected column.
void	setSelectedLastRow(java.lang.Integer row) Updates the selected row.
void	setSelectedRow(java.lang.Integer row) Updates the selected row.
void	setSelection(java.lang.String selection) Updates the selection value.
void	setShowColumnHeaders(java.lang.Boolean value) Update the ShowColumnheaders
void	setShowRowHeaders(java.lang.Boolean value) Update the ShowRowHeaders value.
void	setSortByValueExpression(javax.el.ValueExpression sortBy) Update the sort field
void	setSortOrder(java.lang.String sortOrder) Update the sort direction
void	setStretchH(java.lang.String value) Update the stretcH value for the component
void	setStyleClass(java.lang.String styleClass) Update's the user's custom style class to be added to the div container for the sheet.
void	setSubmittedValue(javax.faces.context.FacesContext context, java.lang.String rowKey, int col, java.lang.String value) Updates a submitted value.
void	setSubmittedValue(java.lang.Object submittedValue)
void	setValue(java.lang.Object value) Set the value of the Sheet.
void	setVar(java.lang.String var) Set the request-scope attribute under which the data object for the current row wil be exposed when iterating.
void	setWidth(java.lang.Integer value) Updates the width
void	sortAndFilter() Sorts and filters the data
void	updateColumnMappings() Updates the column mappings based on the rendered attribute
void	updateModel(javax.faces.context.FacesContext context) Override to update model with local values.
void	validate(javax.faces.context.FacesContext context) Converts each submitted value into a local value and stores it back in the hash.

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setValid, setValidator, setValidatorMessage, setValueChangeListener, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from interface javax.faces.component.EditableValueHolder

addValidator, addValueChangeListener, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, removeValidator, removeValueChangeListener, resetValue, setImmediate, setLocalValueSet, setRequired, setValid, setValidator, setValueChangeListener

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

EVENT_CELL_SELECT

public static final java.lang.String EVENT_CELL_SELECT

See Also:

Constant Field Values

EVENT_CHANGE

public static final java.lang.String EVENT_CHANGE

See Also:

Constant Field Values

EVENT_SORT

public static final java.lang.String EVENT_SORT

See Also:

Constant Field Values

EVENT_FILTER

public static final java.lang.String EVENT_FILTER

See Also:

Constant Field Values

EVENT_COLUMN_SELECT

public static final java.lang.String EVENT_COLUMN_SELECT

See Also:

Constant Field Values

EVENT_ROW_SELECT

public static final java.lang.String EVENT_ROW_SELECT

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

Sheet

public Sheet()

Default constructor

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

resolveWidgetVar

public java.lang.String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface org.primefaces.component.api.Widget

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Update's the user's custom style class to be added to the div container for the sheet.

Parameters:

styleClass -

getStyleClass

public java.lang.String getStyleClass()

The user's custom style class to be added to the div container for the sheet.

setStretchH

public void setStretchH(java.lang.String value)

Update the stretcH value for the component

Parameters:

value -

getStretchH

public java.lang.String getStretchH()

The handsontable stretchH value.

Returns:

the stretchH value

setEmptyMessage

public void setEmptyMessage(java.lang.String value)

Update the emptyMessage value for the component

Parameters:

value -

getEmptyMessage

public java.lang.String getEmptyMessage()

The emptyMessage value.

Returns:

the emptyMessage value

setCurrentColClass

public void setCurrentColClass(java.lang.String styleClass)

Update the current row style class

Parameters:

styleClass -

getCurrentColClass

public java.lang.String getCurrentColClass()

The col style class to use for the selected col

Parameters:

styleClass -

setCurrentRowClass

public void setCurrentRowClass(java.lang.String styleClass)

Update the current row style class

Parameters:

styleClass -

getCurrentRowClass

public java.lang.String getCurrentRowClass()

The row style class to use for the selected row

Parameters:

styleClass -

setRowStyleClass

public void setRowStyleClass(java.lang.String styleClass)

Update the current row style class to apply to the row

Parameters:

styleClass -

getRowStyleClass

public java.lang.String getRowStyleClass()

The row style class to apply to each row

Parameters:

styleClass -

setShowColumnHeaders

public void setShowColumnHeaders(java.lang.Boolean value)

Update the ShowColumnheaders

Parameters:

value -

isShowColumnHeaders

public java.lang.Boolean isShowColumnHeaders()

Flag indicating whether or not column headers are visible

Returns:

setShowRowHeaders

public void setShowRowHeaders(java.lang.Boolean value)

Update the ShowRowHeaders value.

Parameters:

value -

isShowRowHeaders

public java.lang.Boolean isShowRowHeaders()

The ShowRowHeaders flag

Returns:

getColumns

public java.util.List<SheetColumn> getColumns()

The list of child columns.

Returns:

setColumns

public void setColumns(java.util.List<SheetColumn> columns)

Updates the list of child columns.

Parameters:

columns -

setFixedRows

public void setFixedRows(java.lang.Integer value)

Updates the fixed row count.

Parameters:

value -

getFixedRows

public java.lang.Integer getFixedRows()

The fixed row count

Returns:

setFixedCols

public void setFixedCols(java.lang.Integer value)

Updates the fixed columns count.

Parameters:

value -

getFixedCols

public java.lang.Integer getFixedCols()

The fixed column count.

Returns:

getInvalidUpdates

public java.util.List<SheetInvalidUpdate> getInvalidUpdates()

The list of invalid updates

Returns:

List

resetSubmitted

public void resetSubmitted()

Resets the submitted values

resetSort

public void resetSort()

Resets the sorting to the originally specified values (if any)

resetInvalidUpdates

public void resetInvalidUpdates()

Resets invalid updates

reset

public void reset()

Resets all filters, sorting and submitted values.

setSubmittedValue

public void setSubmittedValue(javax.faces.context.FacesContext context,
                              java.lang.String rowKey,
                              int col,
                              java.lang.String value)

Updates a submitted value.

Parameters:

row -

col -

value -

getSubmittedValue

public java.lang.String getSubmittedValue(java.lang.String rowKey,
                                          int col)

Retrieves the submitted value for the row and col.

Parameters:

row -

col -

Returns:

setLocalValue

public void setLocalValue(java.lang.String rowKey,
                          int col,
                          java.lang.Object value)

Updates a local value.

Parameters:

rowKey -

col -

value -

getLocalValue

public java.lang.Object getLocalValue(java.lang.String rowKey,
                                      int col)

Retrieves the submitted value for the rowKey and col.

Parameters:

row -

col -

Returns:

setRowVar

public void setRowVar(javax.faces.context.FacesContext context,
                      java.lang.String rowKey)

Updates the row var for iterations over the list. The var value will be updated to the value for the specified rowKey.

Parameters:

context - the FacesContext against which to the row var is set. Passed for performance

rowKey - the rowKey string

getValueForCell

public java.lang.Object getValueForCell(javax.faces.context.FacesContext context,
                                        java.lang.String rowKey,
                                        int col)

Gets the object value of the row and col specified. If a local value exists, that is returned, otherwise the actual value is return.

Parameters:

context -

rowKey -

col -

Returns:

getRenderValueForCell

public java.lang.String getRenderValueForCell(javax.faces.context.FacesContext context,
                                              java.lang.String rowKey,
                                              int col)

Gets the render string for the value the given cell. Applys the available converters to convert the value.

Parameters:

context -

rowKey -

col -

Returns:

getSelectedColumn

public java.lang.Integer getSelectedColumn()

The currently selected column.

Returns:

setSelectedColumn

public void setSelectedColumn(java.lang.Integer col)

Updates the selected column.

Parameters:

col -

getSelectedLastColumn

public java.lang.Integer getSelectedLastColumn()

The currently selected column.

Returns:

setSelectedLastColumn

public void setSelectedLastColumn(java.lang.Integer col)

Updates the selected column.

Parameters:

col -

getSelectedRow

public java.lang.Integer getSelectedRow()

The currently selected row.

Returns:

getSelectedLastRow

public java.lang.Integer getSelectedLastRow()

The currently selected row.

Returns:

setSelectedRow

public void setSelectedRow(java.lang.Integer row)

Updates the selected row.

Parameters:

row -

setSelectedLastRow

public void setSelectedLastRow(java.lang.Integer row)

Updates the selected row.

Parameters:

row -

getWidth

public java.lang.Integer getWidth()

The width of the sheet in pixels

Returns:

setWidth

public void setWidth(java.lang.Integer value)

Updates the width

Parameters:

row -

getHeight

public java.lang.Integer getHeight()

The height of the sheet. Note this is applied to the inner div which is why it is recommend you use this property instead of a style class.

Returns:

setHeight

public void setHeight(java.lang.Integer value)

Updates the height

Parameters:

row -

getValue

public java.lang.Object getValue()

Return the value of the Sheet. This value must be a java.util.List value at this time.

Specified by:

getValue in interface javax.faces.component.ValueHolder

Overrides:

getValue in class javax.faces.component.UIInput

getSortedValues

public java.util.List<java.lang.Object> getSortedValues()

The sorted list of values.

Returns:

getSortColRenderIndex

public int getSortColRenderIndex()

Gets the rendered col index of the column corresponding to the current sortBy. This is used to keep track of the current sort column in the page.

Returns:

matchesFilter

protected boolean matchesFilter(java.lang.Object obj)

Evaluates the specified item value against the column filters and if they match, returns true, otherwise false.

Parameters:

obj -

Returns:

sortAndFilter

public void sortAndFilter()

Sorts and filters the data

reMapRows

protected void reMapRows()

Remaps the row keys to the sorted and filtered list.

getRowKeyValue

protected java.lang.Object getRowKeyValue(javax.faces.context.FacesContext context)

Gets the rowKey for the current row

Parameters:

context - the faces context

Returns:

a row key value or null if the expression is not set

getRowKeyValueAsString

protected java.lang.String getRowKeyValueAsString(java.lang.Object key)

Gets the row key value as a String suitable for use in javascript rendering.

Parameters:

context -

Returns:

getRowKeyValueAsString

protected java.lang.String getRowKeyValueAsString(javax.faces.context.FacesContext context)

Gets the row key value as a string for the current row var.

Parameters:

context -

Returns:

convertSortOrder

protected org.primefaces.model.SortOrder convertSortOrder()

Convert to PF SortOrder enum since we are leveraging PF sorting code.

Returns:

setValue

public void setValue(java.lang.Object value)

Set the value of the Sheet. This value must be a java.util.List at this time.

Specified by:

setValue in interface javax.faces.component.ValueHolder

Overrides:

setValue in class javax.faces.component.UIInput

Parameters:

value - the new value

getVar

public java.lang.String getVar()

Return the request-scope attribute under which the data object for the current row will be exposed when iterating. This property is not enabled for value binding expressions.

setVar

public void setVar(java.lang.String var)

Set the request-scope attribute under which the data object for the current row wil be exposed when iterating.

Parameters:

var - The new request-scope attribute name

getSortByValueExpression

public javax.el.ValueExpression getSortByValueExpression()

The current sortBy value expression in use.

Returns:

setSortByValueExpression

public void setSortByValueExpression(javax.el.ValueExpression sortBy)

Update the sort field

Parameters:

sortBy -

getSortOrder

public java.lang.String getSortOrder()

The sort direction

Returns:

setSortOrder

public void setSortOrder(java.lang.String sortOrder)

Update the sort direction

Parameters:

sortOrder -

getErrorMessage

public java.lang.String getErrorMessage()

The error message to display when the sheet is in error.

Returns:

setErrorMessage

public void setErrorMessage(java.lang.String value)

Updates the errorMessage value.

Parameters:

value -

processValidators

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

Overrides:

processValidators in class javax.faces.component.UIInput

validate

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

Converts each submitted value into a local value and stores it back in the hash. If all values convert without error, then the component is valid, and we can proceed to the processUpdates.

Overrides:

validate in class javax.faces.component.UIInput

updateModel

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

Override to update model with local values. Note that this is where things can be fragile in that we can successfully update some values and fail on others. There is no clean way to roll back the updates, but we also need to fail processing. TODO consider keeping old values as we update (need for event anyhow) and if there is a failure attempt to roll back by updating successful model updates with the old value. This may not all be necessary.

Overrides:

updateModel in class javax.faces.component.UIInput

saveState

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

Saves the state of the submitted and local values and the bad updates.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIInput

restoreState

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

Restores the state for the submitted, local and bad values.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIInput

getSelection

public java.lang.String getSelection()

The selection value.

Returns:

the selection

setSelection

public void setSelection(java.lang.String selection)

Updates the selection value.

Parameters:

selection - the selection to set

getSubmittedValue

public java.lang.Object getSubmittedValue()

Specified by:

getSubmittedValue in interface javax.faces.component.EditableValueHolder

Overrides:

getSubmittedValue in class javax.faces.component.UIInput

setSubmittedValue

public void setSubmittedValue(java.lang.Object submittedValue)

Specified by:

setSubmittedValue in interface javax.faces.component.EditableValueHolder

Overrides:

setSubmittedValue in class javax.faces.component.UIInput

getUpdates

public java.util.List<SheetUpdate> getUpdates()

A list of updates from the last submission or ajax event.

Returns:

the editEvent

appendUpdateEvent

protected void appendUpdateEvent(java.lang.Object rowKey,
                                 int colIndex,
                                 java.lang.Object rowData,
                                 java.lang.Object oldValue,
                                 java.lang.Object newValue)

Appends an update event

Parameters:

rowIndex -

colIndex -

rowData -

oldValue -

newValue -

isHasStyledCells

public boolean isHasStyledCells()

Returns true if any of the columns contain conditional styling.

Returns:

getMappedColumn

public int getMappedColumn(int renderIdx)

Maps the rendered column index to the real column index.

Parameters:

renderIdx - the rendered index

Returns:

the mapped index

getRenderIndexFromRealIdx

public int getRenderIndexFromRealIdx(int realIdx)

Provides the render column index based on the real index

Parameters:

realIdx -

Returns:

updateColumnMappings

public void updateColumnMappings()

Updates the column mappings based on the rendered attribute

getRowCount

public int getRowCount()

The number of rows in the value list.

Returns:

getFocusId

public java.lang.String getFocusId()

The focusId value.

Returns:

the focusId

setFocusId

public void setFocusId(java.lang.String focusId)

Updates the focusId value.

Parameters:

focusId - the focusId to set

commitUpdates

public void commitUpdates()

Invoke this method to commit the most recent set of ajax updates and restart the tracking of changes. Use this when you have processes the updates to the model and are confident that any changes made to this point can be cleared (likely because you have persisted those changes).

getInvalidDataValue

public java.lang.String getInvalidDataValue()

Generates the bad data var value for this sheet.

Returns:

renderRowUpdateScript

protected void renderRowUpdateScript(javax.faces.context.FacesContext context,
                                     java.util.Set<java.lang.String> dirtyRows)

Adds eval scripts to the ajax response to update the rows dirtied by the most recent successful update request.

Parameters:

context - the FacesContext

dirtyRows - the set of dirty rows

renderBadUpdateScript

protected void renderBadUpdateScript(javax.faces.context.FacesContext context)

Adds eval scripts to update the bad data array in the sheet to render validation failures produced by the most recent ajax update attempt.

Parameters:

context - the FacesContext