Package 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:

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

Spreadsheet component wrappering the Handsontable jQuery UI component.

Since:

6.2

Author:

Mark Lassiter / Melloware

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_FAMILY
static final String	COMPONENT_TYPE
static final String	EVENT_CELL_SELECT
static final String	EVENT_CHANGE
static final String	EVENT_COLUMN_SELECT
static final String	EVENT_FILTER
static final String	EVENT_ROW_SELECT
static final String	EVENT_SORT

Fields inherited from class javax.faces.component.UIInput

ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, 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

Fields inherited from interface org.primefaces.component.api.Widget

ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

Constructor Summary

Constructors

Constructor	Description
Sheet()

Method Summary

Modifier and Type	Method	Description
void	appendUpdateEvent(Object rowKey, int colIndex, Object rowData, Object oldValue, 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.
String	getActiveHeaderStyleClass()
List<SheetColumn>	getColumns()	The list of child columns.
String	getCommentedCellStyleClass()
String	getCurrentColStyleClass()
String	getCurrentHeaderStyleClass()
String	getCurrentRowStyleClass()
String	getDefaultEventName()
String	getEmptyMessage()
String	getErrorMessage()	The error message to display when the sheet is in error.
Collection<String>	getEventNames()
String	getExtender()
String	getFamily()
List	getFilteredValue()	Holds the filtered and sorted List of values.
Integer	getFixedCols()
Integer	getFixedRows()
Integer	getFixedRowsBottom()
String	getFocusId()	The focusId value.
Integer	getHeight()	The height of the sheet.
String	getInvalidCellStyleClass()
String	getInvalidDataValue()	Generates the bad data var value for this sheet.
List<SheetInvalidUpdate>	getInvalidUpdates()	The list of invalid updates
String	getLocale()
Object	getLocalValue(String rowKey, int col)	Retrieves the submitted value for the rowKey and col.
int	getMappedColumn(int renderCol)	Maps the rendered column index to the real column index.
Integer	getMaxCols()
Integer	getMaxRows()
Integer	getMinCols()
Integer	getMinRows()
String	getNoWordWrapStyleClass()
Integer	getNullSortOrder()
String	getPlaceholderCellStyleClass()
String	getReadOnlyCellStyleClass()
List<SheetColumn>	getRenderedColumns()	The list of rendered child columns.
int	getRenderIndexFromRealIdx(int realIdx)	Provides the render column index based on the real index
String	getRenderValueForCell(javax.faces.context.FacesContext context, 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 String	getRowHeaderValueAsString(javax.faces.context.FacesContext context)	Gets the row header text value as a string for use in javascript
protected javax.el.ValueExpression	getRowHeaderValueExpression()	Gets the rowHeader value expression defined
protected Object	getRowKeyValue(javax.faces.context.FacesContext context)	Gets the rowKey for the current row
protected String	getRowKeyValueAsString(Object key)	Gets the row key value as a String suitable for use in javascript rendering.
protected String	getRowKeyValueAsString(javax.faces.context.FacesContext context)	Gets the row key value as a string for the current row var.
protected Map<String,Object>	getRowMap()
String	getRowStyleClass()
Integer	getSelectedColumn()	The currently selected column.
Integer	getSelectedLastColumn()	The currently selected column.
Integer	getSelectedLastRow()	The currently selected row.
Integer	getSelectedRow()	The currently selected row.
String	getSelection()	The selection value.
String	getSelectionMode()
Object	getSortBy()	Please note: The return type needs to be Object.
int	getSortColRenderIndex()	Gets the rendered col index of the column corresponding to the current sortBy.
List<Object>	getSortedValues()	The sorted list of values.
String	getSortOrder()	The sort direction
String	getStretchH()
String	getStyle()	The style value
String	getStyleClass()
Object	getSubmittedValue()
String	getSubmittedValue(String rowKey, int col)	Retrieves the submitted value for the row and col.
String	getTabindex()
List<SheetUpdate>	getUpdates()	A list of updates from the last submission or ajax event.
Object	getValue()	Return the value of the Sheet.
Object	getValueForCell(javax.faces.context.FacesContext context, String rowKey, int col)	Gets the object value of the row and col specified.
String	getVar()	Return the request-scope attribute under which the data object for the current row will be exposed when iterating.
Integer	getWidth()
boolean	isAllowTabOffSheet()
boolean	isCaseSensitiveSort()
boolean	isHasStyledCells()	Returns true if any of the columns contain conditional styling.
boolean	isMovableCols()
boolean	isMovableRows()
boolean	isReadOnly()
boolean	isResizableCols()
boolean	isResizableRows()
boolean	isShowColumnHeaders()
boolean	isShowRowHeaders()
protected boolean	matchesFilter()	Evaluates the specified item value against the column filters and if they match, returns true, otherwise false.
void	queueEvent(javax.faces.event.FacesEvent event)
protected void	remapFilteredList(List filteredList)	Remaps the row keys in a hash map.
protected void	remapRows()	Remaps the row keys in a hash map.
void	renderBadUpdateScript()	Adds eval scripts to update the bad data array in the sheet to render validation failures produced by the most recent ajax update attempt.
void	renderRowUpdateScript(javax.faces.context.FacesContext context, Set<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
void	restoreState(javax.faces.context.FacesContext context, Object state)	Restores the state for the submitted, local and bad values.
void	saveSortByColumn(String columnId)	Saves the column by which the sheet is currently sorted (when the user clicks on a column).
Object	saveState(javax.faces.context.FacesContext context)	Saves the state of the submitted and local values and the bad updates.
void	setActiveHeaderStyleClass(String value)
void	setAllowTabOffSheet(boolean value)
void	setCaseSensitiveSort(boolean value)
void	setColumns(List<SheetColumn> columns)	Updates the list of child columns.
void	setCommentedCellStyleClass(String value)
void	setCurrentColStyleClass(String value)
void	setCurrentHeaderStyleClass(String value)
void	setCurrentRowStyleClass(String value)
void	setEmptyMessage(String value)
void	setErrorMessage(String value)	Updates the errorMessage value.
void	setExtender(String extender)
void	setFilteredValue(List filteredValue)	Sets the filtered list.
void	setFixedCols(Integer value)
void	setFixedRows(Integer value)
void	setFixedRowsBottom(Integer value)
void	setFocusId(String focusId)	Updates the focusId value.
void	setHeight(Integer value)	Updates the height
void	setInvalidCellStyleClass(String value)
void	setLocale(String locale)
void	setLocalValue(String rowKey, int col, Object value)	Updates a local value.
void	setMaxCols(Integer value)
void	setMaxRows(Integer value)
void	setMinCols(Integer value)
void	setMinRows(Integer value)
void	setMovableCols(boolean value)
void	setMovableRows(boolean value)
void	setNoWordWrapStyleClass(String value)
void	setNullSortOrder(Integer value)
void	setPlaceholderCellStyleClass(String value)
void	setReadOnly(boolean value)
void	setReadOnlyCellStyleClass(String value)
void	setResizableCols(boolean value)
void	setResizableRows(boolean value)
void	setRowStyleClass(String styleClass)
void	setRowVar(javax.faces.context.FacesContext context, String rowKey)	Updates the row var for iterations over the list.
void	setSelectedColumn(Integer col)	Updates the selected column.
void	setSelectedLastColumn(Integer col)	Updates the selected column.
void	setSelectedLastRow(Integer row)	Updates the selected row.
void	setSelectedRow(Integer row)	Updates the selected row.
void	setSelection(String selection)	Updates the selection value.
void	setSelectionMode(String value)
void	setShowColumnHeaders(boolean value)
void	setShowRowHeaders(boolean value)
void	setSortBy(Object sortBy)
void	setSortOrder(String sortOrder)	Update the sort direction
void	setStretchH(String value)
void	setStyle(String value)	Update the style value for the component
void	setStyleClass(String styleClass)
void	setSubmittedValue(Object submittedValue)
void	setSubmittedValue(String rowKey, int col, String value)	Updates a submitted value.
void	setTabindex(String tabindex)
void	setValue(Object value)	Set the value of the Sheet.
void	setVar(String var)	Set the request-scope attribute under which the data object for the current row wil be exposed when iterating.
void	setWidth(Integer value)
List<Object>	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, processValidators, 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, 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.ValueHolder

getConverter, getLocalValue, setConverter

Methods inherited from interface org.primefaces.component.api.Widget

resolveWidgetVar, resolveWidgetVar

Field Details

EVENT_CELL_SELECT

public static final String EVENT_CELL_SELECT

See Also:

• Constant Field Values

EVENT_CHANGE

public static final String EVENT_CHANGE

See Also:

• Constant Field Values

EVENT_SORT

public static final String EVENT_SORT

See Also:

• Constant Field Values

EVENT_FILTER

public static final String EVENT_FILTER

See Also:

• Constant Field Values

EVENT_COLUMN_SELECT

public static final String EVENT_COLUMN_SELECT

See Also:

• Constant Field Values

EVENT_ROW_SELECT

public static final String EVENT_ROW_SELECT

See Also:

• Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

• Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

• Constant Field Values

Constructor Details

Sheet

public Sheet()

Method Details

getFamily

public String getFamily()

getEventNames

public Collection<String> getEventNames()

Specified by:

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

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

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

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

getColumns

public List<SheetColumn> getColumns()

The list of child columns.

getRenderedColumns

public List<SheetColumn> getRenderedColumns()

The list of rendered child columns.

setColumns

public void setColumns(List<SheetColumn> columns)

Updates the list of child columns.

getInvalidUpdates

public List<SheetInvalidUpdate> getInvalidUpdates()

The list of invalid updates

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(String rowKey,
 int col,
 String value)

Updates a submitted value.

getSubmittedValue

public String getSubmittedValue(String rowKey,
 int col)

Retrieves the submitted value for the row and col.

setLocalValue

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

Updates a local value.

getLocalValue

public Object getLocalValue(String rowKey,
 int col)

Retrieves the submitted value for the rowKey and col.

setRowVar

public void setRowVar(javax.faces.context.FacesContext context,
 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

getRowMap

protected Map<String,Object> getRowMap()

getValueForCell

public Object getValueForCell(javax.faces.context.FacesContext context,
 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.

getRenderValueForCell

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

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

getRowHeaderValueAsString

protected String getRowHeaderValueAsString(javax.faces.context.FacesContext context)

Gets the row header text value as a string for use in javascript

getSortedValues

public List<Object> getSortedValues()

The sorted list of values.

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.

matchesFilter

protected boolean matchesFilter()

Evaluates the specified item value against the column filters and if they match, returns true, otherwise false. If no filterMatchMode is given on a column than the "contains" mode is used. Otherwise the following filterMatchMode values are possible: - startsWith: Checks if column value starts with the filter value. - endsWith: Checks if column value ends with the filter value. - contains: Checks if column value contains the filter value. - exact: Checks if string representations of column value and filter value are same.

sortAndFilter

public List<Object> sortAndFilter()

Sorts and filters the data

remapFilteredList

protected void remapFilteredList(List filteredList)

Remaps the row keys in a hash map.

remapRows

protected void remapRows()

Remaps the row keys in a hash map.

getRowKeyValue

protected 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 String getRowKeyValueAsString(Object key)

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

getRowKeyValueAsString

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

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

convertSortOrder

protected org.primefaces.model.SortOrder convertSortOrder()

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

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. 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 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,
 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 String getSelection()

The selection value.

Returns:

the selection

setSelection

public void setSelection(String selection)

Updates the selection value.

Parameters:

selection - the selection to set

getSubmittedValue

public Object getSubmittedValue()

Specified by:

getSubmittedValue in interface javax.faces.component.EditableValueHolder

Overrides:

getSubmittedValue in class javax.faces.component.UIInput

setSubmittedValue

public void setSubmittedValue(Object submittedValue)

Specified by:

setSubmittedValue in interface javax.faces.component.EditableValueHolder

Overrides:

setSubmittedValue in class javax.faces.component.UIInput

getUpdates

public List<SheetUpdate> getUpdates()

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

Returns:

the editEvent

isHasStyledCells

public boolean isHasStyledCells()

Returns true if any of the columns contain conditional styling.

getMappedColumn

public int getMappedColumn(int renderCol)

Maps the rendered column index to the real column index.

Parameters:

renderCol - the rendered index

Returns:

the mapped index

getRenderIndexFromRealIdx

public int getRenderIndexFromRealIdx(int realIdx)

Provides the render column index based on the real index

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.

getFocusId

public String getFocusId()

The focusId value.

Returns:

the focusId

setFocusId

public void setFocusId(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 String getInvalidDataValue()

Generates the bad data var value for this sheet.

renderRowUpdateScript

public void renderRowUpdateScript(javax.faces.context.FacesContext context,
 Set<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

public void renderBadUpdateScript()

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

appendUpdateEvent

public void appendUpdateEvent(Object rowKey,
 int colIndex,
 Object rowData,
 Object oldValue,
 Object newValue)

Appends an update event

setStyleClass

public void setStyleClass(String styleClass)

getStyleClass

public String getStyleClass()

setStretchH

public void setStretchH(String value)

getStretchH

public String getStretchH()

setEmptyMessage

public void setEmptyMessage(String value)

getEmptyMessage

public String getEmptyMessage()

getSortBy

public Object getSortBy()

Please note: The return type needs to be Object. Otherwise, evaluating the sortBy attribute as a value expression forces it into a string, and strings are sorted differently than numbers.

Returns:

The ID of the column to sort by.

setSortBy

public void setSortBy(Object sortBy)

setShowColumnHeaders

public void setShowColumnHeaders(boolean value)

isShowColumnHeaders

public boolean isShowColumnHeaders()

setShowRowHeaders

public void setShowRowHeaders(boolean value)

isShowRowHeaders

public boolean isShowRowHeaders()

setResizableRows

public void setResizableRows(boolean value)

isResizableRows

public boolean isResizableRows()

setResizableCols

public void setResizableCols(boolean value)

isResizableCols

public boolean isResizableCols()

setMovableRows

public void setMovableRows(boolean value)

isMovableRows

public boolean isMovableRows()

setMovableCols

public void setMovableCols(boolean value)

isMovableCols

public boolean isMovableCols()

setRowStyleClass

public void setRowStyleClass(String styleClass)

getRowStyleClass

public String getRowStyleClass()

getActiveHeaderStyleClass

public String getActiveHeaderStyleClass()

setReadOnly

public void setReadOnly(boolean value)

isReadOnly

public boolean isReadOnly()

setActiveHeaderStyleClass

public void setActiveHeaderStyleClass(String value)

getCommentedCellStyleClass

public String getCommentedCellStyleClass()

setCommentedCellStyleClass

public void setCommentedCellStyleClass(String value)

getCurrentColStyleClass

public String getCurrentColStyleClass()

setCurrentColStyleClass

public void setCurrentColStyleClass(String value)

getCurrentHeaderStyleClass

public String getCurrentHeaderStyleClass()

setCurrentHeaderStyleClass

public void setCurrentHeaderStyleClass(String value)

getCurrentRowStyleClass

public String getCurrentRowStyleClass()

setCurrentRowStyleClass

public void setCurrentRowStyleClass(String value)

getInvalidCellStyleClass

public String getInvalidCellStyleClass()

setInvalidCellStyleClass

public void setInvalidCellStyleClass(String value)

getNoWordWrapStyleClass

public String getNoWordWrapStyleClass()

setNoWordWrapStyleClass

public void setNoWordWrapStyleClass(String value)

getPlaceholderCellStyleClass

public String getPlaceholderCellStyleClass()

setPlaceholderCellStyleClass

public void setPlaceholderCellStyleClass(String value)

getReadOnlyCellStyleClass

public String getReadOnlyCellStyleClass()

setReadOnlyCellStyleClass

public void setReadOnlyCellStyleClass(String value)

setAllowTabOffSheet

public void setAllowTabOffSheet(boolean value)

isAllowTabOffSheet

public boolean isAllowTabOffSheet()

getTabindex

public String getTabindex()

setTabindex

public void setTabindex(String tabindex)

getExtender

public String getExtender()

setExtender

public void setExtender(String extender)

setCaseSensitiveSort

public void setCaseSensitiveSort(boolean value)

isCaseSensitiveSort

public boolean isCaseSensitiveSort()

getNullSortOrder

public Integer getNullSortOrder()

setNullSortOrder

public void setNullSortOrder(Integer value)

setMaxRows

public void setMaxRows(Integer value)

getMaxRows

public Integer getMaxRows()

setMinRows

public void setMinRows(Integer value)

getMinRows

public Integer getMinRows()

setMaxCols

public void setMaxCols(Integer value)

getMaxCols

public Integer getMaxCols()

setMinCols

public void setMinCols(Integer value)

getMinCols

public Integer getMinCols()

setFixedRows

public void setFixedRows(Integer value)

getFixedRows

public Integer getFixedRows()

setFixedRowsBottom

public void setFixedRowsBottom(Integer value)

getFixedRowsBottom

public Integer getFixedRowsBottom()

setFixedCols

public void setFixedCols(Integer value)

getFixedCols

public Integer getFixedCols()

getLocale

public String getLocale()

setLocale

public void setLocale(String locale)

setSelectionMode

public void setSelectionMode(String value)

getSelectionMode

public String getSelectionMode()

getSelectedColumn

public Integer getSelectedColumn()

The currently selected column.

Returns:

setSelectedColumn

public void setSelectedColumn(Integer col)

Updates the selected column.

Parameters:

col -

getSelectedLastColumn

public Integer getSelectedLastColumn()

The currently selected column.

Returns:

setSelectedLastColumn

public void setSelectedLastColumn(Integer col)

Updates the selected column.

Parameters:

col -

getSelectedRow

public Integer getSelectedRow()

The currently selected row.

Returns:

getSelectedLastRow

public Integer getSelectedLastRow()

The currently selected row.

Returns:

setSelectedRow

public void setSelectedRow(Integer row)

Updates the selected row.

Parameters:

row -

setSelectedLastRow

public void setSelectedLastRow(Integer row)

Updates the selected row.

Parameters:

row -

getWidth

public Integer getWidth()

setWidth

public void setWidth(Integer value)

getHeight

public 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(Integer value)

Updates the height

Parameters:

value -

getValue

public 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

getFilteredValue

public List getFilteredValue()

Holds the filtered and sorted List of values.

Returns:

a List of sorted and filtered values

setFilteredValue

public void setFilteredValue(List filteredValue)

Sets the filtered list.

Parameters:

filteredValue - the List to store

setValue

public void setValue(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

setStyle

public void setStyle(String value)

Update the style value for the component

Parameters:

value -

getStyle

public String getStyle()

The style value

Returns:

the style value

getRowHeaderValueExpression

protected javax.el.ValueExpression getRowHeaderValueExpression()

Gets the rowHeader value expression defined

Returns:

a value expression for Row Header or null if the expression is not set

getVar

public 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(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

saveSortByColumn

public void saveSortByColumn(String columnId)

Saves the column by which the sheet is currently sorted (when the user clicks on a column).

Parameters:

columnId - ID of the column by which the sheet is currently sorted.

getSortOrder

public String getSortOrder()

The sort direction

Returns:

setSortOrder

public void setSortOrder(String sortOrder)

Update the sort direction

Parameters:

sortOrder -

getErrorMessage

public String getErrorMessage()

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

Returns:

setErrorMessage

public void setErrorMessage(String value)

Updates the errorMessage value.

Parameters:

value -