public class UISheet extends AbstractUISheet implements SortActionSource2, Visual
component.stg
with class
SheetTagDeclaration
.Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
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 |
---|---|
String |
getColumns()
LayoutConstraints for column layout.
|
Markup |
getCurrentMarkup() |
CustomClass |
getCustomClass()
Sets a CSS class in its parent, if the parent supports it.
|
Integer |
getDirectLinkCount()
The count of rendered direct paging links in the sheet's footer.
|
String |
getFamily() |
String |
getForceVerticalScrollbar()
Flag indicating whether or not this sheet should reserve space for
vertical toolbar when calculating column width's.
|
Markup |
getMarkup() |
String[] |
getRenderedPartially()
Indicate the partially rendered components in a case of a submit.
|
Selectable |
getSelectable()
Indicating the selection mode of the sheet.
|
ShowPosition |
getShowDirectLinks()
Flag indicating whether or not a range of direct paging links should be
rendered in the sheet's footer.
|
ShowPosition |
getShowPageRange()
Flag indicating whether and where the range pages should
rendered in the sheet's footer.
|
ShowPosition |
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() |
Style |
getStyle()
For internal use.
|
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 |
setColumns(String columns) |
void |
setCurrentMarkup(Markup currentMarkup) |
void |
setCustomClass(CustomClass customClass) |
void |
setDirectLinkCount(Integer directLinkCount) |
void |
setForceVerticalScrollbar(String forceVerticalScrollbar) |
void |
setMarkup(Markup markup) |
void |
setRenderedPartially(String[] renderedPartially) |
void |
setSelectable(Selectable selectable) |
void |
setShowDirectLinks(ShowPosition showDirectLinks) |
void |
setShowDirectLinksArrows(boolean showDirectLinksArrows) |
void |
setShowHeader(boolean showHeader) |
void |
setShowPageRange(ShowPosition showPageRange) |
void |
setShowPageRangeArrows(boolean showPageRangeArrows) |
void |
setShowPagingAlways(boolean showPagingAlways) |
void |
setShowRoot(boolean showRoot) |
void |
setShowRootJunction(boolean showRootJunction) |
void |
setShowRowRange(ShowPosition 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 |
setStyle(Style style) |
addStateChangeListener, broadcast, encodeBegin, findComponent, getAllColumns, getColumnLayout, getCurrentPage, getExpandedState, getFirstRowIndexOfLastPage, getHeaderGrid, getLast, getLastRowIndexOfCurrentPage, getPage, getPages, getRenderedChildrenOf, getRenderedColumns, getScrollPosition, getSelectedState, getSheetState, getState, getStateChangeListeners, getWidthList, hasRowCount, isAtBeginning, isAtEnd, isPagingVisible, isRendersRowContainer, needMoreThanOnePage, onComponentPopulated, performPaging, processEvent, processUpdates, queueEvent, removeStateChangeListener, resetColumnWidths, restoreState, setHeaderGrid, setState, setWidthList, sort, 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, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getRendererType
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class javax.faces.component.UIData
public boolean isShowDirectLinksArrows()
false
public void setShowDirectLinksArrows(boolean showDirectLinksArrows)
public ShowPosition getShowRowRange()
left
left,center,right,none
public void setShowRowRange(ShowPosition showRowRange)
public String getColumns()
getColumns
in class AbstractUISheet
public void setColumns(String columns)
public boolean isShowRootJunction()
false
isShowRootJunction
in class AbstractUIData
public void setShowRootJunction(boolean showRootJunction)
public CustomClass getCustomClass()
<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
getCustomClass
in interface Visual
public void setCustomClass(CustomClass customClass)
setCustomClass
in interface Visual
public boolean isShowPageRangeArrows()
true
public void setShowPageRangeArrows(boolean showPageRangeArrows)
public Style getStyle()
public boolean isShowRoot()
false
isShowRoot
in class AbstractUIData
public void setShowRoot(boolean showRoot)
public Selectable getSelectable()
multi
none,single,singleOrNone,multi
getSelectable
in class AbstractUIData
public void setSelectable(Selectable selectable)
public ShowPosition getShowDirectLinks()
center
left,center,right,none
public void setShowDirectLinks(ShowPosition showDirectLinks)
public boolean isShowHeader()
true
isShowHeader
in class AbstractUISheet
public void setShowHeader(boolean showHeader)
public Integer getDirectLinkCount()
9
public void setDirectLinkCount(Integer directLinkCount)
public ShowPosition getShowPageRange()
right
left,center,right,none
public void setShowPageRange(ShowPosition showPageRange)
public boolean isShowPagingAlways()
false
isShowPagingAlways
in class AbstractUISheet
public void setShowPagingAlways(boolean showPagingAlways)
@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 Markup getCurrentMarkup()
getCurrentMarkup
in interface Visual
public void setCurrentMarkup(Markup currentMarkup)
setCurrentMarkup
in interface Visual
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 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 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.