public abstract class AbstractUISheet extends AbstractUIData implements SheetStateChangeSource2, SortActionSource2, OnComponentPopulated, LayoutContainer, LayoutComponent, SupportsRenderedPartially
| Modifier and Type | Field and Description |
|---|---|
static String |
ATTR_SCROLL_POSITION
Deprecated.
Please use Attributes instead. Will be removed after Tobago 1.5.0
|
static String |
COMPONENT_TYPE |
static String |
FACET_SORTER
Deprecated.
Please use Facets instead. Will be removed after Tobago 1.5.0
|
static String |
MULTI |
static String |
NONE |
static String |
SINGLE |
static String |
SORTER_ID |
SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTEDBEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEYMARKER| Constructor and Description |
|---|
AbstractUISheet() |
| Modifier and Type | Method and Description |
|---|---|
void |
addStateChangeListener(SheetStateChangeListener listener) |
void |
broadcast(javax.faces.event.FacesEvent facesEvent) |
void |
encodeBegin(javax.faces.context.FacesContext facesContext) |
javax.faces.component.UIComponent |
findComponent(String searchId) |
List<AbstractUIColumn> |
getAllColumns() |
LayoutTokens |
getColumnLayout() |
abstract String |
getColumns() |
List<LayoutComponent> |
getComponents() |
int |
getCurrentPage() |
ExpandedState |
getExpandedState() |
int |
getFirstRowIndexOfLastPage()
Determines the beginning of the last page in the model.
|
Grid |
getHeaderGrid() |
int |
getLast()
Deprecated.
The name of this method is ambiguous. You may use
getLastRowIndexOfCurrentPage(). Deprecated
since 1.5.5. |
int |
getLastPageIndex()
Deprecated.
The name of this method is ambiguous. You may use
getFirstRowIndexOfLastPage(). Deprecated
since 1.5.5. |
int |
getLastRowIndexOfCurrentPage()
The rowIndex of the last row on the current page plus one (because of zero based iterating).
|
LayoutComponentRenderer |
getLayoutComponentRenderer(javax.faces.context.FacesContext context) |
LayoutManager |
getLayoutManager() |
Boolean |
getNeedVerticalScrollbar() |
int |
getPage()
Deprecated.
Please use
getCurrentPage() which returns the value zero-based. Deprecated since 1.5.5. |
int |
getPages()
The number of pages to render.
|
List<javax.faces.component.UIComponent> |
getRenderedChildrenOf(javax.faces.component.UIColumn column) |
List<AbstractUIColumn> |
getRenderedColumns() |
Integer[] |
getScrollPosition() |
SelectedState |
getSelectedState() |
SheetState |
getSheetState(javax.faces.context.FacesContext facesContext) |
SheetState |
getState() |
SheetStateChangeListener[] |
getStateChangeListeners() |
List<Integer> |
getWidthList() |
boolean |
hasRowCount() |
boolean |
isAtBeginning() |
boolean |
isAtEnd() |
boolean |
isLayoutChildren()
Should the children of the this component be laid out from the given layout manager.
|
boolean |
isPagingVisible() |
boolean |
isRendersRowContainer()
The value describes, if the UIData renderer creates container elements to hold the row information.
|
abstract boolean |
isShowHeader() |
abstract boolean |
isShowPagingAlways() |
boolean |
needMoreThanOnePage() |
void |
onComponentPopulated(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent parent) |
void |
performPaging(PageActionEvent pageEvent) |
void |
processEvent(javax.faces.event.ComponentSystemEvent event) |
void |
processUpdates(javax.faces.context.FacesContext context) |
void |
queueEvent(javax.faces.event.FacesEvent facesEvent) |
void |
removeStateChangeListener(SheetStateChangeListener listener) |
void |
resetColumnWidths()
Remove the (by user) resized column widths.
|
void |
restoreState(javax.faces.context.FacesContext context,
Object savedState) |
Object |
saveState(javax.faces.context.FacesContext context) |
void |
setHeaderGrid(Grid headerGrid) |
void |
setLayoutManager(LayoutManager layoutManager) |
void |
setNeedVerticalScrollbar(Boolean needVerticalScrollbar) |
void |
setState(SheetState state) |
void |
setWidthList(List<Integer> widthList) |
protected void |
sort(javax.faces.context.FacesContext facesContext,
SortActionEvent eventParameter) |
String |
stripRowIndex(String searchIdParameter) |
createTreeDataModel, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, hasRows, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isShowRoot, isShowRootJunction, isTreeModelcreateUniqueId, encodeEnd, getContainerClientId, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, processDecodes, processValidators, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueExpression, setVar, visitTreeaddClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBindinggetClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEventclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetStateChangeListenerExpression, setStateChangeListenerExpressiongetStateChangeListener, setStateChangeListenergetSortActionListenerExpression, setSortActionListenerExpressiongetSortActionListener, setSortActionListenerisOverflowX, isOverflowY, setOverflowX, setOverflowYgetBorderBottom, getBorderLeft, getBorderRight, getBorderTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTopgetColumnSpan, getDisplay, getHorizontalIndex, getRowSpan, getVerticalIndex, isRendered, setColumnSpan, setDisplay, setHorizontalIndex, setRowSpan, setVerticalIndexgetCurrentHeight, getCurrentWidth, getHeight, getLeft, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumWidth, getPreferredHeight, getPreferredWidth, getTop, getWidth, setCurrentHeight, setCurrentWidth, setHeight, setLeft, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaximumHeight, setMaximumWidth, setMinimumHeight, setMinimumWidth, setPreferredHeight, setPreferredWidth, setTop, setWidthgetCurrentMarkup, getRendererTypegetRenderedPartially, setRenderedPartiallypublic static final String COMPONENT_TYPE
@Deprecated public static final String FACET_SORTER
Facets,
Constant Field Valuespublic static final String SORTER_ID
@Deprecated public static final String ATTR_SCROLL_POSITION
Attributes,
Constant Field Valuespublic static final String NONE
public static final String SINGLE
public static final String MULTI
public LayoutComponentRenderer getLayoutComponentRenderer(javax.faces.context.FacesContext context)
public void encodeBegin(javax.faces.context.FacesContext facesContext)
throws IOException
encodeBegin in class AbstractUIDataIOExceptionpublic void setState(SheetState state)
public SheetState getState()
public SheetState getSheetState(javax.faces.context.FacesContext facesContext)
public abstract String getColumns()
public LayoutTokens getColumnLayout()
public void resetColumnWidths()
@Deprecated public int getLast()
getLastRowIndexOfCurrentPage(). Deprecated
since 1.5.5.public int getLastRowIndexOfCurrentPage()
IllegalArgumentException - If the number of rows in the model returned by UIData.getRowCount() is -1
(undefined).public int getCurrentPage()
@Deprecated public int getPage()
getCurrentPage() which returns the value zero-based. Deprecated since 1.5.5.public int getPages()
IllegalArgumentException - If the number of rows in the model returned by UIData.getRowCount() is -1
(undefined).public List<javax.faces.component.UIComponent> getRenderedChildrenOf(javax.faces.component.UIColumn column)
public boolean isAtBeginning()
public boolean hasRowCount()
public boolean isPagingVisible()
isShowPagingAlways()public boolean needMoreThanOnePage()
public abstract boolean isShowPagingAlways()
public boolean isAtEnd()
@Deprecated public int getLastPageIndex()
getFirstRowIndexOfLastPage(). Deprecated
since 1.5.5.public int getFirstRowIndexOfLastPage()
IllegalArgumentException - If the number of rows in the model returned by UIData.getRowCount() is -1
(undefined).public void processUpdates(javax.faces.context.FacesContext context)
processUpdates in class javax.faces.component.UIDatapublic Object saveState(javax.faces.context.FacesContext context)
saveState in interface javax.faces.component.StateHoldersaveState in class javax.faces.component.UIComponentBasepublic void restoreState(javax.faces.context.FacesContext context,
Object savedState)
restoreState in interface javax.faces.component.StateHolderrestoreState in class javax.faces.component.UIComponentBasepublic List<AbstractUIColumn> getAllColumns()
public List<AbstractUIColumn> getRenderedColumns()
public void queueEvent(javax.faces.event.FacesEvent facesEvent)
queueEvent in class javax.faces.component.UIDatapublic void broadcast(javax.faces.event.FacesEvent facesEvent)
throws javax.faces.event.AbortProcessingException
broadcast in class javax.faces.component.UIDatajavax.faces.event.AbortProcessingExceptionpublic void processEvent(javax.faces.event.ComponentSystemEvent event)
processEvent in interface javax.faces.event.ComponentSystemEventListenerprocessEvent in class javax.faces.component.UIComponentprotected void sort(javax.faces.context.FacesContext facesContext,
SortActionEvent eventParameter)
public void addStateChangeListener(SheetStateChangeListener listener)
addStateChangeListener in interface SheetStateChangeSourcepublic SheetStateChangeListener[] getStateChangeListeners()
getStateChangeListeners in interface SheetStateChangeSourcepublic void removeStateChangeListener(SheetStateChangeListener listener)
removeStateChangeListener in interface SheetStateChangeSourcepublic Integer[] getScrollPosition()
public javax.faces.component.UIComponent findComponent(String searchId)
findComponent in class javax.faces.component.UIComponentBasepublic void performPaging(PageActionEvent pageEvent)
public List<LayoutComponent> getComponents()
getComponents in interface LayoutContainerpublic void onComponentPopulated(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent parent)
onComponentPopulated in interface OnComponentPopulatedpublic LayoutManager getLayoutManager()
getLayoutManager in interface LayoutContainerpublic void setLayoutManager(LayoutManager layoutManager)
setLayoutManager in interface LayoutContainerpublic boolean isLayoutChildren()
LayoutContainerisLayoutChildren in interface LayoutContainerpublic boolean isRendersRowContainer()
AbstractUIDataisRendersRowContainer in class AbstractUIDatapublic abstract boolean isShowHeader()
public Boolean getNeedVerticalScrollbar()
public void setNeedVerticalScrollbar(Boolean needVerticalScrollbar)
public ExpandedState getExpandedState()
getExpandedState in class AbstractUIDatapublic SelectedState getSelectedState()
getSelectedState in class AbstractUIDatapublic Grid getHeaderGrid()
public void setHeaderGrid(Grid headerGrid)
Copyright © 2002–2024 The Apache Software Foundation. All rights reserved.