DataViewBase (ICEfaces Java API Documentation)

java.lang.Object
- javax.faces.component.UIComponent
- - javax.faces.component.UIComponentBase
  - - org.icefaces.mobi.component.dataview.DataViewBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, 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.icefaces.ace.api.IceClientBehaviorHolder, IDataView

Direct Known Subclasses:

DataView
```
public abstract class DataViewBase
extends javax.faces.component.UIComponentBase
implements IDataView, org.icefaces.ace.api.IceClientBehaviorHolder
```
The DataView component renders a table region for iterative output using columns defined with the required DataViewColumns component child, and a detail region for extensive viewing (and editing) of the row objects of the table model. The detail regionis defined with the DataViewDetails child component and it's contents are displayed when a row of table region is activated, typically by a row tap.When using ajax, the detail region may contain arbitrary JSF components and is dynamically rendered with the ajax request. When not using ajax, the detail region display logic is done entirely in the client, from an existing rendering of the details region for each row. The components and attributes supported for client-mode rendering are limited, mostly consisting of the standard h:* components.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class DataViewBase.PropertyKeys

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`DataViewBase.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

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT_TYPE`
`static java.lang.String`	`RENDERER_TYPE`

Constructor Summary

Constructors
Constructor and Description

DataViewBase()

Constructors
Constructor and Description
`DataViewBase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)`
`java.lang.Integer`	`getActiveRowIndex()` Return the value of the `activeRowIndex` property.
`java.lang.String`	`getDefaultEventName()`
`java.lang.String`	`getDefaultExecute(java.lang.String event)`
`java.lang.String`	`getDefaultRender(java.lang.String event)`
`java.util.Collection<java.lang.String>`	`getEventNames()`
`java.lang.String`	`getFamily()`
`java.lang.String`	`getListenerArgument(java.lang.String event)`
`java.lang.String`	`getRowIndexVar()` Return the value of the `rowIndexVar` property.
`java.lang.String`	`getStyle()` Return the value of the `style` property.
`java.lang.String`	`getStyleClass()` Return the value of the `styleClass` property.
`java.lang.Object`	`getValue()` Return the value of the `value` property.
`java.lang.String`	`getVar()` Return the value of the `var` property.
`boolean`	`isDisabled()` Return the value of the `disabled` property.
`protected boolean`	`isPropertySet(java.lang.String finder)`
`boolean`	`isRowStripe()` Return the value of the `rowStripe` property.
`boolean`	`isRowStroke()` Return the value of the `rowStroke` property.
`void`	`setActiveRowIndex(java.lang.Integer activeRowIndex)` Set the value of the `activeRowIndex` property.
`void`	`setDisabled(boolean disabled)` Set the value of the `disabled` property.
`void`	`setRowIndexVar(java.lang.String rowIndexVar)` Set the value of the `rowIndexVar` property.
`void`	`setRowStripe(boolean rowStripe)` Set the value of the `rowStripe` property.
`void`	`setRowStroke(boolean rowStroke)` Set the value of the `rowStroke` property.
`void`	`setStyle(java.lang.String style)` Set the value of the `style` property.
`void`	`setStyleClass(java.lang.String styleClass)` Set the value of the `styleClass` property.
`void`	`setValue(java.lang.Object value)` Set the value of the `value` property.
`void`	`setValueExpression(java.lang.String name, javax.el.ValueExpression binding)`
`void`	`setVar(java.lang.String var)` Set the value of the `var` property.

Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, clearInitialState, decode, 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, 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

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

- 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
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataViewBase
```
public DataViewBase()
```
- Method Detail
  - getFamily
```
public java.lang.String getFamily()
```
    Specified by:
    
    getFamily in class javax.faces.component.UIComponent
  - setActiveRowIndex
```
public void setActiveRowIndex(java.lang.Integer activeRowIndex)
```
    Set the value of the activeRowIndex property.
    
    Contents: ActiveRowIndex property allows control of the row object index currently displayed in the detail region. The detail region components instances are not updated until DataView.initDetailContext() is called. initDetailContext is regularly called within the component phase iterations. A value of -1 (or any negative value) is interpreted as no row being active at that moment.
    
    Specified by:
    
    setActiveRowIndex in interface IDataView
  - getActiveRowIndex
```
public java.lang.Integer getActiveRowIndex()
```
    Return the value of the activeRowIndex property.
    
    Contents: ActiveRowIndex property allows control of the row object index currently displayed in the detail region. The detail region components instances are not updated until DataView.initDetailContext() is called. initDetailContext is regularly called within the component phase iterations. A value of -1 (or any negative value) is interpreted as no row being active at that moment.
    
    Specified by:
    
    getActiveRowIndex in interface IDataView
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    Set the value of the disabled property.
    
    Contents: Disables this component, so it does not receive focus or get submitted.
    
    Specified by:
    
    setDisabled in interface IDataView
  - isDisabled
```
public boolean isDisabled()
```
    Return the value of the disabled property.
    
    Contents: Disables this component, so it does not receive focus or get submitted.
    
    Specified by:
    
    isDisabled in interface IDataView
  - setRowIndexVar
```
public void setRowIndexVar(java.lang.String rowIndexVar)
```
    Set the value of the rowIndexVar property.
    
    Contents: Define the Expression Language variable name to be given to the index of the row object during iterative rendering, either in the ValueExpressions of a DataViewColumnModel defining a table cell or within the components of the detail region.
    
    Specified by:
    
    setRowIndexVar in interface IDataView
  - getRowIndexVar
```
public java.lang.String getRowIndexVar()
```
    Return the value of the rowIndexVar property.
    
    Contents: Define the Expression Language variable name to be given to the index of the row object during iterative rendering, either in the ValueExpressions of a DataViewColumnModel defining a table cell or within the components of the detail region.
    
    Specified by:
    
    getRowIndexVar in interface IDataView
  - setRowStripe
```
public void setRowStripe(boolean rowStripe)
```
    Set the value of the rowStripe property.
    
    Contents: Renders cell background shading on the odd numbered rows.
    
    Specified by:
    
    setRowStripe in interface IDataView
  - isRowStripe
```
public boolean isRowStripe()
```
    Return the value of the rowStripe property.
    
    Contents: Renders cell background shading on the odd numbered rows.
    
    Specified by:
    
    isRowStripe in interface IDataView
  - setRowStroke
```
public void setRowStroke(boolean rowStroke)
```
    Set the value of the rowStroke property.
    
    Contents: Renders faint bottom border to each row.
    
    Specified by:
    
    setRowStroke in interface IDataView
  - isRowStroke
```
public boolean isRowStroke()
```
    Return the value of the rowStroke property.
    
    Contents: Renders faint bottom border to each row. Default = 'true'.
    
    Specified by:
    
    isRowStroke in interface IDataView
  - setStyle
```
public void setStyle(java.lang.String style)
```
    Set the value of the style property.
    
    Contents: Sets the CSS style definition to be applied to this component.
    
    Specified by:
    
    setStyle in interface IDataView
  - getStyle
```
public java.lang.String getStyle()
```
    Return the value of the style property.
    
    Contents: Sets the CSS style definition to be applied to this component.
    
    Specified by:
    
    getStyle in interface IDataView
  - 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 IDataView
  - 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 IDataView
  - setValue
```
public void setValue(java.lang.Object value)
```
    Set the value of the value property.
    
    Contents: Define the index-based data model of DataView, currently supported types include List and instances of DataViewLazyDataModel.
    
    Specified by:
    
    setValue in interface IDataView
  - getValue
```
public java.lang.Object getValue()
```
    Return the value of the value property.
    
    Contents: Define the index-based data model of DataView, currently supported types include List and instances of DataViewLazyDataModel.
    
    Specified by:
    
    getValue in interface IDataView
  - setVar
```
public void setVar(java.lang.String var)
```
    Set the value of the var property.
    
    Contents: Define the Expression Language variable name to be given to the row object during iterative rendering, either in the ValueExpressions of a DataViewColumnModel defining a table cell or within the components of the detail region.
    
    Specified by:
    
    setVar in interface IDataView
  - getVar
```
public java.lang.String getVar()
```
    Return the value of the var property.
    
    Contents: Define the Expression Language variable name to be given to the row object during iterative rendering, either in the ValueExpressions of a DataViewColumnModel defining a table cell or within the components of the detail region.
    
    Specified by:
    
    getVar in interface IDataView
  - 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
  - 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
  - getDefaultRender
```
public java.lang.String getDefaultRender(java.lang.String event)
```
    Specified by:
    
    getDefaultRender in interface org.icefaces.ace.api.IceClientBehaviorHolder
  - getDefaultExecute
```
public java.lang.String getDefaultExecute(java.lang.String event)
```
    Specified by:
    
    getDefaultExecute in interface org.icefaces.ace.api.IceClientBehaviorHolder
  - getListenerArgument
```
public java.lang.String getListenerArgument(java.lang.String event)
```
    Specified by:
    
    getListenerArgument in interface org.icefaces.ace.api.IceClientBehaviorHolder
  - addClientBehavior
```
public void addClientBehavior(java.lang.String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
```
    Specified by:
    
    addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    addClientBehavior in class javax.faces.component.UIComponentBase

Class DataViewBase

Nested Class Summary

Field Summary

Fields inherited from class javax.faces.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class javax.faces.component.UIComponentBase

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

RENDERER_TYPE

Constructor Detail

DataViewBase

Method Detail

getFamily

setActiveRowIndex

getActiveRowIndex

setDisabled

isDisabled

setRowIndexVar

getRowIndexVar

setRowStripe

isRowStripe

setRowStroke

isRowStroke

setStyle

getStyle

setStyleClass

getStyleClass

setValue

getValue

setVar

getVar

isPropertySet

setValueExpression

getEventNames

getDefaultEventName

getDefaultRender

getDefaultExecute

getListenerArgument

addClientBehavior