org.icefaces.mobi.component.dataview

Class DataViewColumnBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.icefaces.mobi.component.dataview.DataViewColumnBase

All Implemented Interfaces:

java.util.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, IDataViewColumn

Direct Known Subclasses:

DataViewColumn

public abstract class DataViewColumnBase
extends javax.faces.component.UIComponentBase
implements IDataViewColumn

DataViewColumns defines a column in the table region of the DataView component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DataViewColumnBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_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
DataViewColumnBase()

Method Summary

Modifier and Type	Method and Description
javax.faces.convert.Converter	getConverter() Return the value of the converter property.
java.lang.String	getFamily()
java.lang.String	getFooterText() Return the value of the footerText property.
java.lang.String	getHeaderText() Return the value of the headerText property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
ColumnType	getType() Return the value of the type property.
java.lang.Object	getValue() Return the value of the value property.
boolean	isEscape() Return the value of the escape property.
protected boolean	isPropertySet(java.lang.String finder)
boolean	isSortable() Return the value of the sortable property.
void	setConverter(javax.faces.convert.Converter converter) Set the value of the converter property.
void	setEscape(boolean escape) Set the value of the escape property.
void	setFooterText(java.lang.String footerText) Set the value of the footerText property.
void	setHeaderText(java.lang.String headerText) Set the value of the headerText property.
void	setSortable(boolean sortable) Set the value of the sortable property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setType(ColumnType type) Set the value of the type property.
void	setValue(java.lang.Object value) Set the value of the value property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

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, restoreState, saveAttachedState, saveState, 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, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

Constructor Detail

DataViewColumnBase

public DataViewColumnBase()

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

setConverter

public void setConverter(javax.faces.convert.Converter converter)

Set the value of the converter property.

Contents: Converter instance registered with this component (Only applicable to date columns, must extend DateTimeConverter).

Specified by:

setConverter in interface IDataViewColumn

getConverter

public javax.faces.convert.Converter getConverter()

Return the value of the converter property.

Contents: Converter instance registered with this component (Only applicable to date columns, must extend DateTimeConverter).

Specified by:

getConverter in interface IDataViewColumn

setEscape

public void setEscape(boolean escape)

Set the value of the escape property.

Contents: Flag indicating that characters that are sensitive in HTML and XML markup must be escaped.

Specified by:

setEscape in interface IDataViewColumn

isEscape

public boolean isEscape()

Return the value of the escape property.

Contents: Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. Default = 'true'.

Specified by:

isEscape in interface IDataViewColumn

setFooterText

public void setFooterText(java.lang.String footerText)

Set the value of the footerText property.

Contents: Define the text to render in the footer of this column.

Specified by:

setFooterText in interface IDataViewColumn

getFooterText

public java.lang.String getFooterText()

Return the value of the footerText property.

Contents: Define the text to render in the footer of this column.

Specified by:

getFooterText in interface IDataViewColumn

setHeaderText

public void setHeaderText(java.lang.String headerText)

Set the value of the headerText property.

Contents: Define the text to render in the header of this column.

Specified by:

setHeaderText in interface IDataViewColumn

getHeaderText

public java.lang.String getHeaderText()

Return the value of the headerText property.

Contents: Define the text to render in the header of this column.

Specified by:

getHeaderText in interface IDataViewColumn

setSortable

public void setSortable(boolean sortable)

Set the value of the sortable property.

Contents: Define if the column is sortable.

Specified by:

setSortable in interface IDataViewColumn

isSortable

public boolean isSortable()

Return the value of the sortable property.

Contents: Define if the column is sortable. Default = 'true'.

Specified by:

isSortable in interface IDataViewColumn

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

setStyleClass in interface IDataViewColumn

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Sets the CSS class to apply to this component.

Specified by:

getStyleClass in interface IDataViewColumn

setType

public void setType(ColumnType type)

Set the value of the type property.

Contents: Define the ColumnType of this column, determining how the 'value' attribute of this component will be rendered. Valid options include : text, bool, date, image. Text will render the String representation of the value object. Bool assumes the value object is a boolean type and renders a checkbox icon. Date assumes the value object is a Date object and renders according to the required f:convertDateTime child component. Image assume the value is a representation of an image URL.

Specified by:

setType in interface IDataViewColumn

getType

public ColumnType getType()

Return the value of the type property.

Contents: Define the ColumnType of this column, determining how the 'value' attribute of this component will be rendered. Valid options include : text, bool, date, image. Text will render the String representation of the value object. Bool assumes the value object is a boolean type and renders a checkbox icon. Date assumes the value object is a Date object and renders according to the required f:convertDateTime child component. Image assume the value is a representation of an image URL. Default = 'org.icefaces.mobi.component.dataview.ColumnType.text'.

Specified by:

getType in interface IDataViewColumn

setValue

public void setValue(java.lang.Object value)

Set the value of the value property.

Contents: Define a ValueExpression whose resulting Object will be iteratively rendered in the table region of the DataView according to the 'type' of this column.

Specified by:

setValue in interface IDataViewColumn

getValue

public java.lang.Object getValue()

Return the value of the value property.

Contents: Define a ValueExpression whose resulting Object will be iteratively rendered in the table region of the DataView according to the 'type' of this column.

Specified by:

getValue in interface IDataViewColumn

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                               javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent