org.richfaces.component
Class AbstractDataGrid
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.richfaces.component.UIDataAdaptor
org.richfaces.component.UISequence
org.richfaces.component.AbstractDataGrid
- All Implemented Interfaces:
- EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListener, javax.faces.event.SystemEventListenerHolder, org.ajax4jsf.component.IterationStateHolder, org.richfaces.component.MetaComponentEncoder, org.richfaces.component.MetaComponentResolver, org.richfaces.component.Row
- Direct Known Subclasses:
- UIDataGrid
public abstract class AbstractDataGrid
- extends UISequence
- implements org.richfaces.component.Row, org.richfaces.component.MetaComponentResolver, org.richfaces.component.MetaComponentEncoder
The <rich:dataGrid> component is used to arrange data objects in a grid. Values in the grid can be updated
dynamically from the data model, and Ajax updates can be limited to specific rows. The component supports header,
footer, and caption facets.
- Author:
- Anton Belevich
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 org.richfaces.component.MetaComponentResolver |
META_COMPONENT_SEPARATOR_CHAR |
Fields inherited from interface javax.faces.component.NamingContainer |
SEPARATOR_CHAR |
Method Summary |
Iterator<javax.faces.component.UIComponent> |
columns()
|
void |
encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId)
|
abstract javax.faces.component.UIComponent |
getCaption()
|
int |
getColumns()
Number of columns to display |
abstract int |
getElements()
Number of elements displayed in the grid |
abstract javax.faces.component.UIComponent |
getFooter()
|
abstract javax.faces.component.UIComponent |
getHeader()
|
abstract javax.faces.component.UIComponent |
getNoData()
|
abstract int |
getRows()
|
String |
resolveClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
|
void |
setColumns(int count)
|
String |
substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
|
protected boolean |
visitDataChildren(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback,
boolean visitRows)
|
protected boolean |
visitFixedChildren(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback)
|
Methods inherited from class org.richfaces.component.UISequence |
captureOrigValue, createComponentState, createExtendedDataModel, createFacesModel, getActualFirst, getActualRows, getFirst, getIterationStatusVar, getRelativeClientId, getRelativeRowIndex, getRowIndex, getRowKeyConverter, getValue, preEncodeBegin, restoreOrigValue, setFirst, setIterationStatusVar, setRows, setupVariable, setValue, setValueBinding, setValueExpression, updateState, updateState |
Methods inherited from class org.richfaces.component.UIDataAdaptor |
allFixedChildren, broadcast, clearExtendedDataModel, clearInitialState, createUniqueId, dataChildren, doUpdate, extractKeySegment, fixedChildren, getComponentState, getContainerClientId, getContainerClientId, getExtendedDataModel, getFamily, getIterationState, getLocalComponentState, getRowCount, getRowData, getRowKey, getRowKeyVar, getStateVar, getVar, getVariablesMap, invokeOnComponent, invokeOnRow, isKeepSaved, isListenerForSource, isRowAvailable, iterate, keepSaved, markInitialState, preDecode, preUpdate, preValidate, processDecodes, processDecodesChildren, processEvent, processEvent, processUpdates, processUpdatesChildren, processValidatesChildren, processValidators, queueEvent, resetChildState, resetDataModel, restoreChildState, restoreChildState, restoreState, saveChildState, saveChildState, saveState, setExtendedDataModel, setId, setIterationState, setKeepSaved, setRowKey, setRowKey, setRowKeyConverter, setRowKeyVar, setStateVar, setVar, visitDataChildrenMetaComponents, visitTree, walk, wrapEvent |
Methods inherited from class javax.faces.component.UIComponentBase |
addClientBehavior, addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, 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, 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 org.richfaces.component.Row |
setRowKey, walk |
COMPONENT_TYPE
public static final String COMPONENT_TYPE
- See Also:
- Constant Field Values
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
HEADER_FACET_NAME
public static final String HEADER_FACET_NAME
- See Also:
- Constant Field Values
FOOTER_FACET_NAME
public static final String FOOTER_FACET_NAME
- See Also:
- Constant Field Values
CAPTION_FACET_NAME
public static final String CAPTION_FACET_NAME
- See Also:
- Constant Field Values
NODATA_FACET_NAME
public static final String NODATA_FACET_NAME
- See Also:
- Constant Field Values
HEADER
public static final String HEADER
- See Also:
- Constant Field Values
FOOTER
public static final String FOOTER
- See Also:
- Constant Field Values
BODY
public static final String BODY
- See Also:
- Constant Field Values
AbstractDataGrid
public AbstractDataGrid()
getElements
public abstract int getElements()
- Number of elements displayed in the grid
getRows
public abstract int getRows()
- Overrides:
getRows
in class UISequence
getHeader
public abstract javax.faces.component.UIComponent getHeader()
getFooter
public abstract javax.faces.component.UIComponent getFooter()
getCaption
public abstract javax.faces.component.UIComponent getCaption()
getNoData
public abstract javax.faces.component.UIComponent getNoData()
getColumns
public int getColumns()
- Number of columns to display
setColumns
public void setColumns(int count)
columns
public Iterator<javax.faces.component.UIComponent> columns()
- Specified by:
columns
in interface org.richfaces.component.Row
encodeMetaComponent
public void encodeMetaComponent(javax.faces.context.FacesContext context,
String metaComponentId)
throws IOException
- Specified by:
encodeMetaComponent
in interface org.richfaces.component.MetaComponentEncoder
- Throws:
IOException
visitFixedChildren
protected boolean visitFixedChildren(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback)
- Overrides:
visitFixedChildren
in class UIDataAdaptor
visitDataChildren
protected boolean visitDataChildren(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback,
boolean visitRows)
- Overrides:
visitDataChildren
in class UIDataAdaptor
resolveClientId
public String resolveClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
- Specified by:
resolveClientId
in interface org.richfaces.component.MetaComponentResolver
substituteUnresolvedClientId
public String substituteUnresolvedClientId(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent contextComponent,
String metaComponentId)
- Specified by:
substituteUnresolvedClientId
in interface org.richfaces.component.MetaComponentResolver
Copyright © 2013 JBoss by Red Hat. All Rights Reserved.