|
ICEfaces ICE Components 3.3.0 Java API Documentation |
|||||||||
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.icefaces.impl.component.UISeriesBase
com.icesoft.faces.component.panelseries.UISeries
com.icesoft.faces.component.ext.HtmlDataTable
public class HtmlDataTable
This is an extension of javax.faces.component.html.HtmlDataTable, which provides some additional behavior to this component such as:
Nested Class Summary | |
---|---|
static class |
HtmlDataTable.SearchType
|
Nested classes/interfaces inherited from class org.icefaces.impl.component.UISeriesBase |
---|
org.icefaces.impl.component.UISeriesBase.RowEvent |
Nested classes/interfaces inherited from class javax.faces.component.html.HtmlDataTable |
---|
javax.faces.component.html.HtmlDataTable.PropertyKeys |
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
Fields inherited from class org.icefaces.impl.component.UISeriesBase |
---|
dataModel, savedChildren, savedSeriesState |
Fields inherited from class javax.faces.component.UIData |
---|
COMPONENT_FAMILY |
Fields inherited from class javax.faces.component.UIComponent |
---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
HtmlDataTable()
|
Method Summary | |
---|---|
void |
decode(javax.faces.context.FacesContext context)
|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
int |
findRow(java.lang.String query,
java.lang.String[] fields,
int startRow)
Find the index of a row object in the current DataModel. |
int |
findRow(java.lang.String query,
java.lang.String[] fields,
int startRow,
HtmlDataTable.SearchType searchType)
Find the index of a row object in the current DataModel. |
int |
findRow(java.lang.String query,
java.lang.String[] fields,
int startRow,
HtmlDataTable.SearchType searchType,
boolean caseSensitive)
Find the index of a row object in the current DataModel. |
int |
getColNumber()
|
java.lang.String |
getColumnWidths()
|
java.lang.String |
getComponentType()
|
java.lang.String |
getFooterClass()
|
java.lang.String |
getHeaderClass()
|
java.lang.String |
getHeaderClassAtIndex(int index)
|
java.lang.String |
getHeaderClasses()
Return the value of the headerClasses property. |
java.lang.String |
getNextResizableTblColumnWidth()
|
java.lang.String |
getRenderedOnUserRole()
Return the value of the renderedOnUserRole property. |
java.lang.String |
getResizableColumnWidths()
|
java.lang.Boolean |
getScrollable()
|
java.lang.String |
getScrollHeight()
|
java.lang.String |
getSortColumn()
Return the value of the sortColumn property. |
java.lang.String |
getStyleClass()
|
boolean |
isClientOnly()
|
boolean |
isRendered()
Return the value of the rendered property. |
boolean |
isResizable()
|
java.lang.Boolean |
isScrollable()
|
boolean |
isScrollFooter()
|
boolean |
isSortAscending()
Return the value of the sortAscending property. |
protected void |
iterate(javax.faces.context.FacesContext facesContext,
javax.faces.event.PhaseId phase)
|
void |
navigateToRow(int row)
Navigate the client to a row in the table indicating the target row with a default highlight effect. |
void |
navigateToRow(int row,
com.icesoft.faces.context.effects.Effect effect)
Navigate the client to a row in the table indicating the target row with the given effect. |
void |
processKids(javax.faces.context.FacesContext context,
javax.faces.event.PhaseId phaseId,
javax.faces.component.UIComponent kid)
|
protected void |
resetChildClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent component)
|
void |
resetResizableTblColumnsWidthIndex()
|
protected void |
restoreChild(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent)
|
protected void |
restoreChildrenState(javax.faces.context.FacesContext facesContext)
|
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
Perform any processing required to restore the state from the entries in the state Object. |
protected void |
saveChild(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent uiComponent)
|
protected void |
saveChildrenState(javax.faces.context.FacesContext facesContext)
Save state information for all descendant components, as described for setRowIndex() . |
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
Gets the state of the instance as a Serializable
Object. |
void |
setClientOnly(boolean clientOnly)
|
void |
setColNumber(int colNumber)
|
void |
setColumnWidths(java.lang.String columnWidths)
|
void |
setHeaderClasses(java.lang.String headerClasses)
Set the value of the headerClasses property. |
void |
setRenderedOnUserRole(java.lang.String renderedOnUserRole)
Set the value of the renderedOnUserRole property. |
void |
setResizable(boolean resizable)
|
void |
setResizableColumnWidths(java.lang.String columnWidths)
|
void |
setScrollable(boolean scrollable)
|
void |
setScrollable(java.lang.Boolean scrollable)
|
void |
setScrollFooter(boolean scrollFooter)
|
void |
setScrollHeight(java.lang.String scrollHeight)
|
void |
setSortAscending(boolean sortAscending)
Set the value of the sortAscending property. |
void |
setSortColumn(java.lang.String sortColumn)
Set the value of the sortColumn property. |
Methods inherited from class com.icesoft.faces.component.panelseries.UISeries |
---|
getValue, synchWithPaginator, wrapDataModel |
Methods inherited from class org.icefaces.impl.component.UISeriesBase |
---|
broadcast, ensureFirstRowInRange, getClientId, getContainerClientId, getDataModel, getRowCount, getRowData, getRowIndex, getSavedChildren, getSavedSeriesState, getVar, getVarStatus, isRowAvailable, processDecodes, processUpdates, processValidators, queueEvent, restoreChildState, restoreSeriesState, saveChildState, saveSeriesState, setDataModel, setId, setRowIndex, setValue, setValueBinding, setVar, setVarStatus, visitTree |
Methods inherited from class javax.faces.component.html.HtmlDataTable |
---|
getBgcolor, getBodyrows, getBorder, getCaptionClass, getCaptionStyle, getCellpadding, getCellspacing, getColumnClasses, getDefaultEventName, getDir, getEventNames, getFrame, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRowClasses, getRules, getStyle, getSummary, getTitle, getWidth, setBgcolor, setBodyrows, setBorder, setCaptionClass, setCaptionStyle, 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 |
---|
createUniqueId, getFamily, getFirst, getFooter, getHeader, getRows, invokeOnComponent, isRowStatePreserved, markInitialState, setFirst, setFooter, setHeader, setRows, setRowStatePreserved, setValueExpression |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addClientBehavior, addFacesListener, clearInitialState, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
---|
addClientBehavior, getClientBehaviors |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public HtmlDataTable()
Method Detail |
---|
public void setRenderedOnUserRole(java.lang.String renderedOnUserRole)
Set the value of the renderedOnUserRole
property.
public java.lang.String getRenderedOnUserRole()
Return the value of the renderedOnUserRole
property.
public boolean isRendered()
Return the value of the rendered
property.
isRendered
in class UISeries
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class org.icefaces.impl.component.UISeriesBase
java.io.IOException
public java.lang.String getSortColumn()
Return the value of the sortColumn
property.
public void setSortAscending(boolean sortAscending)
Set the value of the sortAscending
property.
public void setSortColumn(java.lang.String sortColumn)
Set the value of the sortColumn
property.
public boolean isSortAscending()
Return the value of the sortAscending
property.
public java.lang.Object saveState(javax.faces.context.FacesContext context)
Gets the state of the instance as a Serializable
Object.
saveState
in interface javax.faces.component.StateHolder
saveState
in class org.icefaces.impl.component.UISeriesBase
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
Perform any processing required to restore the state from the entries in the state Object.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class org.icefaces.impl.component.UISeriesBase
public java.lang.String getComponentType()
protected void iterate(javax.faces.context.FacesContext facesContext, javax.faces.event.PhaseId phase)
iterate
in class org.icefaces.impl.component.UISeriesBase
protected void restoreChildrenState(javax.faces.context.FacesContext facesContext)
restoreChildrenState
in class org.icefaces.impl.component.UISeriesBase
protected void resetChildClientId(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component)
protected void saveChildrenState(javax.faces.context.FacesContext facesContext)
Save state information for all descendant components, as described for
setRowIndex()
.
saveChildrenState
in class org.icefaces.impl.component.UISeriesBase
public void processKids(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId, javax.faces.component.UIComponent kid)
public int getColNumber()
public void setColNumber(int colNumber)
public java.lang.Boolean getScrollable()
public java.lang.Boolean isScrollable()
public void setScrollable(java.lang.Boolean scrollable)
public void setScrollable(boolean scrollable)
public java.lang.String getColumnWidths()
public void setColumnWidths(java.lang.String columnWidths)
public java.lang.String getScrollHeight()
public void setScrollHeight(java.lang.String scrollHeight)
public void setHeaderClasses(java.lang.String headerClasses)
Set the value of the headerClasses
property.
public java.lang.String getHeaderClasses()
Return the value of the headerClasses
property.
public java.lang.String getHeaderClassAtIndex(int index)
protected void restoreChild(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
restoreChild
in class org.icefaces.impl.component.UISeriesBase
protected void saveChild(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent)
saveChild
in class org.icefaces.impl.component.UISeriesBase
public java.lang.String getStyleClass()
getStyleClass
in class javax.faces.component.html.HtmlDataTable
public java.lang.String getHeaderClass()
getHeaderClass
in class javax.faces.component.html.HtmlDataTable
public java.lang.String getFooterClass()
getFooterClass
in class javax.faces.component.html.HtmlDataTable
public boolean isResizable()
public void setResizable(boolean resizable)
public boolean isClientOnly()
public void setClientOnly(boolean clientOnly)
public void decode(javax.faces.context.FacesContext context)
decode
in class javax.faces.component.UIComponentBase
public java.lang.String getNextResizableTblColumnWidth()
public void resetResizableTblColumnsWidthIndex()
public boolean isScrollFooter()
public void setScrollFooter(boolean scrollFooter)
public java.lang.String getResizableColumnWidths()
public void setResizableColumnWidths(java.lang.String columnWidths)
public int findRow(java.lang.String query, java.lang.String[] fields, int startRow, HtmlDataTable.SearchType searchType, boolean caseSensitive)
query
- The string to be searched for in the row object fields.fields
- The fields of the row object to search the String representations of.startRow
- The index to begin searching, inclusive.searchType
- A enumeration representing where to search for a match.caseSensitive
- A boolean representing the case sensitive.
public int findRow(java.lang.String query, java.lang.String[] fields, int startRow, HtmlDataTable.SearchType searchType)
query
- The string to be searched for in the row object fields.fields
- The fields of the row object to search the String representations of.startRow
- The index to begin searching, inclusive.searchType
- A enumeration representing where to search for a match.
public int findRow(java.lang.String query, java.lang.String[] fields, int startRow)
query
- The string to be searched for in the row object fields.fields
- The fields of the row object to search the String representations of.startRow
- The index to begin searching, inclusive.
public void navigateToRow(int row, com.icesoft.faces.context.effects.Effect effect)
row
- Index of the row to be navigated to.effect
- Effect object to trigger on the given rowpublic void navigateToRow(int row)
row
- Index of the row to be navigated to.
|
ICEfaces ICE Components 3.3.0 Java API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |