org.apache.myfaces.component.html.ext
Class HtmlDataTable

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--javax.faces.component.UIComponentBase
              |
              +--javax.faces.component.UIData
                    |
                    +--javax.faces.component.html.HtmlDataTable
                          |
                          +--org.apache.myfaces.component.html.ext.HtmlDataTableHack
                                |
                                +--org.apache.myfaces.component.html.ext.HtmlDataTable
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder, UserRoleAware

public class HtmlDataTable
extends org.apache.myfaces.component.html.ext.HtmlDataTableHack
implements UserRoleAware

Version:
$Revision: 1.20 $ $Date: 2005/03/29 11:40:50 $ $Log: HtmlDataTable.java,v $ Revision 1.20 2005/03/29 11:40:50 matzew added new crosstable component (x:columns). Contributed by Mathias Broekelmann Revision 1.19 2005/03/21 12:33:46 svieujot Set x:dataTable preserveDataModel default value to false. Revision 1.18 2005/03/19 04:27:55 svieujot Align default values for preserveDataModel and preserveSort between HtmlDataTable.java, HtmlDataTableTag.java and the TLD. Revision 1.17 2005/03/04 01:21:22 mmarinschek reverted bug fix as it introduced several new bugs with data-table Revision 1.15 2004/10/13 11:50:56 matze renamed packages to org.apache Revision 1.14 2004/09/13 15:59:44 manolito fixed problems with nested UIData and HtmlDataTable components Revision 1.13 2004/09/10 14:15:00 manolito new previousRowDataVar attribute in extended HtmlDataTable Revision 1.12 2004/08/20 07:14:39 manolito HtmlDataTable now also supports rowIndexVar and rowCountVar Revision 1.11 2004/08/10 13:29:59 manolito full revision of extended HtmlDataTable so that there is no more cache problem Revision 1.10 2004/07/01 21:53:05 mwessendorf ASF switch Revision 1.9 2004/06/22 14:33:29 royalts no message Revision 1.8 2004/06/21 16:01:57 royalts setSortAscending(...) and setSortColumn have to update model their own, because processUdates won't be executed. Revision 1.7 2004/06/21 14:43:20 manolito no more calls to getRowCount to determine if list is empty before encodeBegin was called Revision 1.6 2004/06/21 12:15:29 manolito encodeBegin in UIData examines descendants valid flag recursivly now before refreshing DataModel Revision 1.5 2004/05/21 10:39:26 manolito new renderedIfEmpty attribute in ext. HtmlDataTable component Revision 1.4 2004/05/18 14:31:36 manolito user role support completely moved to components source tree Revision 1.3 2004/05/18 11:22:44 manolito optimized local value handling, so that getValue of UIData is only called when needed
Author:
Thomas Spiegl (latest modification by $Author: matzew $), Manfred Geiler

Field Summary
protected  javax.faces.model.DataModel _dataModel
           
protected  java.util.HashMap _dataModelMap
           
protected  boolean _saveDescendantStates
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIData
COMPONENT_FAMILY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
HtmlDataTable()
           
 
Method Summary
 void broadcast(javax.faces.event.FacesEvent event)
           
 void encodeBegin(javax.faces.context.FacesContext context)
           
 void encodeChildren(javax.faces.context.FacesContext context)
           
 void encodeEnd(javax.faces.context.FacesContext context)
           
 java.lang.String getEnabledOnUserRole()
           
 int getFirst()
           
 java.lang.String getPreviousRowDataVar()
           
 int getRowCount()
           
 java.lang.String getRowCountVar()
           
 java.lang.Object getRowData()
           
 int getRowIndex()
           
 java.lang.String getRowIndexVar()
           
 int getRows()
           
 org.apache.myfaces.component.html.ext._SerializableDataModel getSerializableDataModel()
           
 java.lang.String getSortColumn()
           
 java.lang.String getVisibleOnUserRole()
           
 boolean isPreserveDataModel()
           
 boolean isPreserveSort()
           
 boolean isRendered()
           
 boolean isRenderedIfEmpty()
           
 boolean isRowAvailable()
           
 boolean isSortAscending()
           
 void processDecodes(javax.faces.context.FacesContext context)
           
 void processRestoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object processSaveState(javax.faces.context.FacesContext context)
           
 void processUpdates(javax.faces.context.FacesContext context)
           
 void processValidators(javax.faces.context.FacesContext context)
           
protected  void refresh(javax.faces.context.FacesContext context)
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
           
 void setFirst(int first)
           
 void setPreserveDataModel(boolean preserveDataModel)
           
 void setPreserveSort(boolean preserveSort)
           
 void setPreviousRowDataVar(java.lang.String previousRowDataVar)
           
 void setRenderedIfEmpty(boolean renderedIfEmpty)
           
 void setRowCountVar(java.lang.String rowCountVar)
           
 void setRowIndex(int rowIndex)
           
 void setRowIndexVar(java.lang.String rowIndexVar)
           
 void setRows(int rows)
           
 void setSortAscending(boolean sortAscending)
           
 void setSortColumn(java.lang.String sortColumn)
           
 void setValue(java.lang.Object value)
           
 void setValueBinding(java.lang.String name, javax.faces.el.ValueBinding binding)
           
 void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
           
 
Methods inherited from class javax.faces.component.html.HtmlDataTable
getBgcolor, getBorder, getCellpadding, getCellspacing, getColumnClasses, getDir, getFooterClass, getFrame, getHeaderClass, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRowClasses, getRules, getStyle, getStyleClass, getSummary, getTitle, getWidth, setBgcolor, setBorder, setCellpadding, setCellspacing, setColumnClasses, setDir, setFooterClass, setFrame, setHeaderClass, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRowClasses, setRules, setStyle, setStyleClass, setSummary, setTitle, setWidth
 
Methods inherited from class javax.faces.component.UIData
getClientId, getFamily, getFooter, getHeader, getValue, getVar, queueEvent, setFooter, setHeader, setVar
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, decode, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
 
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

_dataModel

protected javax.faces.model.DataModel _dataModel

_dataModelMap

protected java.util.HashMap _dataModelMap

_saveDescendantStates

protected transient boolean _saveDescendantStates
Constructor Detail

HtmlDataTable

public HtmlDataTable()
Method Detail

setValue

public void setValue(java.lang.Object value)
Overrides:
setValue in class javax.faces.component.UIData

setRowIndex

public void setRowIndex(int rowIndex)
Overrides:
setRowIndex in class org.apache.myfaces.component.html.ext.HtmlDataTableHack

processRestoreState

public void processRestoreState(javax.faces.context.FacesContext context,
                                java.lang.Object state)
Overrides:
processRestoreState in class javax.faces.component.UIComponentBase

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)
Overrides:
processDecodes in class javax.faces.component.UIData

processValidators

public void processValidators(javax.faces.context.FacesContext context)
Overrides:
processValidators in class javax.faces.component.UIData

processSaveState

public java.lang.Object processSaveState(javax.faces.context.FacesContext context)
Overrides:
processSaveState in class javax.faces.component.UIComponentBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
Overrides:
broadcast in class javax.faces.component.UIData
javax.faces.event.AbortProcessingException

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)
Overrides:
processUpdates in class javax.faces.component.UIData

refresh

protected void refresh(javax.faces.context.FacesContext context)

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException
Overrides:
encodeBegin in class javax.faces.component.UIData
java.io.IOException

encodeChildren

public void encodeChildren(javax.faces.context.FacesContext context)
                    throws java.io.IOException
Overrides:
encodeChildren in class javax.faces.component.UIComponentBase
java.io.IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)
               throws java.io.IOException
Overrides:
encodeEnd in class javax.faces.component.UIData
java.io.IOException

getFirst

public int getFirst()
Overrides:
getFirst in class javax.faces.component.UIData

setFirst

public void setFirst(int first)
Overrides:
setFirst in class javax.faces.component.UIData

getRows

public int getRows()
Overrides:
getRows in class javax.faces.component.UIData

setRows

public void setRows(int rows)
Overrides:
setRows in class javax.faces.component.UIData

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class org.apache.myfaces.component.html.ext.HtmlDataTableHack

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 org.apache.myfaces.component.html.ext.HtmlDataTableHack

getSerializableDataModel

public org.apache.myfaces.component.html.ext._SerializableDataModel getSerializableDataModel()

isRendered

public boolean isRendered()
Overrides:
isRendered in class javax.faces.component.UIComponentBase

setSortColumn

public void setSortColumn(java.lang.String sortColumn)

getSortColumn

public java.lang.String getSortColumn()

setSortAscending

public void setSortAscending(boolean sortAscending)

isSortAscending

public boolean isSortAscending()

setPreserveDataModel

public void setPreserveDataModel(boolean preserveDataModel)

isPreserveDataModel

public boolean isPreserveDataModel()

setPreserveSort

public void setPreserveSort(boolean preserveSort)

isPreserveSort

public boolean isPreserveSort()

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
Specified by:
setEnabledOnUserRole in interface UserRoleAware

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()
Specified by:
getEnabledOnUserRole in interface UserRoleAware

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
Specified by:
setVisibleOnUserRole in interface UserRoleAware

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()
Specified by:
getVisibleOnUserRole in interface UserRoleAware

setRenderedIfEmpty

public void setRenderedIfEmpty(boolean renderedIfEmpty)

isRenderedIfEmpty

public boolean isRenderedIfEmpty()

setRowIndexVar

public void setRowIndexVar(java.lang.String rowIndexVar)

getRowIndexVar

public java.lang.String getRowIndexVar()

setRowCountVar

public void setRowCountVar(java.lang.String rowCountVar)

getRowCountVar

public java.lang.String getRowCountVar()

setPreviousRowDataVar

public void setPreviousRowDataVar(java.lang.String previousRowDataVar)

getPreviousRowDataVar

public java.lang.String getPreviousRowDataVar()

isRowAvailable

public boolean isRowAvailable()
Overrides:
isRowAvailable in class javax.faces.component.UIData

getRowCount

public int getRowCount()
Overrides:
getRowCount in class javax.faces.component.UIData

getRowData

public java.lang.Object getRowData()
Overrides:
getRowData in class javax.faces.component.UIData

getRowIndex

public int getRowIndex()
Overrides:
getRowIndex in class javax.faces.component.UIData

setValueBinding

public void setValueBinding(java.lang.String name,
                            javax.faces.el.ValueBinding binding)
Overrides:
setValueBinding in class javax.faces.component.UIData