public abstract class AbstractUISheet extends javax.faces.component.UIData implements SheetStateChangeSource, SortActionSource, InvokeOnComponent, 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 |
MARKER
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<javax.faces.component.UIColumn> |
getAllColumns() |
LayoutTokens |
getColumnLayout() |
abstract String |
getColumns() |
List<LayoutComponent> |
getComponents() |
int |
getCurrentPage() |
int |
getFirstRowIndexOfLastPage()
Determines the beginning of the last page in the model.
|
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<javax.faces.component.UIColumn> |
getRenderedColumns() |
Integer[] |
getScrollPosition() |
SheetState |
getSheetState(javax.faces.context.FacesContext facesContext) |
SheetState |
getState() |
SheetStateChangeListener[] |
getStateChangeListeners() |
List<Integer> |
getWidthList() |
boolean |
hasRowCount() |
boolean |
hasRows()
Deprecated.
The name of this method is ambiguous.
You may use
isRowsUnlimited() . Deprecated since 1.5.5. |
boolean |
invokeOnComponent(javax.faces.context.FacesContext facesContext,
String clientId,
javax.faces.component.ContextCallback callback) |
boolean |
isAtBeginning() |
boolean |
isAtEnd() |
boolean |
isLayoutChildren()
Should the children of the this component be laid out from the given layout manager.
|
boolean |
isPagingVisible() |
boolean |
isRowsUnlimited() |
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 |
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 |
setLayoutManager(LayoutManager layoutManager) |
void |
setNeedVerticalScrollbar(Boolean needVerticalScrollbar) |
void |
setState(SheetState state) |
void |
setWidthList(List<Integer> widthList) |
String |
stripRowIndex(String searchId) |
encodeEnd, getClientId, getDataModel, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, processDecodes, processValidators, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueExpression, setVar
addFacesListener, decode, encodeChildren, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
encodeAll, getContainerClientId, getValueExpression
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getStateChangeListener, setStateChangeListener
getSortActionListener, setSortActionListener
isOverflowX, isOverflowY, setOverflowX, setOverflowY
getBorderBottom, getBorderLeft, getBorderRight, getBorderTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop
getColumnSpan, getDisplay, getHorizontalIndex, getRowSpan, getVerticalIndex, isRendered, setColumnSpan, setDisplay, setHorizontalIndex, setRowSpan, setVerticalIndex
getCurrentHeight, 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, setWidth
getCurrentMarkup, getRendererType
getRenderedPartially, setRenderedPartially
public 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 javax.faces.component.UIData
IOException
public 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()
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()
@Deprecated public boolean hasRows()
isRowsUnlimited()
. Deprecated since 1.5.5.public boolean isRowsUnlimited()
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.UIData
public Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIData
public void restoreState(javax.faces.context.FacesContext context, Object savedState)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIData
public List<javax.faces.component.UIColumn> getAllColumns()
public List<javax.faces.component.UIColumn> getRenderedColumns()
public void queueEvent(javax.faces.event.FacesEvent facesEvent)
queueEvent
in class javax.faces.component.UIData
public void broadcast(javax.faces.event.FacesEvent facesEvent) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIData
javax.faces.event.AbortProcessingException
public void addStateChangeListener(SheetStateChangeListener listener)
addStateChangeListener
in interface SheetStateChangeSource
public SheetStateChangeListener[] getStateChangeListeners()
getStateChangeListeners
in interface SheetStateChangeSource
public void removeStateChangeListener(SheetStateChangeListener listener)
removeStateChangeListener
in interface SheetStateChangeSource
public Integer[] getScrollPosition()
public javax.faces.component.UIComponent findComponent(String searchId)
findComponent
in class javax.faces.component.UIComponentBase
public boolean invokeOnComponent(javax.faces.context.FacesContext facesContext, String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
invokeOnComponent
in interface InvokeOnComponent
invokeOnComponent
in class javax.faces.component.UIData
javax.faces.FacesException
public void performPaging(PageActionEvent pageEvent)
public List<LayoutComponent> getComponents()
getComponents
in interface LayoutContainer
public void onComponentPopulated(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent parent)
onComponentPopulated
in interface OnComponentPopulated
public LayoutManager getLayoutManager()
getLayoutManager
in interface LayoutContainer
public void setLayoutManager(LayoutManager layoutManager)
setLayoutManager
in interface LayoutContainer
public boolean isLayoutChildren()
LayoutContainer
isLayoutChildren
in interface LayoutContainer
public abstract boolean isShowHeader()
public Boolean getNeedVerticalScrollbar()
public void setNeedVerticalScrollbar(Boolean needVerticalScrollbar)
Copyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.