com.ibm.xsp.component
Class UIDataTable

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIData
              extended by com.ibm.xsp.component.UIDataEx
                  extended by com.ibm.xsp.component.UIDataTable
All Implemented Interfaces:
FacesAjaxComponent, FacesAttrsObject, FacesDataIterator, FacesRefreshableComponent, FacesRowAttrsComponent, FacesRowIndex, ThemeControl, javax.faces.component.NamingContainer, javax.faces.component.StateHolder
Direct Known Subclasses:
XspDataTableEx

public class UIDataTable
extends UIDataEx
implements FacesAttrsObject, FacesRowAttrsComponent

Not intended to be subclassed by 3rd party developers of controls.

Since:
8.5.3, previously XspDataTableEx inherited directly from UIDataEx

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase
javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponent
javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry
 
Field Summary
static java.lang.String COMPONENT_TYPE
           
static java.lang.String RENDERER_TYPE
           
 
Fields inherited from class com.ibm.xsp.component.UIDataEx
AJAX_GETROWS, DEFAULT_ROWS_PER_PAGE, TOGGLE_ACTION_CLIENT_ID
 
Fields inherited from class javax.faces.component.UIData
COMPONENT_FAMILY
 
Fields inherited from class javax.faces.component.UIComponentBase
EMPTY_ITERATOR
 
Fields inherited from class javax.faces.component.UIComponent
_xspStateId
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
UIDataTable()
           
 
Method Summary
 void addAttr(Attr attr)
          Add an Attr, to appear as an attribute in the HTML output of this control or object tag.
 void addRowAttr(Attr rowAttr)
          Add an Attr, to appear as an attribute on the table row element.
 java.util.List<Attr> getAttrs()
          The extra attributes to be output on the base element at the root of this control or object tag.
 java.util.List<Attr> getRowAttrs()
          The extra attributes to be output on the table row element.
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setAttrs(java.util.List<Attr> attrs)
          This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.
 void setRowAttrs(java.util.List<Attr> rowAttrs)
          This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.
 
Methods inherited from class com.ibm.xsp.component.UIDataEx
_xspCleanTransientData, broadcast, computeDataModelKey, createDataModel, encodeBegin, encodeEnd, getAjaxUrl, getAjaxUrl, getData, getDataModel, getDataSource, getIndexVar, getLastCreatedDataModel, getNonChildClientId, getRefreshId, getRowCount, getRowCount, getRows, getStyleKitFamily, getValue, getZeroRows, gotoFirstPage, gotoLastPage, gotoNextPage, gotoPage, gotoPreviousPage, gotoRow, handles, invokeOnComponent, isNestedInDataIterator, isPartialExecute, isPartialRefresh, processAjaxGetRows, processAjaxRequest, processDecodes, processUpdates, processValidators, publishControlData, queueEvent, resetDataModel, resolveValue, revokeControlData, setData, setDataModel, setIndexVar, setRowIndex, setRows, setValue, setValueBinding, setVar, visitTree
 
Methods inherited from class javax.faces.component.UIData
getClientId, getFamily, getFirst, getFooter, getHeader, getRowData, getRowIndex, getVar, isRowAvailable, setFirst, setFooter, setHeader
 
Methods inherited from class javax.faces.component.UIComponentBase
_xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
Methods inherited from class javax.faces.component.UIComponent
_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, isVisitable, markInitialState, setControlState
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.xsp.component.FacesDataIterator
getFirst, getRowIndex, setFirst
 

Field Detail

COMPONENT_TYPE

public static java.lang.String COMPONENT_TYPE

RENDERER_TYPE

public static java.lang.String RENDERER_TYPE
Constructor Detail

UIDataTable

public UIDataTable()
Method Detail

getAttrs

public java.util.List<Attr> getAttrs()
The extra attributes to be output on the base element at the root of this control or object tag. This should only be used when none of the properties in the All Properties pane correspond to the desired attribute. This may return null. The addAttr(Attr) method should be used to add an Attr.

Specified by:
getAttrs in interface FacesAttrsObject

addAttr

public void addAttr(Attr attr)
Add an Attr, to appear as an attribute in the HTML output of this control or object tag.

Specified by:
addAttr in interface FacesAttrsObject
Parameters:
action -

setAttrs

public void setAttrs(java.util.List<Attr> attrs)
This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.


getRowAttrs

public java.util.List<Attr> getRowAttrs()
The extra attributes to be output on the table row element. This should only be used when none of the properties in the All Properties pane correspond to the desired attribute. This may return null. The addRowAttr(Attr) method should be used to add a row Attr.

Specified by:
getRowAttrs in interface FacesRowAttrsComponent

addRowAttr

public void addRowAttr(Attr rowAttr)
Add an Attr, to appear as an attribute on the table row element.

Specified by:
addRowAttr in interface FacesRowAttrsComponent
Parameters:
action -

setRowAttrs

public void setRowAttrs(java.util.List<Attr> rowAttrs)
This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.


restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class UIDataEx

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class UIDataEx