org.nuxeo.ecm.platform.ui.web.component.seam

Class UICellExcel

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.jboss.seam.excel.ui.ExcelComponent

org.jboss.seam.excel.ui.UICellBase

org.jboss.seam.excel.ui.UICell

org.nuxeo.ecm.platform.ui.web.component.seam.UICellExcel

All Implemented Interfaces:

EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.jboss.seam.excel.WorksheetItem

public class UICellExcel
extends org.jboss.seam.excel.ui.UICell

Override of Seam cell component to control HTML encoding of accents in excel, and to improve data type guessing when using dates or numbers.

Since:

5.5

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.seam.excel.ui.UICell

org.jboss.seam.excel.ui.UICell.CellType

Nested classes/interfaces inherited from interface org.jboss.seam.excel.WorksheetItem

org.jboss.seam.excel.WorksheetItem.ItemType

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHARACTER_ENCODING
static String	DEFAULT_CONTENT_TYPE
protected String	forceType Force type attribute, added here to ensure value expression resolution
protected String	style Style attribute, added here to ensure value expression resolution
protected Object	value

Fields inherited from class org.jboss.seam.excel.ui.UICell

COMPONENT_TYPE

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
UICellExcel()

Method Summary

Modifier and Type	Method and Description
static String	cmp2String(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component) Helper method for rendering a component (usually on a facescontext with a caching reponsewriter)
protected Object	convertStringToTargetType(String value, String forceType) Converts string value as returned by widget to the target type for an accurate cell format in the XLS/CSV export.
String	getForceType() Returns the force type attribute, used to force cell type to "date" or "number" for instance.
String	getStyle() Returns the style attribute, used to format cells with a specific forceType.
Object	getValue()
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
void	setForceType(String forceType)
void	setStyle(String style)
void	setValue(Object value)

Methods inherited from class org.jboss.seam.excel.ui.UICell

getColumn, getDataType, getFamily, getItemType, getRow, setColumn, setRow

Methods inherited from class org.jboss.seam.excel.ui.UICellBase

getComment, getCommentHeight, getCommentWidth, setComment, setCommentHeight, setCommentWidth

Methods inherited from class org.jboss.seam.excel.ui.ExcelComponent

getChildrenOfType, getCommands, getItems, getParentByClass, getStyleClass, getWorkbook, setStyleClass, valueOf

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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

Field Detail

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

See Also:

Constant Field Values

DEFAULT_CHARACTER_ENCODING

public static final String DEFAULT_CHARACTER_ENCODING

See Also:

Constant Field Values

value

protected Object value

forceType

protected String forceType

Force type attribute, added here to ensure value expression resolution

style

protected String style

Style attribute, added here to ensure value expression resolution

Constructor Detail

UICellExcel

public UICellExcel()

Method Detail

getValue

public Object getValue()

Specified by:

getValue in interface org.jboss.seam.excel.WorksheetItem

Overrides:

getValue in class org.jboss.seam.excel.ui.UICell

setValue

public void setValue(Object value)

Overrides:

setValue in class org.jboss.seam.excel.ui.UICell

convertStringToTargetType

protected Object convertStringToTargetType(String value,
                                           String forceType)

Converts string value as returned by widget to the target type for an accurate cell format in the XLS/CSV export.

• If force type is set to "number", convert value to a double (null if empty).
• If force type is set to "bool", convert value to a boolean (null if empty).
• If force type is set to "date", convert value to a date using most frequent date parsers using the short, medium, long and full formats and current locale, trying first with time information and after with only date information. Returns null if date is empty or could not be parsed.

Since:

5.6

cmp2String

public static String cmp2String(javax.faces.context.FacesContext facesContext,
                                javax.faces.component.UIComponent component)
                         throws IOException

Helper method for rendering a component (usually on a facescontext with a caching reponsewriter)

Parameters:

facesContext - The faces context to render to

component - The component to render

Returns:

The textual representation of the component

Throws:

IOException - If the JSF helper class can't render the component

getStyle

public String getStyle()

Returns the style attribute, used to format cells with a specific forceType. Sample value for dates formatting: "xls-format-mask: #{nxu:basicDateFormatter()};".

Overrides:

getStyle in class org.jboss.seam.excel.ui.ExcelComponent

Since:

5.6

setStyle

public void setStyle(String style)

Overrides:

setStyle in class org.jboss.seam.excel.ui.ExcelComponent

Since:

5.6

getForceType

public String getForceType()

Returns the force type attribute, used to force cell type to "date" or "number" for instance.

Since:

5.6

setForceType

public void setForceType(String forceType)

Since:

5.6

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIComponentBase

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase