|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.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
public class HtmlDataTable
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
DEFAULT_RENDERER_TYPE
|
static java.lang.String |
NEWSPAPER_COLUMNS_PROPERTY
the property names |
static java.lang.String |
NEWSPAPER_ORIENTATION_PROPERTY
|
static java.lang.String |
SPACER_FACET_NAME
|
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 org.apache.myfaces.component.NewspaperTable |
---|
NEWSPAPER_HORIZONTAL_ORIENTATION |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
HtmlDataTable()
|
Method Summary | |
---|---|
void |
collapseAllDetails()
Collapse all details |
protected int |
columnNameToIndex(java.lang.String columnName)
|
protected javax.faces.model.DataModel |
createDataModel()
Creates a new DataModel around the current value. |
protected HtmlCommandSortHeader |
createSortHeaderComponent(javax.faces.context.FacesContext context,
javax.faces.component.UIColumn parentColumn,
javax.faces.component.UIComponent initialHeaderFacet,
java.lang.String propertyName)
|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
void |
encodeEnd(javax.faces.context.FacesContext context)
|
void |
expandAllDetails()
Expand all details |
javax.faces.component.UIComponent |
findComponent(java.lang.String expr)
|
java.lang.String |
getBodyStyle()
|
java.lang.String |
getBodyStyleClass()
|
java.lang.String |
getClientId(javax.faces.context.FacesContext context)
Hack since RI does not call getRowIndex() |
protected javax.faces.model.DataModel |
getDataModel()
|
java.lang.String |
getEnabledOnUserRole()
|
int |
getFirst()
|
java.lang.String |
getForceIdIndexFormula()
|
int |
getNewspaperColumns()
Set the number of columns the table will be divided over. |
java.lang.String |
getNewspaperOrientation()
|
protected org.apache.myfaces.component.html.ext._SerializableDataModel |
getPreservedDataModel()
|
java.lang.String |
getPreviousRowDataVar()
|
java.lang.String |
getRowCountVar()
|
java.lang.String |
getRowGroupStyle()
|
java.lang.String |
getRowGroupStyleClass()
|
java.lang.String |
getRowIndexVar()
|
java.lang.String |
getRowOnClick()
|
java.lang.String |
getRowOnDblClick()
|
java.lang.String |
getRowOnKeyDown()
|
java.lang.String |
getRowOnKeyPress()
|
java.lang.String |
getRowOnKeyUp()
|
java.lang.String |
getRowOnMouseDown()
|
java.lang.String |
getRowOnMouseMove()
|
java.lang.String |
getRowOnMouseOut()
|
java.lang.String |
getRowOnMouseOver()
|
java.lang.String |
getRowOnMouseUp()
|
int |
getRows()
|
java.lang.String |
getRowStyle()
|
java.lang.String |
getRowStyleClass()
|
org.apache.myfaces.component.html.ext._SerializableDataModel |
getSerializableDataModel()
|
java.lang.String |
getSortColumn()
|
int |
getSortColumnIndex()
|
java.lang.String |
getSortedColumnVar()
|
java.lang.String |
getSortProperty()
|
protected java.lang.String |
getSortPropertyFromEL(javax.faces.component.UIComponent component)
|
javax.faces.component.UIComponent |
getSpacer()
Gets the spacer facet, between each pair of newspaper columns. |
TableContext |
getTableContext()
|
java.lang.String |
getVarDetailToggler()
|
java.lang.String |
getVisibleOnUserRole()
|
boolean |
isCurrentDetailExpanded()
|
boolean |
isDetailExpanded()
Return true if the current detail row is expanded. |
boolean |
isExpandedEmpty()
|
boolean |
isPreserveDataModel()
|
boolean |
isPreserveSort()
|
boolean |
isRendered()
|
boolean |
isRenderedIfEmpty()
|
boolean |
isSortable()
|
boolean |
isSortAscending()
|
protected boolean |
isSortHeaderNeeded(javax.faces.component.UIColumn parentColumn,
javax.faces.component.UIComponent headerFacet)
|
protected boolean |
isValidChildren()
|
void |
processDecodes(javax.faces.context.FacesContext context)
|
void |
processUpdates(javax.faces.context.FacesContext context)
|
void |
processValidators(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 |
setBodyStyle(java.lang.String bodyStyle)
|
void |
setBodyStyleClass(java.lang.String bodyStyleClass)
|
void |
setEnabledOnUserRole(java.lang.String enabledOnUserRole)
|
void |
setExpandedEmpty(boolean expandedEmpty)
Clears expanded nodes set if expandedEmpty is true |
void |
setFirst(int first)
|
void |
setForceIdIndexFormula(java.lang.String forceIdIndexFormula)
|
protected void |
setIsValidChildren(boolean isValidChildren)
|
void |
setNewspaperColumns(int newspaperColumns)
|
void |
setNewspaperOrientation(java.lang.String newspaperOrientation)
Set the orientation of the newspaper columns. |
void |
setPreserveDataModel(boolean preserveDataModel)
|
protected void |
setPreservedDataModel(org.apache.myfaces.component.html.ext._SerializableDataModel preservedDataModel)
|
void |
setPreserveSort(boolean preserveSort)
|
void |
setPreviousRowDataVar(java.lang.String previousRowDataVar)
|
void |
setRenderedIfEmpty(boolean renderedIfEmpty)
|
void |
setRowCountVar(java.lang.String rowCountVar)
|
void |
setRowGroupStyle(java.lang.String rowGroupStyle)
|
void |
setRowGroupStyleClass(java.lang.String rowGroupStyleClass)
|
void |
setRowIndex(int rowIndex)
|
void |
setRowIndexVar(java.lang.String rowIndexVar)
|
void |
setRowOnClick(java.lang.String rowOnClick)
|
void |
setRowOnDblClick(java.lang.String rowOnDblClick)
|
void |
setRowOnKeyDown(java.lang.String rowOnKeyDown)
|
void |
setRowOnKeyPress(java.lang.String rowOnKeyPress)
|
void |
setRowOnKeyUp(java.lang.String rowOnKeyUp)
|
void |
setRowOnMouseDown(java.lang.String rowOnMouseDown)
|
void |
setRowOnMouseMove(java.lang.String rowOnMouseMove)
|
void |
setRowOnMouseOut(java.lang.String rowOnMouseOut)
|
void |
setRowOnMouseOver(java.lang.String rowOnMouseOver)
|
void |
setRowOnMouseUp(java.lang.String rowOnMouseUp)
|
void |
setRows(int rows)
|
void |
setRowStyle(java.lang.String rowStyle)
|
void |
setRowStyleClass(java.lang.String rowStyleClass)
|
void |
setSortable(boolean sortable)
|
void |
setSortAscending(boolean sortAscending)
|
void |
setSortColumn(java.lang.String sortColumn)
Specify what column the data should be sorted on. |
void |
setSortColumnIndex(int sortColumnIndex)
|
void |
setSortedColumnVar(java.lang.String sortedColumnVar)
|
void |
setSortProperty(java.lang.String sortProperty)
|
void |
setSpacer(javax.faces.component.UIComponent spacer)
|
void |
setVarDetailToggler(java.lang.String varDetailToggler)
|
void |
setVisibleOnUserRole(java.lang.String visibleOnUserRole)
|
void |
toggleDetail()
Change the status of the current detail row from collapsed to expanded or viceversa. |
Methods inherited from class org.apache.myfaces.component.html.ext.HtmlDataTableHack |
---|
getRowCount, getRowData, getRowIndex, hasErrorMessages, isForceId, isPreserveRowStates, isRowAvailable, restoreDescendantComponentStates, saveDescendantComponentStates, setDataModel, setForceId, setPreserveRowStates, setValue, setValueBinding |
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 |
---|
broadcast, getFamily, getFooter, getHeader, getValue, getVar, queueEvent, setFooter, setHeader, setVar |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, decode, encodeChildren, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, 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 |
---|
public static final java.lang.String NEWSPAPER_COLUMNS_PROPERTY
public static final java.lang.String SPACER_FACET_NAME
public static final java.lang.String NEWSPAPER_ORIENTATION_PROPERTY
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String DEFAULT_RENDERER_TYPE
Constructor Detail |
---|
public HtmlDataTable()
Method Detail |
---|
public TableContext getTableContext()
public java.lang.String getClientId(javax.faces.context.FacesContext context)
HtmlDataTableHack
getClientId
in class HtmlDataTableHack
public javax.faces.component.UIComponent findComponent(java.lang.String expr)
findComponent
in class javax.faces.component.UIComponentBase
public void setRowIndex(int rowIndex)
setRowIndex
in class HtmlDataTableHack
public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class javax.faces.component.UIData
public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class HtmlDataTableHack
UIData.processValidators(javax.faces.context.FacesContext)
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class HtmlDataTableHack
UIData.processUpdates(javax.faces.context.FacesContext)
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class HtmlDataTableHack
java.io.IOException
UIData.encodeBegin(javax.faces.context.FacesContext)
protected boolean isSortHeaderNeeded(javax.faces.component.UIColumn parentColumn, javax.faces.component.UIComponent headerFacet)
protected HtmlCommandSortHeader createSortHeaderComponent(javax.faces.context.FacesContext context, javax.faces.component.UIColumn parentColumn, javax.faces.component.UIComponent initialHeaderFacet, java.lang.String propertyName)
protected java.lang.String getSortPropertyFromEL(javax.faces.component.UIComponent component)
protected int columnNameToIndex(java.lang.String columnName)
public void encodeEnd(javax.faces.context.FacesContext context) throws java.io.IOException
encodeEnd
in class HtmlDataTableHack
java.io.IOException
UIData.encodeEnd(javax.faces.context.FacesContext)
public int getFirst()
getFirst
in class javax.faces.component.UIData
public void setFirst(int first)
setFirst
in class javax.faces.component.UIData
public int getRows()
getRows
in class javax.faces.component.UIData
public void setRows(int rows)
setRows
in class javax.faces.component.UIData
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class HtmlDataTableHack
protected javax.faces.model.DataModel getDataModel()
getDataModel
in class HtmlDataTableHack
HtmlDataTableHack.getDataModel()
protected javax.faces.model.DataModel createDataModel()
HtmlDataTableHack
createDataModel
in class HtmlDataTableHack
HtmlDataTableHack.createDataModel()
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class HtmlDataTableHack
public org.apache.myfaces.component.html.ext._SerializableDataModel getSerializableDataModel()
public boolean isRendered()
isRendered
in class javax.faces.component.UIComponentBase
public void setForceIdIndexFormula(java.lang.String forceIdIndexFormula)
public java.lang.String getForceIdIndexFormula()
public void setSortColumn(java.lang.String sortColumn)
public java.lang.String getSortColumn()
public void setSortAscending(boolean sortAscending)
public boolean isSortAscending()
public void setSortProperty(java.lang.String sortProperty)
public java.lang.String getSortProperty()
public void setSortable(boolean sortable)
public boolean isSortable()
public void setRowOnMouseOver(java.lang.String rowOnMouseOver)
public java.lang.String getRowOnMouseOver()
public void setRowOnMouseOut(java.lang.String rowOnMouseOut)
public java.lang.String getRowOnMouseOut()
public void setRowOnClick(java.lang.String rowOnClick)
public java.lang.String getRowOnClick()
public void setRowOnDblClick(java.lang.String rowOnDblClick)
public java.lang.String getRowOnDblClick()
public java.lang.String getRowOnKeyDown()
public void setRowOnKeyDown(java.lang.String rowOnKeyDown)
public java.lang.String getRowOnKeyPress()
public void setRowOnKeyPress(java.lang.String rowOnKeyPress)
public java.lang.String getRowOnKeyUp()
public void setRowOnKeyUp(java.lang.String rowOnKeyUp)
public java.lang.String getRowStyleClass()
public void setRowStyleClass(java.lang.String rowStyleClass)
public java.lang.String getRowStyle()
public void setRowStyle(java.lang.String rowStyle)
public java.lang.String getRowOnMouseDown()
public void setRowOnMouseDown(java.lang.String rowOnMouseDown)
public java.lang.String getRowOnMouseMove()
public void setRowOnMouseMove(java.lang.String rowOnMouseMove)
public java.lang.String getRowOnMouseUp()
public void setRowOnMouseUp(java.lang.String rowOnMouseUp)
protected boolean isValidChildren()
protected void setIsValidChildren(boolean isValidChildren)
protected org.apache.myfaces.component.html.ext._SerializableDataModel getPreservedDataModel()
protected void setPreservedDataModel(org.apache.myfaces.component.html.ext._SerializableDataModel preservedDataModel)
public boolean isCurrentDetailExpanded()
public void setVarDetailToggler(java.lang.String varDetailToggler)
public java.lang.String getVarDetailToggler()
public java.lang.String getRowGroupStyle()
public void setRowGroupStyle(java.lang.String rowGroupStyle)
public java.lang.String getRowGroupStyleClass()
public void setRowGroupStyleClass(java.lang.String rowGroupStyleClass)
public java.lang.String getBodyStyle()
public void setBodyStyle(java.lang.String bodyStyle)
public java.lang.String getBodyStyleClass()
public void setBodyStyleClass(java.lang.String bodyStyleClass)
public void toggleDetail()
public boolean isDetailExpanded()
public int getSortColumnIndex()
public void setSortColumnIndex(int sortColumnIndex)
public int getNewspaperColumns()
getNewspaperColumns
in interface NewspaperTable
public void setNewspaperColumns(int newspaperColumns)
public void setNewspaperOrientation(java.lang.String newspaperOrientation)
public java.lang.String getNewspaperOrientation()
getNewspaperOrientation
in interface NewspaperTable
public javax.faces.component.UIComponent getSpacer()
getSpacer
in interface NewspaperTable
public void setSpacer(javax.faces.component.UIComponent spacer)
public void expandAllDetails()
public void collapseAllDetails()
public boolean isExpandedEmpty()
public void setExpandedEmpty(boolean expandedEmpty)
expandedEmpty
- public void setPreserveDataModel(boolean preserveDataModel)
public boolean isPreserveDataModel()
public void setPreserveSort(boolean preserveSort)
public boolean isPreserveSort()
public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
setEnabledOnUserRole
in interface UserRoleAware
public java.lang.String getEnabledOnUserRole()
getEnabledOnUserRole
in interface UserRoleAware
public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
setVisibleOnUserRole
in interface UserRoleAware
public java.lang.String getVisibleOnUserRole()
getVisibleOnUserRole
in interface UserRoleAware
public void setRenderedIfEmpty(boolean renderedIfEmpty)
public boolean isRenderedIfEmpty()
public void setRowIndexVar(java.lang.String rowIndexVar)
public java.lang.String getRowIndexVar()
public void setRowCountVar(java.lang.String rowCountVar)
public java.lang.String getRowCountVar()
public void setPreviousRowDataVar(java.lang.String previousRowDataVar)
public java.lang.String getPreviousRowDataVar()
public void setSortedColumnVar(java.lang.String sortedColumnVar)
public java.lang.String getSortedColumnVar()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |