Save This Page
Home » tomahawk-1.1.6-src » org.apache.myfaces.component.html » ext » [javadoc | source]
org.apache.myfaces.component.html.ext
public class: HtmlDataTable [javadoc | source]
java.lang.Object
   javax.faces.component.html.HtmlDataTable
      org.apache.myfaces.component.html.ext.HtmlDataTableHack
         org.apache.myfaces.component.html.ext.HtmlDataTable

All Implemented Interfaces:
    UserRoleAware, NewspaperTable, ExtendedComponentBase

Direct Known Subclasses:
    AutoUpdateDataTable

Field Summary
public static final  String NEWSPAPER_COLUMNS_PROPERTY    the property names 
public static final  String SPACER_FACET_NAME     
public static final  String NEWSPAPER_ORIENTATION_PROPERTY     
public static final  String COMPONENT_TYPE     
public static final  String DEFAULT_RENDERER_TYPE     
Constructor:
 public HtmlDataTable() 
Method from org.apache.myfaces.component.html.ext.HtmlDataTable Summary:
collapseAllDetails,   columnNameToIndex,   createDataModel,   createSortHeaderComponent,   encodeBegin,   encodeEnd,   expandAllDetails,   findComponent,   getBodyStyle,   getBodyStyleClass,   getClientId,   getDataModel,   getEnabledOnUserRole,   getFirst,   getForceIdIndexFormula,   getNewspaperColumns,   getNewspaperOrientation,   getPreservedDataModel,   getPreviousRowDataVar,   getRowCountVar,   getRowGroupStyle,   getRowGroupStyleClass,   getRowIndexVar,   getRowOnClick,   getRowOnDblClick,   getRowOnKeyDown,   getRowOnKeyPress,   getRowOnKeyUp,   getRowOnMouseDown,   getRowOnMouseMove,   getRowOnMouseOut,   getRowOnMouseOver,   getRowOnMouseUp,   getRowStyle,   getRowStyleClass,   getRows,   getSerializableDataModel,   getSortColumn,   getSortColumnIndex,   getSortProperty,   getSortPropertyFromEL,   getSortedColumnVar,   getSpacer,   getTableContext,   getVarDetailToggler,   getVisibleOnUserRole,   isCurrentDetailExpanded,   isDetailExpanded,   isExpandedEmpty,   isPreserveDataModel,   isPreserveSort,   isRendered,   isRenderedIfEmpty,   isSortAscending,   isSortHeaderNeeded,   isSortable,   isValidChildren,   processDecodes,   processUpdates,   processValidators,   restoreState,   saveState,   setBodyStyle,   setBodyStyleClass,   setEnabledOnUserRole,   setExpandedEmpty,   setFirst,   setForceIdIndexFormula,   setIsValidChildren,   setNewspaperColumns,   setNewspaperOrientation,   setPreserveDataModel,   setPreserveSort,   setPreservedDataModel,   setPreviousRowDataVar,   setRenderedIfEmpty,   setRowCountVar,   setRowGroupStyle,   setRowGroupStyleClass,   setRowIndex,   setRowIndexVar,   setRowOnClick,   setRowOnDblClick,   setRowOnKeyDown,   setRowOnKeyPress,   setRowOnKeyUp,   setRowOnMouseDown,   setRowOnMouseMove,   setRowOnMouseOut,   setRowOnMouseOver,   setRowOnMouseUp,   setRowStyle,   setRowStyleClass,   setRows,   setSortAscending,   setSortColumn,   setSortColumnIndex,   setSortProperty,   setSortable,   setSortedColumnVar,   setSpacer,   setVarDetailToggler,   setVisibleOnUserRole,   toggleDetail
Methods from org.apache.myfaces.component.html.ext.HtmlDataTableHack:
createDataModel,   encodeBegin,   encodeEnd,   getClientId,   getDataModel,   getRowCount,   getRowData,   getRowIndex,   hasErrorMessages,   isForceId,   isPreserveRowStates,   isRowAvailable,   processUpdates,   processValidators,   restoreDescendantComponentStates,   restoreState,   saveDescendantComponentStates,   saveState,   setDataModel,   setForceId,   setPreserveRowStates,   setRowIndex,   setValue,   setValueBinding
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.myfaces.component.html.ext.HtmlDataTable Detail:
 public  void collapseAllDetails() 
    Collapse all details
 protected int columnNameToIndex(String columnName) 
 protected DataModel createDataModel() 
 protected HtmlCommandSortHeader createSortHeaderComponent(FacesContext context,
    UIColumn parentColumn,
    UIComponent initialHeaderFacet,
    String propertyName) 
 public  void encodeBegin(FacesContext context) throws IOException 
 public  void encodeEnd(FacesContext context) throws IOException 
 public  void expandAllDetails() 
    Expand all details
 public UIComponent findComponent(String expr) 
 public String getBodyStyle() 
 public String getBodyStyleClass() 
 public String getClientId(FacesContext context) 
 protected DataModel getDataModel() 
 public String getEnabledOnUserRole() 
 public int getFirst() 
 public String getForceIdIndexFormula() 
 public int getNewspaperColumns() 
    Set the number of columns the table will be divided over.
 public String getNewspaperOrientation() 
 protected _SerializableDataModel getPreservedDataModel() 
 public String getPreviousRowDataVar() 
 public String getRowCountVar() 
 public String getRowGroupStyle() 
 public String getRowGroupStyleClass() 
 public String getRowIndexVar() 
 public String getRowOnClick() 
 public String getRowOnDblClick() 
 public String getRowOnKeyDown() 
 public String getRowOnKeyPress() 
 public String getRowOnKeyUp() 
 public String getRowOnMouseDown() 
 public String getRowOnMouseMove() 
 public String getRowOnMouseOut() 
 public String getRowOnMouseOver() 
 public String getRowOnMouseUp() 
 public String getRowStyle() 
 public String getRowStyleClass() 
 public int getRows() 
 public _SerializableDataModel getSerializableDataModel() 
 public String getSortColumn() 
 public int getSortColumnIndex() 
 public String getSortProperty() 
 protected String getSortPropertyFromEL(UIComponent component) 
 public String getSortedColumnVar() 
 public UIComponent getSpacer() 
    Gets the spacer facet, between each pair of newspaper columns.
 public TableContext getTableContext() 
 public String getVarDetailToggler() 
 public String getVisibleOnUserRole() 
 public boolean isCurrentDetailExpanded() 
 public boolean isDetailExpanded() 
    Return true if the current detail row is expanded.
 public boolean isExpandedEmpty() 
 public boolean isPreserveDataModel() 
 public boolean isPreserveSort() 
 public boolean isRendered() 
 public boolean isRenderedIfEmpty() 
 public boolean isSortAscending() 
 protected boolean isSortHeaderNeeded(UIColumn parentColumn,
    UIComponent headerFacet) 
 public boolean isSortable() 
 protected boolean isValidChildren() 
 public  void processDecodes(FacesContext context) 
 public  void processUpdates(FacesContext context) 
 public  void processValidators(FacesContext context) 
 public  void restoreState(FacesContext context,
    Object state) 
 public Object saveState(FacesContext context) 
 public  void setBodyStyle(String bodyStyle) 
 public  void setBodyStyleClass(String bodyStyleClass) 
 public  void setEnabledOnUserRole(String enabledOnUserRole) 
 public  void setExpandedEmpty(boolean expandedEmpty) 
    Clears expanded nodes set if expandedEmpty is true
 public  void setFirst(int first) 
 public  void setForceIdIndexFormula(String forceIdIndexFormula) 
 protected  void setIsValidChildren(boolean isValidChildren) 
 public  void setNewspaperColumns(int newspaperColumns) 
 public  void setNewspaperOrientation(String newspaperOrientation) 
    Set the orientation of the newspaper columns.
 public  void setPreserveDataModel(boolean preserveDataModel) 
 public  void setPreserveSort(boolean preserveSort) 
 protected  void setPreservedDataModel(_SerializableDataModel preservedDataModel) 
 public  void setPreviousRowDataVar(String previousRowDataVar) 
 public  void setRenderedIfEmpty(boolean renderedIfEmpty) 
 public  void setRowCountVar(String rowCountVar) 
 public  void setRowGroupStyle(String rowGroupStyle) 
 public  void setRowGroupStyleClass(String rowGroupStyleClass) 
 public  void setRowIndex(int rowIndex) 
 public  void setRowIndexVar(String rowIndexVar) 
 public  void setRowOnClick(String rowOnClick) 
 public  void setRowOnDblClick(String rowOnDblClick) 
 public  void setRowOnKeyDown(String rowOnKeyDown) 
 public  void setRowOnKeyPress(String rowOnKeyPress) 
 public  void setRowOnKeyUp(String rowOnKeyUp) 
 public  void setRowOnMouseDown(String rowOnMouseDown) 
 public  void setRowOnMouseMove(String rowOnMouseMove) 
 public  void setRowOnMouseOut(String rowOnMouseOut) 
 public  void setRowOnMouseOver(String rowOnMouseOver) 
 public  void setRowOnMouseUp(String rowOnMouseUp) 
 public  void setRowStyle(String rowStyle) 
 public  void setRowStyleClass(String rowStyleClass) 
 public  void setRows(int rows) 
 public  void setSortAscending(boolean sortAscending) 
 public  void setSortColumn(String sortColumn) 
    Specify what column the data should be sorted on.

    Note that calling this method immediately stores the value via any value-binding with name "sortColumn". This is done because this method is called by the HtmlCommandSortHeader component when the user has clicked on a column's sort header. In this case, the the model getter method mapped for name "value" needs to read this value in able to return the data in the desired order - but the HtmlCommandSortHeader component is usually "immediate" in order to avoid validating the enclosing form. Yes, this is rather hacky - but it works.

 public  void setSortColumnIndex(int sortColumnIndex) 
 public  void setSortProperty(String sortProperty) 
 public  void setSortable(boolean sortable) 
 public  void setSortedColumnVar(String sortedColumnVar) 
 public  void setSpacer(UIComponent spacer) 
 public  void setVarDetailToggler(String varDetailToggler) 
 public  void setVisibleOnUserRole(String visibleOnUserRole) 
 public  void toggleDetail() 
    Change the status of the current detail row from collapsed to expanded or viceversa.