org.apache.myfaces.tobago.internal.component
Class AbstractUISheet
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.apache.myfaces.tobago.internal.component.AbstractUIData
org.apache.myfaces.tobago.internal.component.AbstractUISheet
- All Implemented Interfaces:
- EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, OnComponentPopulated, SupportsRenderedPartially, Configurable, SheetStateChangeSource, SheetStateChangeSource2, SortActionSource, SortActionSource2, LayoutBase, LayoutBox, LayoutComponent, LayoutContainer
- Direct Known Subclasses:
- UISheet
public abstract class AbstractUISheet
- extends AbstractUIData
- implements SheetStateChangeSource2, SortActionSource2, OnComponentPopulated, LayoutContainer, LayoutComponent, SupportsRenderedPartially
Fields inherited from class javax.faces.component.UIData |
COMPONENT_FAMILY |
Fields inherited from class javax.faces.component.UIComponent |
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Fields inherited from interface javax.faces.component.NamingContainer |
SEPARATOR_CHAR |
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData |
createTreeDataModel, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, hasRows, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isShowRoot, isShowRootJunction, isTreeModel |
Methods inherited from class javax.faces.component.UIData |
createUniqueId, encodeEnd, getContainerClientId, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, processDecodes, processValidators, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueExpression, setVar, visitTree |
Methods inherited from class javax.faces.component.UIComponentBase |
addClientBehavior, 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, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent |
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.tobago.layout.LayoutBox |
getBorderBottom, getBorderLeft, getBorderRight, getBorderTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop |
Methods inherited from interface org.apache.myfaces.tobago.layout.LayoutComponent |
getColumnSpan, getDisplay, getHorizontalIndex, getRowSpan, getVerticalIndex, isRendered, setColumnSpan, setDisplay, setHorizontalIndex, setRowSpan, setVerticalIndex |
Methods inherited from interface org.apache.myfaces.tobago.layout.LayoutBase |
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 |
COMPONENT_TYPE
public static final String COMPONENT_TYPE
- See Also:
- Constant Field Values
FACET_SORTER
@Deprecated
public static final String FACET_SORTER
- Deprecated. Please use Facets instead. Will be removed after Tobago 1.5.0
- See Also:
Facets
,
Constant Field Values
SORTER_ID
public static final String SORTER_ID
- See Also:
- Constant Field Values
ATTR_SCROLL_POSITION
@Deprecated
public static final String ATTR_SCROLL_POSITION
- Deprecated. Please use Attributes instead. Will be removed after Tobago 1.5.0
- See Also:
Attributes
,
Constant Field Values
NONE
public static final String NONE
- See Also:
- Constant Field Values
SINGLE
public static final String SINGLE
- See Also:
- Constant Field Values
MULTI
public static final String MULTI
- See Also:
- Constant Field Values
AbstractUISheet
public AbstractUISheet()
getLayoutComponentRenderer
public LayoutComponentRenderer getLayoutComponentRenderer(javax.faces.context.FacesContext context)
encodeBegin
public void encodeBegin(javax.faces.context.FacesContext facesContext)
throws IOException
- Overrides:
encodeBegin
in class AbstractUIData
- Throws:
IOException
setState
public void setState(SheetState state)
getState
public SheetState getState()
getSheetState
public SheetState getSheetState(javax.faces.context.FacesContext facesContext)
getColumns
public abstract String getColumns()
getColumnLayout
public LayoutTokens getColumnLayout()
resetColumnWidths
public void resetColumnWidths()
- Remove the (by user) resized column widths. An application may provide a button to access it.
Since 1.0.26.
getLast
public int getLast()
- Deprecated. The name of this method is ambiguous.
You may use
getLastRowIndexOfCurrentPage()
. Deprecated since 1.5.5.
getLastRowIndexOfCurrentPage
public int getLastRowIndexOfCurrentPage()
- The rowIndex of the last row on the current page plus one (because of zero based iterating).
- Throws:
IllegalArgumentException
- If the number of rows in the model returned
by UIData.getRowCount()
is -1 (undefined).
getCurrentPage
public int getCurrentPage()
- Returns:
- returns the current page (based by 0).
getPage
@Deprecated
public int getPage()
- Deprecated. Please use
getCurrentPage()
which returns the value zero-based. Deprecated since 1.5.5.
- Returns:
- returns the current page (based by 1).
getPages
public int getPages()
- The number of pages to render.
- Throws:
IllegalArgumentException
- If the number of rows in the model returned
by UIData.getRowCount()
is -1 (undefined).
getRenderedChildrenOf
public List<javax.faces.component.UIComponent> getRenderedChildrenOf(javax.faces.component.UIColumn column)
isAtBeginning
public boolean isAtBeginning()
- Returns:
- Is the interval to display starting with the first row?
hasRowCount
public boolean hasRowCount()
- Returns:
- Does the data model knows the number of rows?
isPagingVisible
public boolean isPagingVisible()
- Returns:
- Should the paging controls be rendered? Either because of the need of paging or because
the show is enforced by
isShowPagingAlways()
needMoreThanOnePage
public boolean needMoreThanOnePage()
- Returns:
- Is panging needed to display all rows? If the number of rows is unknown this method returns true.
isShowPagingAlways
public abstract boolean isShowPagingAlways()
isAtEnd
public boolean isAtEnd()
getLastPageIndex
@Deprecated
public int getLastPageIndex()
- Deprecated. The name of this method is ambiguous.
You may use
getFirstRowIndexOfLastPage()
. Deprecated since 1.5.5.
getFirstRowIndexOfLastPage
public int getFirstRowIndexOfLastPage()
- Determines the beginning of the last page in the model.
If the number of rows to display on one page is unlimited, the value is 0 (there is only one page).
- Returns:
- The index of the first row of the last paging page.
- Throws:
IllegalArgumentException
- If the number of rows in the model returned
by UIData.getRowCount()
is -1 (undefined).
processUpdates
public void processUpdates(javax.faces.context.FacesContext context)
- Overrides:
processUpdates
in class javax.faces.component.UIData
saveState
public Object saveState(javax.faces.context.FacesContext context)
- Specified by:
saveState
in interface javax.faces.component.StateHolder
- Overrides:
saveState
in class javax.faces.component.UIComponentBase
restoreState
public void restoreState(javax.faces.context.FacesContext context,
Object savedState)
- Specified by:
restoreState
in interface javax.faces.component.StateHolder
- Overrides:
restoreState
in class javax.faces.component.UIComponentBase
getAllColumns
public List<AbstractUIColumn> getAllColumns()
getRenderedColumns
public List<AbstractUIColumn> getRenderedColumns()
queueEvent
public void queueEvent(javax.faces.event.FacesEvent facesEvent)
- Overrides:
queueEvent
in class javax.faces.component.UIData
broadcast
public void broadcast(javax.faces.event.FacesEvent facesEvent)
throws javax.faces.event.AbortProcessingException
- Overrides:
broadcast
in class javax.faces.component.UIData
- Throws:
javax.faces.event.AbortProcessingException
addStateChangeListener
public void addStateChangeListener(SheetStateChangeListener listener)
- Specified by:
addStateChangeListener
in interface SheetStateChangeSource
getStateChangeListeners
public SheetStateChangeListener[] getStateChangeListeners()
- Specified by:
getStateChangeListeners
in interface SheetStateChangeSource
removeStateChangeListener
public void removeStateChangeListener(SheetStateChangeListener listener)
- Specified by:
removeStateChangeListener
in interface SheetStateChangeSource
getWidthList
public List<Integer> getWidthList()
setWidthList
public void setWidthList(List<Integer> widthList)
getScrollPosition
public Integer[] getScrollPosition()
findComponent
public javax.faces.component.UIComponent findComponent(String searchId)
- Overrides:
findComponent
in class javax.faces.component.UIComponentBase
stripRowIndex
public String stripRowIndex(String searchId)
performPaging
public void performPaging(PageActionEvent pageEvent)
getComponents
public List<LayoutComponent> getComponents()
- Specified by:
getComponents
in interface LayoutContainer
onComponentPopulated
public void onComponentPopulated(javax.faces.context.FacesContext facesContext,
javax.faces.component.UIComponent parent)
- Specified by:
onComponentPopulated
in interface OnComponentPopulated
getLayoutManager
public LayoutManager getLayoutManager()
- Specified by:
getLayoutManager
in interface LayoutContainer
setLayoutManager
public void setLayoutManager(LayoutManager layoutManager)
- Specified by:
setLayoutManager
in interface LayoutContainer
isLayoutChildren
public boolean isLayoutChildren()
- Description copied from interface:
LayoutContainer
- Should the children of the this component be laid out from the given layout manager.
- Specified by:
isLayoutChildren
in interface LayoutContainer
isRendersRowContainer
public boolean isRendersRowContainer()
- Description copied from class:
AbstractUIData
- The value describes, if the UIData renderer creates container elements to hold the row information.
This information is important for the TreeNodeRenderer to set the visible state in the output or not.
Typically the Sheet returns true and a Tree returns false, because the sheet renders the HTML TR tags,
the the sheet also is responsible for the visible state.
- Overrides:
isRendersRowContainer
in class AbstractUIData
isShowHeader
public abstract boolean isShowHeader()
getNeedVerticalScrollbar
public Boolean getNeedVerticalScrollbar()
setNeedVerticalScrollbar
public void setNeedVerticalScrollbar(Boolean needVerticalScrollbar)
getExpandedState
public ExpandedState getExpandedState()
- Specified by:
getExpandedState
in class AbstractUIData
getSelectedState
public SelectedState getSelectedState()
- Specified by:
getSelectedState
in class AbstractUIData
getHeaderGrid
public Grid getHeaderGrid()
setHeaderGrid
public void setHeaderGrid(Grid headerGrid)
Copyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.