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_ID
SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTED
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
MARKER
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, processUpdates, queueEvent, removeStateChangeListener, resetColumnWidths, restoreState, setHeaderGrid, setLayoutManager, setNeedVerticalScrollbar, setState, setWidthList, stripRowIndex
createTreeDataModel, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, hasRows, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isTreeModel
createUniqueId, encodeEnd, getContainerClientId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, processDecodes, processValidators, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueExpression, setVar, visitTree
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
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
isRendered
getRendererType
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class javax.faces.component.UIData
public Markup getMarkup()
getMarkup
in interface SupportsMarkup
public void setMarkup(Markup markup)
setMarkup
in interface SupportsMarkup
public Measure getMarginLeft()
getMarginLeft
in interface LayoutBase
public void setMarginLeft(Measure marginLeft)
setMarginLeft
in interface LayoutBase
public String getColumns()
getColumns
in class AbstractUISheet
public void setColumns(String columns)
public Measure getBorderLeft()
getBorderLeft
in interface LayoutBox
public void setBorderLeft(Measure borderLeft)
setBorderLeft
in interface LayoutBox
public Measure getHeight()
getHeight
in interface LayoutBase
public void setHeight(Measure height)
setHeight
in interface LayoutBase
public Measure getMinimumWidth()
getMinimumWidth
in interface LayoutBase
public void setMinimumWidth(Measure minimumWidth)
setMinimumWidth
in interface LayoutBase
public String getShowDirectLinks()
center
left,center,right,none
public void setShowDirectLinks(String showDirectLinks)
public String getShowPageRange()
right
left,center,right,none
public void setShowPageRange(String showPageRange)
public boolean isOverflowX()
isOverflowX
in interface LayoutContainer
public void setOverflowX(boolean overflowX)
setOverflowX
in interface LayoutContainer
public boolean isOverflowY()
isOverflowY
in interface LayoutContainer
public void setOverflowY(boolean overflowY)
setOverflowY
in interface LayoutContainer
public String getForceVerticalScrollbar()
'auto' : sheet try to estimate the need of scrollbar. 'true' : space for scrollbar is reserved. 'false' : no space is reserved.
auto
auto,true,false
public void setForceVerticalScrollbar(String forceVerticalScrollbar)
@Deprecated public javax.faces.el.MethodBinding getStateChangeListener()
getStateChangeListener
in interface SheetStateChangeSource
@Deprecated public void setStateChangeListener(javax.faces.el.MethodBinding stateChangeListener)
setStateChangeListener
in interface SheetStateChangeSource
public javax.el.MethodExpression getStateChangeListenerExpression()
getStateChangeListenerExpression
in interface SheetStateChangeSource2
public void setStateChangeListenerExpression(javax.el.MethodExpression stateChangeListener)
setStateChangeListenerExpression
in interface SheetStateChangeSource2
public Measure getBorderRight()
getBorderRight
in interface LayoutBox
public void setBorderRight(Measure borderRight)
setBorderRight
in interface LayoutBox
public Measure getMaximumHeight()
getMaximumHeight
in interface LayoutBase
public void setMaximumHeight(Measure maximumHeight)
setMaximumHeight
in interface LayoutBase
public Measure getCurrentWidth()
getCurrentWidth
in interface LayoutBase
public void setCurrentWidth(Measure currentWidth)
setCurrentWidth
in interface LayoutBase
public Measure getPaddingTop()
getPaddingTop
in interface LayoutBox
public void setPaddingTop(Measure paddingTop)
setPaddingTop
in interface LayoutBox
public Measure getMarginTop()
getMarginTop
in interface LayoutBase
public void setMarginTop(Measure marginTop)
setMarginTop
in interface LayoutBase
public Measure getWidth()
getWidth
in interface LayoutBase
public void setWidth(Measure width)
setWidth
in interface LayoutBase
public Measure getCurrentHeight()
getCurrentHeight
in interface LayoutBase
public void setCurrentHeight(Measure currentHeight)
setCurrentHeight
in interface LayoutBase
public Display getDisplay()
getDisplay
in interface LayoutComponent
public void setDisplay(Display display)
setDisplay
in interface LayoutComponent
public Measure getBorderBottom()
getBorderBottom
in interface LayoutBox
public void setBorderBottom(Measure borderBottom)
setBorderBottom
in interface LayoutBox
public boolean isShowRootJunction()
false
isShowRootJunction
in class AbstractUIData
public void setShowRootJunction(boolean showRootJunction)
public Measure getPaddingLeft()
getPaddingLeft
in interface LayoutBox
public void setPaddingLeft(Measure paddingLeft)
setPaddingLeft
in interface LayoutBox
public Measure getPreferredWidth()
getPreferredWidth
in interface LayoutBase
public void setPreferredWidth(Measure preferredWidth)
setPreferredWidth
in interface LayoutBase
public Measure getBorderTop()
getBorderTop
in interface LayoutBox
public void setBorderTop(Measure borderTop)
setBorderTop
in interface LayoutBox
public Integer getVerticalIndex()
getVerticalIndex
in interface LayoutComponent
public void setVerticalIndex(Integer verticalIndex)
setVerticalIndex
in interface LayoutComponent
public boolean isShowPagingAlways()
false
isShowPagingAlways
in class AbstractUISheet
public void setShowPagingAlways(boolean showPagingAlways)
public Markup getCurrentMarkup()
getCurrentMarkup
in interface SupportsMarkup
getCurrentMarkup
in interface Configurable
public void setCurrentMarkup(Markup currentMarkup)
setCurrentMarkup
in interface SupportsMarkup
public 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 SupportsRenderedPartially
public void setRenderedPartially(String[] renderedPartially)
setRenderedPartially
in interface SupportsRenderedPartially
public Measure getMinimumHeight()
getMinimumHeight
in interface LayoutBase
public void setMinimumHeight(Measure minimumHeight)
setMinimumHeight
in interface LayoutBase
public boolean isShowPageRangeArrows()
true
public void setShowPageRangeArrows(boolean showPageRangeArrows)
public boolean isShowRoot()
false
isShowRoot
in class AbstractUIData
public void setShowRoot(boolean showRoot)
public Integer getRowSpan()
getRowSpan
in interface LayoutComponent
public void setRowSpan(Integer rowSpan)
setRowSpan
in interface LayoutComponent
public Measure getLeft()
getLeft
in interface LayoutBase
public void setLeft(Measure left)
setLeft
in interface LayoutBase
public Integer getColumnSpan()
getColumnSpan
in interface LayoutComponent
public void setColumnSpan(Integer columnSpan)
setColumnSpan
in interface LayoutComponent
public Measure getPaddingBottom()
getPaddingBottom
in interface LayoutBox
public void setPaddingBottom(Measure paddingBottom)
setPaddingBottom
in interface LayoutBox
public Measure getTop()
getTop
in interface LayoutBase
public void setTop(Measure top)
setTop
in interface LayoutBase
public boolean isShowDirectLinksArrows()
false
public void setShowDirectLinksArrows(boolean showDirectLinksArrows)
public String getShowRowRange()
left
left,center,right,none
public void setShowRowRange(String showRowRange)
public Measure getMarginRight()
getMarginRight
in interface LayoutBase
public void setMarginRight(Measure marginRight)
setMarginRight
in interface LayoutBase
public Measure getPreferredHeight()
getPreferredHeight
in interface LayoutBase
public void setPreferredHeight(Measure preferredHeight)
setPreferredHeight
in interface LayoutBase
public Measure getMaximumWidth()
getMaximumWidth
in interface LayoutBase
public void setMaximumWidth(Measure maximumWidth)
setMaximumWidth
in interface LayoutBase
public Measure getPaddingRight()
getPaddingRight
in interface LayoutBox
public void setPaddingRight(Measure paddingRight)
setPaddingRight
in interface LayoutBox
public Measure getMarginBottom()
getMarginBottom
in interface LayoutBase
public void setMarginBottom(Measure marginBottom)
setMarginBottom
in interface LayoutBase
public String getSelectable()
multi
none,single,singleOrNone,multi
public void setSelectable(String selectable)
public boolean isShowHeader()
true
isShowHeader
in class AbstractUISheet
public void setShowHeader(boolean showHeader)
public Integer getDirectLinkCount()
9
public void setDirectLinkCount(Integer directLinkCount)
@Deprecated public javax.faces.el.MethodBinding getSortActionListener()
getSortActionListener
in interface SortActionSource
@Deprecated public void setSortActionListener(javax.faces.el.MethodBinding sortActionListener)
setSortActionListener
in interface SortActionSource
public javax.el.MethodExpression getSortActionListenerExpression()
getSortActionListenerExpression
in interface SortActionSource2
public void setSortActionListenerExpression(javax.el.MethodExpression sortActionListener)
setSortActionListenerExpression
in interface SortActionSource2
public Integer getHorizontalIndex()
getHorizontalIndex
in interface LayoutComponent
public void setHorizontalIndex(Integer horizontalIndex)
setHorizontalIndex
in interface LayoutComponent
public Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class AbstractUISheet
Copyright © 2002-2015 The Apache Software Foundation. All Rights Reserved.