public class UISheet extends AbstractUISheet implements SortActionSource2, SupportsMarkup
component2.0.stg with class
SheetTagDeclaration.| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
ATTR_SCROLL_POSITION, FACET_SORTER, MULTI, NONE, SINGLE, SORTER_IDSUFFIX_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 |
|---|
UISheet() |
| Modifier and Type | Method and Description |
|---|---|
Measure |
getBorderBottom()
This attribute is for internal use only.
|
Measure |
getBorderLeft()
This attribute is for internal use only.
|
Measure |
getBorderRight()
This attribute is for internal use only.
|
Measure |
getBorderTop()
This attribute is for internal use only.
|
String |
getColumns()
LayoutConstraints for column layout.
|
Integer |
getColumnSpan() |
Measure |
getCurrentHeight()
This value will usually be set by the layout manager.
|
Markup |
getCurrentMarkup() |
Measure |
getCurrentWidth()
This value will usually be set by the layout manager.
|
Integer |
getDirectLinkCount()
The count of rendered direct paging links in the sheet's footer.
|
Display |
getDisplay()
This attribute is for internal use only.
|
String |
getFamily() |
String |
getForceVerticalScrollbar()
Flag indicating whether or not this sheet should reserve space for vertical toolbar when calculating column
width's.
|
Measure |
getHeight()
This value will usually be set by the layout manager.
|
Integer |
getHorizontalIndex()
This attribute is for internal use only.
|
Measure |
getLeft()
This value will usually be set by the layout manager.
|
Measure |
getMarginBottom() |
Measure |
getMarginLeft() |
Measure |
getMarginRight() |
Measure |
getMarginTop() |
Markup |
getMarkup() |
Measure |
getMaximumHeight() |
Measure |
getMaximumWidth() |
Measure |
getMinimumHeight() |
Measure |
getMinimumWidth() |
Measure |
getPaddingBottom()
This attribute is for internal use only.
|
Measure |
getPaddingLeft()
This attribute is for internal use only.
|
Measure |
getPaddingRight()
This attribute is for internal use only.
|
Measure |
getPaddingTop()
This attribute is for internal use only.
|
Measure |
getPreferredHeight() |
Measure |
getPreferredWidth() |
String[] |
getRenderedPartially()
Indicate the partially rendered components in a case of a submit.
|
Integer |
getRowSpan() |
String |
getSelectable()
Flag indicating whether or not the sheet should be selectable.
|
String |
getShowDirectLinks()
Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
|
String |
getShowPageRange()
Flag indicating whether and where the range pages should rendered in the sheet's footer.
|
String |
getShowRowRange()
Flag indicating whether or not the range of displayed rows should rendered in the sheet's footer.
|
javax.faces.el.MethodBinding |
getSortActionListener()
Deprecated.
since 2.0.0
|
javax.el.MethodExpression |
getSortActionListenerExpression() |
javax.faces.el.MethodBinding |
getStateChangeListener()
Deprecated.
since 2.0.0
|
javax.el.MethodExpression |
getStateChangeListenerExpression() |
Measure |
getTop()
This value will usually be set by the layout manager.
|
Integer |
getVerticalIndex()
This attribute is for internal use only.
|
Measure |
getWidth()
This value will usually be set by the layout manager.
|
boolean |
isOverflowX()
This attribute is for internal use only.
|
boolean |
isOverflowY()
This attribute is for internal use only.
|
boolean |
isShowDirectLinksArrows()
Flag indicating if paging arrows are shown near direct links
Default: false |
boolean |
isShowHeader()
Flag indicating the header should be rendered.
|
boolean |
isShowPageRangeArrows()
Flag indicating if paging arrows are shown near page range
Default: true |
boolean |
isShowPagingAlways()
Flag indicating whether or not the paging panel should be display, if it is not needed for paging.
|
boolean |
isShowRoot()
Only applicable in the case that the data model is a tree.
|
boolean |
isShowRootJunction()
Only applicable in the case that the data model is a tree.
|
Object |
saveState(javax.faces.context.FacesContext context) |
void |
setBorderBottom(Measure borderBottom) |
void |
setBorderLeft(Measure borderLeft) |
void |
setBorderRight(Measure borderRight) |
void |
setBorderTop(Measure borderTop) |
void |
setColumns(String columns) |
void |
setColumnSpan(Integer columnSpan) |
void |
setCurrentHeight(Measure currentHeight) |
void |
setCurrentMarkup(Markup currentMarkup) |
void |
setCurrentWidth(Measure currentWidth) |
void |
setDirectLinkCount(Integer directLinkCount) |
void |
setDisplay(Display display) |
void |
setForceVerticalScrollbar(String forceVerticalScrollbar) |
void |
setHeight(Measure height) |
void |
setHorizontalIndex(Integer horizontalIndex) |
void |
setLeft(Measure left) |
void |
setMarginBottom(Measure marginBottom) |
void |
setMarginLeft(Measure marginLeft) |
void |
setMarginRight(Measure marginRight) |
void |
setMarginTop(Measure marginTop) |
void |
setMarkup(Markup markup) |
void |
setMaximumHeight(Measure maximumHeight) |
void |
setMaximumWidth(Measure maximumWidth) |
void |
setMinimumHeight(Measure minimumHeight) |
void |
setMinimumWidth(Measure minimumWidth) |
void |
setOverflowX(boolean overflowX) |
void |
setOverflowY(boolean overflowY) |
void |
setPaddingBottom(Measure paddingBottom) |
void |
setPaddingLeft(Measure paddingLeft) |
void |
setPaddingRight(Measure paddingRight) |
void |
setPaddingTop(Measure paddingTop) |
void |
setPreferredHeight(Measure preferredHeight) |
void |
setPreferredWidth(Measure preferredWidth) |
void |
setRenderedPartially(String[] renderedPartially) |
void |
setRowSpan(Integer rowSpan) |
void |
setSelectable(String selectable) |
void |
setShowDirectLinks(String showDirectLinks) |
void |
setShowDirectLinksArrows(boolean showDirectLinksArrows) |
void |
setShowHeader(boolean showHeader) |
void |
setShowPageRange(String showPageRange) |
void |
setShowPageRangeArrows(boolean showPageRangeArrows) |
void |
setShowPagingAlways(boolean showPagingAlways) |
void |
setShowRoot(boolean showRoot) |
void |
setShowRootJunction(boolean showRootJunction) |
void |
setShowRowRange(String showRowRange) |
void |
setSortActionListener(javax.faces.el.MethodBinding sortActionListener)
Deprecated.
since 2.0.0
|
void |
setSortActionListenerExpression(javax.el.MethodExpression sortActionListener) |
void |
setStateChangeListener(javax.faces.el.MethodBinding stateChangeListener)
Deprecated.
since 2.0.0
|
void |
setStateChangeListenerExpression(javax.el.MethodExpression stateChangeListener) |
void |
setTop(Measure top) |
void |
setVerticalIndex(Integer verticalIndex) |
void |
setWidth(Measure width) |
addStateChangeListener, broadcast, encodeBegin, findComponent, getAllColumns, getColumnLayout, getComponents, getCurrentPage, getExpandedState, getFirstRowIndexOfLastPage, getHeaderGrid, getLast, getLastPageIndex, getLastRowIndexOfCurrentPage, getLayoutComponentRenderer, getLayoutManager, getNeedVerticalScrollbar, getPage, getPages, getRenderedChildrenOf, getRenderedColumns, getScrollPosition, getSelectedState, getSheetState, getState, getStateChangeListeners, getWidthList, hasRowCount, isAtBeginning, isAtEnd, isLayoutChildren, isPagingVisible, isRendersRowContainer, needMoreThanOnePage, onComponentPopulated, performPaging, processEvent, processUpdates, queueEvent, removeStateChangeListener, resetColumnWidths, restoreState, setHeaderGrid, setLayoutManager, setNeedVerticalScrollbar, setState, setWidthList, sort, stripRowIndexcreateTreeDataModel, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, hasRows, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isTreeModelcreateUniqueId, encodeEnd, getContainerClientId, 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, waitisRenderedgetRendererTypepublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class javax.faces.component.UIDatapublic Measure getPreferredWidth()
getPreferredWidth in interface LayoutBasepublic void setPreferredWidth(Measure preferredWidth)
setPreferredWidth in interface LayoutBasepublic Integer getHorizontalIndex()
getHorizontalIndex in interface LayoutComponentpublic void setHorizontalIndex(Integer horizontalIndex)
setHorizontalIndex in interface LayoutComponentpublic Measure getPaddingRight()
getPaddingRight in interface LayoutBoxpublic void setPaddingRight(Measure paddingRight)
setPaddingRight in interface LayoutBoxpublic String getSelectable()
multinone,single,singleOrNone,multipublic void setSelectable(String selectable)
public String getShowDirectLinks()
centerleft,center,right,nonepublic void setShowDirectLinks(String showDirectLinks)
public Measure getPreferredHeight()
getPreferredHeight in interface LayoutBasepublic void setPreferredHeight(Measure preferredHeight)
setPreferredHeight in interface LayoutBasepublic Measure getMarginRight()
getMarginRight in interface LayoutBasepublic void setMarginRight(Measure marginRight)
setMarginRight in interface LayoutBasepublic Measure getBorderLeft()
getBorderLeft in interface LayoutBoxpublic void setBorderLeft(Measure borderLeft)
setBorderLeft in interface LayoutBoxpublic Measure getPaddingBottom()
getPaddingBottom in interface LayoutBoxpublic void setPaddingBottom(Measure paddingBottom)
setPaddingBottom in interface LayoutBoxpublic Measure getCurrentHeight()
getCurrentHeight in interface LayoutBasepublic void setCurrentHeight(Measure currentHeight)
setCurrentHeight in interface LayoutBasepublic Measure getBorderBottom()
getBorderBottom in interface LayoutBoxpublic void setBorderBottom(Measure borderBottom)
setBorderBottom in interface LayoutBoxpublic Measure getHeight()
getHeight in interface LayoutBasepublic void setHeight(Measure height)
setHeight in interface LayoutBasepublic Markup getMarkup()
getMarkup in interface SupportsMarkuppublic void setMarkup(Markup markup)
setMarkup in interface SupportsMarkuppublic boolean isShowPagingAlways()
falseisShowPagingAlways in class AbstractUISheetpublic void setShowPagingAlways(boolean showPagingAlways)
public Integer getDirectLinkCount()
9public void setDirectLinkCount(Integer directLinkCount)
public boolean isShowRootJunction()
falseisShowRootJunction in class AbstractUIDatapublic void setShowRootJunction(boolean showRootJunction)
public boolean isShowPageRangeArrows()
truepublic void setShowPageRangeArrows(boolean showPageRangeArrows)
public boolean isShowDirectLinksArrows()
falsepublic void setShowDirectLinksArrows(boolean showDirectLinksArrows)
public Measure getMarginLeft()
getMarginLeft in interface LayoutBasepublic void setMarginLeft(Measure marginLeft)
setMarginLeft in interface LayoutBasepublic boolean isOverflowX()
isOverflowX in interface LayoutContainerpublic void setOverflowX(boolean overflowX)
setOverflowX in interface LayoutContainerpublic boolean isShowRoot()
falseisShowRoot in class AbstractUIDatapublic void setShowRoot(boolean showRoot)
public boolean isOverflowY()
isOverflowY in interface LayoutContainerpublic void setOverflowY(boolean overflowY)
setOverflowY in interface LayoutContainerpublic String getShowRowRange()
leftleft,center,right,nonepublic void setShowRowRange(String showRowRange)
public Measure getLeft()
getLeft in interface LayoutBasepublic void setLeft(Measure left)
setLeft in interface LayoutBasepublic Measure getBorderRight()
getBorderRight in interface LayoutBoxpublic void setBorderRight(Measure borderRight)
setBorderRight in interface LayoutBoxpublic Measure getMarginBottom()
getMarginBottom in interface LayoutBasepublic void setMarginBottom(Measure marginBottom)
setMarginBottom in interface LayoutBasepublic Measure getPaddingLeft()
getPaddingLeft in interface LayoutBoxpublic void setPaddingLeft(Measure paddingLeft)
setPaddingLeft in interface LayoutBoxpublic Integer getColumnSpan()
getColumnSpan in interface LayoutComponentpublic void setColumnSpan(Integer columnSpan)
setColumnSpan in interface LayoutComponentpublic String getShowPageRange()
rightleft,center,right,nonepublic void setShowPageRange(String showPageRange)
public String getColumns()
getColumns in class AbstractUISheetpublic void setColumns(String columns)
public Measure getBorderTop()
getBorderTop in interface LayoutBoxpublic void setBorderTop(Measure borderTop)
setBorderTop in interface LayoutBoxpublic Measure getTop()
getTop in interface LayoutBasepublic void setTop(Measure top)
setTop in interface LayoutBasepublic Measure getCurrentWidth()
getCurrentWidth in interface LayoutBasepublic void setCurrentWidth(Measure currentWidth)
setCurrentWidth in interface LayoutBasepublic Measure getMaximumWidth()
getMaximumWidth in interface LayoutBasepublic void setMaximumWidth(Measure maximumWidth)
setMaximumWidth in interface LayoutBasepublic Measure getPaddingTop()
getPaddingTop in interface LayoutBoxpublic void setPaddingTop(Measure paddingTop)
setPaddingTop in interface LayoutBox@Deprecated public javax.faces.el.MethodBinding getStateChangeListener()
getStateChangeListener in interface SheetStateChangeSource@Deprecated public void setStateChangeListener(javax.faces.el.MethodBinding stateChangeListener)
setStateChangeListener in interface SheetStateChangeSourcepublic javax.el.MethodExpression getStateChangeListenerExpression()
getStateChangeListenerExpression in interface SheetStateChangeSource2public void setStateChangeListenerExpression(javax.el.MethodExpression stateChangeListener)
setStateChangeListenerExpression in interface SheetStateChangeSource2public Integer getRowSpan()
getRowSpan in interface LayoutComponentpublic void setRowSpan(Integer rowSpan)
setRowSpan in interface LayoutComponentpublic boolean isShowHeader()
trueisShowHeader in class AbstractUISheetpublic void setShowHeader(boolean showHeader)
public Display getDisplay()
getDisplay in interface LayoutComponentpublic void setDisplay(Display display)
setDisplay in interface LayoutComponent@Deprecated public javax.faces.el.MethodBinding getSortActionListener()
getSortActionListener in interface SortActionSource@Deprecated public void setSortActionListener(javax.faces.el.MethodBinding sortActionListener)
setSortActionListener in interface SortActionSourcepublic javax.el.MethodExpression getSortActionListenerExpression()
getSortActionListenerExpression in interface SortActionSource2public void setSortActionListenerExpression(javax.el.MethodExpression sortActionListener)
setSortActionListenerExpression in interface SortActionSource2public Measure getMinimumHeight()
getMinimumHeight in interface LayoutBasepublic void setMinimumHeight(Measure minimumHeight)
setMinimumHeight in interface LayoutBasepublic Markup getCurrentMarkup()
getCurrentMarkup in interface SupportsMarkupgetCurrentMarkup in interface Configurablepublic void setCurrentMarkup(Markup currentMarkup)
setCurrentMarkup in interface SupportsMarkuppublic String[] getRenderedPartially()
Indicate the partially rendered components in a case of a submit.
The search depends on the number of prefixed colons in the relativeId:
If a literal is specified: to use more than one identifier the identifiers must be space delimited.
Using this in a UISheet or UITabGroup component this list indicates components to update when calling internal AJAX requests like sort or paging commands. Don't forget to add the sheet-id or tagGroup-id in that case, if needed.
You can also use
getRenderedPartially in interface SupportsRenderedPartiallypublic void setRenderedPartially(String[] renderedPartially)
setRenderedPartially in interface SupportsRenderedPartiallypublic Measure getWidth()
getWidth in interface LayoutBasepublic void setWidth(Measure width)
setWidth in interface LayoutBasepublic String getForceVerticalScrollbar()
'auto' : sheet try to estimate the need of scrollbar.
'true' : space for scrollbar is reserved.
'false' : no space is reserved.
autoauto,true,falsepublic void setForceVerticalScrollbar(String forceVerticalScrollbar)
public Measure getMaximumHeight()
getMaximumHeight in interface LayoutBasepublic void setMaximumHeight(Measure maximumHeight)
setMaximumHeight in interface LayoutBasepublic Integer getVerticalIndex()
getVerticalIndex in interface LayoutComponentpublic void setVerticalIndex(Integer verticalIndex)
setVerticalIndex in interface LayoutComponentpublic Measure getMinimumWidth()
getMinimumWidth in interface LayoutBasepublic void setMinimumWidth(Measure minimumWidth)
setMinimumWidth in interface LayoutBasepublic Measure getMarginTop()
getMarginTop in interface LayoutBasepublic void setMarginTop(Measure marginTop)
setMarginTop in interface LayoutBasepublic Object saveState(javax.faces.context.FacesContext context)
saveState in interface javax.faces.component.StateHoldersaveState in class AbstractUISheetCopyright © 2002–2022 The Apache Software Foundation. All rights reserved.