org.apache.myfaces.tobago.component

Class UISheet

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

org.apache.myfaces.tobago.component.UISheet

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, 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, Visual, SheetStateChangeSource, SheetStateChangeSource2, SortActionSource, SortActionSource2

public class UISheet
extends AbstractUISheet
implements SortActionSource2, Visual

Render a sheet element. UIComponent class, generated from template component.stg with class SheetTagDeclaration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheet

SORTER_ID

Fields inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData

SUFFIX_EXPANDED, SUFFIX_MARKED, SUFFIX_SELECTED

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

Constructor Summary

Constructors

Constructor and Description
UISheet()

Method Summary

Modifier and Type	Method and Description
String	getColumns() LayoutConstraints for column layout.
CustomClass	getCustomClass() Sets a CSS class in its parent, if the parent supports it.
String	getDefaultEventName()
Integer	getDirectLinkCount() The count of rendered direct paging links in the sheet's footer.
Collection<String>	getEventNames()
String	getFamily()
Markup	getMarkup()
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.
void	setColumns(String columns)
void	setCustomClass(CustomClass customClass)
void	setDirectLinkCount(Integer directLinkCount)
void	setMarkup(Markup markup)
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)

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISheet

addStateChangeListener, broadcast, encodeBegin, findComponent, getAllColumns, getColumnLayout, getCurrentPage, getExpandedState, getFirstRowIndexOfLastPage, getHeaderGrid, getLast, getLastRowIndexOfCurrentPage, getPage, getPages, getRenderedChildrenOf, getSelectedState, getSheetState, getState, getStateChangeListeners, hasRowCount, init, isAtBeginning, isAtEnd, isAutoLayout, isPagingVisible, isRendersRowContainer, needMoreThanOnePage, performPaging, processEvent, processUpdates, queueEvent, removeStateChangeListener, restoreState, saveState, setHeaderGrid, setState, sort, stripRowIndex

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIData

createTreeDataModel, getDataModel, getPath, getRowClientId, getRowIndicesOfChildren, getRowParentClientId, getSelectableAsEnum, getTreeDataModel, hasRows, invokeOnComponent, isFolder, isRowsUnlimited, isRowVisible, isTreeModel, visitTree

Methods inherited from class javax.faces.component.UIData

createUniqueId, encodeEnd, getContainerClientId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, processDecodes, processValidators, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueExpression, setVar

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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, 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.component.Visual

getRendererType

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UISheet

public UISheet()

Method Detail

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface Visual

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface Visual

getShowPageRange

public ShowPosition getShowPageRange()

Flag indicating whether and where the range pages should rendered in the sheet's footer. Rendering this range also offers the capability to enter the index displayed page directly.
Default: right
Allowed Values: left,center,right,none

setShowPageRange

public void setShowPageRange(ShowPosition showPageRange)

isShowPagingAlways

public boolean isShowPagingAlways()

Flag indicating whether or not the paging panel should be display, if it is not needed for paging.

• showPagingAlways="false" which is the default means, that the paging footer should be displayed, only when it is needed.
  • When the rows="0" paging is not needed, so the footer will not be rendered,
  • when rows="N", N > 0 and the size of the data value is <= N paging is not needed and the footer will not be rendered,
  • in any other case the paging footer will be displayed.
• showPagingAlways="true" means, that the paging footer should be displayed in any case.

Default: false

Specified by:

isShowPagingAlways in class AbstractUISheet

setShowPagingAlways

public void setShowPagingAlways(boolean showPagingAlways)

getDirectLinkCount

public Integer getDirectLinkCount()

The count of rendered direct paging links in the sheet's footer.

Default: 9

setDirectLinkCount

public void setDirectLinkCount(Integer directLinkCount)

isShowRootJunction

public boolean isShowRootJunction()

Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed with an open-close-switch.
Default: false

Overrides:

isShowRootJunction in class AbstractUIData

setShowRootJunction

public void setShowRootJunction(boolean showRootJunction)

getColumns

public String getColumns()

LayoutConstraints for column layout. Semicolon separated list of layout tokens ('<x>*', '<x>px' or '<x>%') or "auto"

Specified by:

getColumns in class AbstractUISheet

setColumns

public void setColumns(String columns)

isShowHeader

public boolean isShowHeader()

Flag indicating the header should be rendered.
Default: true

Specified by:

isShowHeader in class AbstractUISheet

setShowHeader

public void setShowHeader(boolean showHeader)

isShowPageRangeArrows

public boolean isShowPageRangeArrows()

Flag indicating if paging arrows are shown near page range
Default: true

setShowPageRangeArrows

public void setShowPageRangeArrows(boolean showPageRangeArrows)

getSelectable

public Selectable getSelectable()

Indicating the selection mode of the sheet.
Default: multi
Allowed Values: none,single,singleOrNone,multi

Specified by:

getSelectable in class AbstractUIData

setSelectable

public void setSelectable(Selectable selectable)

getSortActionListener

@Deprecated
public javax.faces.el.MethodBinding getSortActionListener()

Deprecated. since 2.0.0

Specified by:

getSortActionListener in interface SortActionSource

setSortActionListener

@Deprecated
public void setSortActionListener(javax.faces.el.MethodBinding sortActionListener)

Deprecated. since 2.0.0

Specified by:

setSortActionListener in interface SortActionSource

getSortActionListenerExpression

public javax.el.MethodExpression getSortActionListenerExpression()

Specified by:

getSortActionListenerExpression in interface SortActionSource2

setSortActionListenerExpression

public void setSortActionListenerExpression(javax.el.MethodExpression sortActionListener)

Specified by:

setSortActionListenerExpression in interface SortActionSource2

getShowDirectLinks

public ShowPosition getShowDirectLinks()

Flag indicating whether or not a range of direct paging links should be rendered in the sheet's footer.
Default: center
Allowed Values: left,center,right,none

setShowDirectLinks

public void setShowDirectLinks(ShowPosition showDirectLinks)

isShowDirectLinksArrows

public boolean isShowDirectLinksArrows()

Flag indicating if paging arrows are shown near direct links
Default: false

setShowDirectLinksArrows

public void setShowDirectLinksArrows(boolean showDirectLinksArrows)

isShowRoot

public boolean isShowRoot()

Only applicable in the case that the data model is a tree. This flag indicates that the root node should be displayed. Often in tree structures the root node is special and should not be displayed.
Default: false

Specified by:

isShowRoot in class AbstractUIData

setShowRoot

public void setShowRoot(boolean showRoot)

getShowRowRange

public ShowPosition getShowRowRange()

Flag indicating whether or not the range of displayed rows should rendered in the sheet's footer. Rendering this range also offers the capability to enter the index of the start row directly.
Default: left
Allowed Values: left,center,right,none

setShowRowRange

public void setShowRowRange(ShowPosition showRowRange)

getCustomClass

public CustomClass getCustomClass()

Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:

   <tc:in>
     <tc:style customClass="my-emphasized"/>
   </tc:in>
   

One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.

Specified by:

getCustomClass in interface Visual

setCustomClass

public void setCustomClass(CustomClass customClass)

Specified by:

setCustomClass in interface Visual

getStyle

public Style getStyle()

For internal use. Used for rendering, if there is a child tag <tc:style>

Specified by:

getStyle in interface Visual

setStyle

public void setStyle(Style style)

Specified by:

setStyle in interface Visual

getStateChangeListener

@Deprecated
public javax.faces.el.MethodBinding getStateChangeListener()

Deprecated. since 2.0.0

Specified by:

getStateChangeListener in interface SheetStateChangeSource

setStateChangeListener

@Deprecated
public void setStateChangeListener(javax.faces.el.MethodBinding stateChangeListener)

Deprecated. since 2.0.0

Specified by:

setStateChangeListener in interface SheetStateChangeSource

getStateChangeListenerExpression

public javax.el.MethodExpression getStateChangeListenerExpression()

Specified by:

getStateChangeListenerExpression in interface SheetStateChangeSource2

setStateChangeListenerExpression

public void setStateChangeListenerExpression(javax.el.MethodExpression stateChangeListener)

Specified by:

setStateChangeListenerExpression in interface SheetStateChangeSource2