|
||||||||||
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.AbstractHtmlDataTable
public abstract class AbstractHtmlDataTable
The MyFacesDataTable extends the standard JSF DataTable by two
important features:
Field Summary | |
---|---|
static String |
COMPONENT_TYPE
|
static String |
DEFAULT_RENDERER_TYPE
|
static String |
DETAIL_STAMP_FACET_NAME
|
static String |
NEWSPAPER_COLUMNS_PROPERTY
the property names |
static String |
NEWSPAPER_ORIENTATION_PROPERTY
|
static 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 | |
---|---|
AbstractHtmlDataTable()
|
Method Summary | |
---|---|
void |
collapseAllDetails()
Collapse all details |
protected int |
columnNameToIndex(String columnName)
|
protected javax.faces.model.DataModel |
createDataModel()
Creates a new DataModel around the current value. |
protected org.apache.myfaces.custom.sortheader.HtmlCommandSortHeader |
createSortHeaderComponent(javax.faces.context.FacesContext context,
javax.faces.component.UIColumn parentColumn,
javax.faces.component.UIComponent initialHeaderFacet,
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(String expr)
|
abstract String |
getAlign()
HTML: Specifies the horizontal alignment of this element. |
abstract String |
getBodyStyle()
Corresponds to the HTML style attribute for the table body tag |
abstract String |
getBodyStyleClass()
Corresponds to the HTML class attribute for the table body tag. |
String |
getClientId(javax.faces.context.FacesContext context)
Hack since RI does not call getRowIndex() |
abstract String |
getDatafld()
Reserved for future use. |
abstract String |
getDataformatas()
Reserved for future use. |
protected javax.faces.model.DataModel |
getDataModel()
|
abstract String |
getDatasrc()
Reserved for future use. |
javax.faces.component.UIComponent |
getDetailStamp()
This facet renders an additional row after or before (according to detailStampLocation value) the current row, usually containing additional information of the related row. |
abstract String |
getDetailStampLocation()
before|after - where to render the detailStamp, before the actual row or after it. |
int |
getFirst()
The index of the first row to be displayed, where 0 is the first row. |
String |
getForceIdIndexFormula()
A formula that overrides the default row index in the construction of table's body components. |
abstract int |
getNewspaperColumns()
The number of columns to wrap the table over. |
abstract String |
getNewspaperOrientation()
The orientation of the newspaper columns in the newspaper table - "horizontal" or "vertical". |
protected org.apache.myfaces.component.html.ext._SerializableDataModel |
getPreservedDataModel()
|
abstract String |
getPreviousRowDataVar()
A parameter name, under which the previous RowData Object is set in request scope similar to the rowIndexVar and rowCountVar parameters. |
abstract String |
getRowCountVar()
A parameter name, under which the rowCount is set in request scope similar to the var parameter. |
abstract String |
getRowGroupStyle()
Corresponds to the HTML style attribute for grouped rows. |
abstract String |
getRowGroupStyleClass()
StyleClass for grouped rows. |
abstract String |
getRowId()
The id to use for |
abstract String |
getRowIndexVar()
A parameter name, under which the current rowIndex is set in request scope similar to the var parameter. |
abstract String |
getRowOnClick()
Defines a JavaScript onclick event handler for each table row |
abstract String |
getRowOnDblClick()
Defines a JavaScript ondblclick event handler for each table row |
abstract String |
getRowOnKeyDown()
Defines a JavaScript onkeydown event handler for each table row |
abstract String |
getRowOnKeyPress()
Defines a JavaScript onkeypress event handler for each table row |
abstract String |
getRowOnKeyUp()
Defines a JavaScript onkeyup event handler for each table row |
abstract String |
getRowOnMouseDown()
Defines a JavaScript onmpusedown event handler for each table row |
abstract String |
getRowOnMouseMove()
Defines a JavaScript onmousemove event handler for each table row |
abstract String |
getRowOnMouseOut()
Defines a JavaScript onmouseout event handler for each table row |
abstract String |
getRowOnMouseOver()
Defines a JavaScript onmouseover event handler for each table row |
abstract String |
getRowOnMouseUp()
Defines a JavaScript onmouseup event handler for each table row |
int |
getRows()
The number of rows to be displayed. |
String |
getRowStyle()
Corresponds to the HTML style attribute for the row tr tag. |
String |
getRowStyleClass()
Corresponds to the HTML class attribute for the row tr tag. |
org.apache.myfaces.component.html.ext._SerializableDataModel |
getSerializableDataModel()
|
String |
getSortColumn()
Value reference to a model property that gives the current sort column name. |
int |
getSortColumnIndex()
|
abstract String |
getSortedColumnVar()
A parameter name, under which the a boolean is set in request scope similar to the var parameter. |
String |
getSortProperty()
|
protected String |
getSortPropertyFromEL(javax.faces.component.UIComponent component)
|
javax.faces.component.UIComponent |
getSpacer()
Gets the spacer facet, between each pair of newspaper columns. |
TableContext |
getTableContext()
|
abstract String |
getValueType()
Indicate the expected type of the EL expression pointed by value property. |
String |
getVarDetailToggler()
This variable has the boolean property "currentdetailExpanded" which is true if the current detail row is expanded and the action method "toggleDetail" which expand/collapse the current detail row. |
boolean |
isCurrentDetailExpanded()
|
boolean |
isDetailExpanded()
Return true if the current detail row is expanded. |
abstract boolean |
isDetailStampExpandedDefault()
true|false - true if the detailStamp should be expanded by default. |
abstract boolean |
isEmbedded()
Avoids rendering the html table tags, thus, giving you a table rendering just rows. |
boolean |
isExpandedEmpty()
|
boolean |
isPreserveDataModel()
Indicates whether the state of the whole DataModel should be saved and restored. |
boolean |
isPreserveSort()
Indicates whether the state of the sortColumn and sortAscending attribute should be saved and restored and written back to the model during the update model phase. |
boolean |
isRendered()
|
abstract boolean |
isRenderedIfEmpty()
Indicates whether this table should be rendered if the underlying DataModel is empty. |
abstract boolean |
isSortable()
Define if the table is sortable or not |
boolean |
isSortAscending()
Value reference to a model property that gives the current sort direction. |
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)
|
protected void |
restoreDescendantComponentStates(Object state)
|
void |
restoreState(javax.faces.context.FacesContext context,
Object state)
|
protected Object |
saveDescendantComponentStates()
|
Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setDetailStamp(javax.faces.component.UIComponent facet)
|
void |
setExpandedEmpty(boolean expandedEmpty)
Clears expanded nodes set if expandedEmpty is true |
void |
setFirst(int first)
|
void |
setForceIdIndexFormula(String forceIdIndexFormula)
|
protected void |
setIsValidChildren(boolean isValidChildren)
|
void |
setPreserveDataModel(boolean preserveDataModel)
|
protected void |
setPreservedDataModel(org.apache.myfaces.component.html.ext._SerializableDataModel preservedDataModel)
|
void |
setPreserveSort(boolean preserveSort)
|
void |
setRowIndex(int rowIndex)
|
void |
setRows(int rows)
|
void |
setRowStyle(String rowStyle)
|
void |
setRowStyleClass(String rowStyleClass)
|
void |
setSortAscending(boolean sortAscending)
|
void |
setSortColumn(String sortColumn)
Specify what column the data should be sorted on. |
void |
setSortColumnIndex(int sortColumnIndex)
|
void |
setSortProperty(String sortProperty)
The name of a javabean property on which the table is sorted. |
void |
setSpacer(javax.faces.component.UIComponent spacer)
|
void |
setVarDetailToggler(String varDetailToggler)
|
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 |
---|
checkUpdateModelError, clearRowStates, deleteRowStateForRow, getDerivedRowKeyPrefix, getDerivedSubClientId, getRowCount, getRowData, getRowIndex, getRowKey, hasErrorMessages, isForceId, isForceIdIndex, isPreserveRowStates, isRowAvailable, restoreDescendantComponentStates, saveDescendantComponentStates, setDataModel, setDerivedRowKeyPrefix, setForceId, setForceIdIndex, setPreserveRowStates, setRowKey, 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 |
Methods inherited from interface org.apache.myfaces.component.UserRoleAware |
---|
getEnabledOnUserRole, getVisibleOnUserRole, setEnabledOnUserRole, setVisibleOnUserRole |
Field Detail |
---|
public static final String NEWSPAPER_COLUMNS_PROPERTY
public static final String SPACER_FACET_NAME
public static final String NEWSPAPER_ORIENTATION_PROPERTY
public static final String DETAIL_STAMP_FACET_NAME
public static final String COMPONENT_TYPE
public static final String DEFAULT_RENDERER_TYPE
Constructor Detail |
---|
public AbstractHtmlDataTable()
Method Detail |
---|
public TableContext getTableContext()
public void setDetailStamp(javax.faces.component.UIComponent facet)
public javax.faces.component.UIComponent getDetailStamp()
public String getClientId(javax.faces.context.FacesContext context)
HtmlDataTableHack
getClientId
in class HtmlDataTableHack
public javax.faces.component.UIComponent findComponent(String expr)
findComponent
in class javax.faces.component.UIComponentBase
public void setRowIndex(int rowIndex)
setRowIndex
in class HtmlDataTableHack
protected Object saveDescendantComponentStates()
saveDescendantComponentStates
in class HtmlDataTableHack
protected void restoreDescendantComponentStates(Object state)
restoreDescendantComponentStates
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 IOException
encodeBegin
in class HtmlDataTableHack
IOException
UIData.encodeBegin(javax.faces.context.FacesContext)
protected boolean isSortHeaderNeeded(javax.faces.component.UIColumn parentColumn, javax.faces.component.UIComponent headerFacet)
protected org.apache.myfaces.custom.sortheader.HtmlCommandSortHeader createSortHeaderComponent(javax.faces.context.FacesContext context, javax.faces.component.UIColumn parentColumn, javax.faces.component.UIComponent initialHeaderFacet, String propertyName)
protected String getSortPropertyFromEL(javax.faces.component.UIComponent component)
protected int columnNameToIndex(String columnName)
public void encodeEnd(javax.faces.context.FacesContext context) throws IOException
encodeEnd
in class HtmlDataTableHack
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 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, 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(String forceIdIndexFormula)
public String getForceIdIndexFormula()
public void setSortColumn(String sortColumn)
public String getSortColumn()
public void setSortAscending(boolean sortAscending)
public boolean isSortAscending()
public void setSortProperty(String sortProperty)
The datamodel should contain objects that have this property; reflection will be used to sort the datamodel on that property using the default comparator for that type.
This value is part of the component state. However it is not directly settable by users; instead it is set by other components such as a CommandSortHeader.
public String getSortProperty()
public abstract boolean isSortable()
public abstract boolean isEmbedded()
public abstract boolean isDetailStampExpandedDefault()
public abstract String getDetailStampLocation()
public abstract String getRowOnMouseOver()
public abstract String getRowOnMouseOut()
public abstract String getRowOnClick()
public abstract String getRowOnDblClick()
public abstract String getRowOnKeyDown()
public abstract String getRowOnKeyPress()
public abstract String getRowOnKeyUp()
public String getRowStyleClass()
public void setRowStyleClass(String rowStyleClass)
public String getRowStyle()
public void setRowStyle(String rowStyle)
public abstract String getRowOnMouseDown()
public abstract String getRowOnMouseMove()
public abstract String getRowOnMouseUp()
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(String varDetailToggler)
public String getVarDetailToggler()
public abstract String getRowGroupStyle()
public abstract String getRowGroupStyleClass()
public abstract String getBodyStyle()
public abstract String getBodyStyleClass()
public void toggleDetail()
public boolean isDetailExpanded()
public int getSortColumnIndex()
public void setSortColumnIndex(int sortColumnIndex)
public abstract int getNewspaperColumns()
getNewspaperColumns
in interface NewspaperTable
public abstract 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 abstract boolean isRenderedIfEmpty()
public abstract String getRowIndexVar()
public abstract String getRowCountVar()
public abstract String getPreviousRowDataVar()
public abstract String getSortedColumnVar()
public abstract String getAlign()
public abstract String getRowId()
public abstract String getDatafld()
public abstract String getDatasrc()
public abstract String getDataformatas()
public abstract String getValueType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |