com.ibm.xsp.component.xp
Class XspViewColumnHeader

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              com.ibm.xsp.component.UIDataPanelBase
                  com.ibm.xsp.component.UIPanelEx
                      com.ibm.xsp.component.UIViewColumnHeader
                          com.ibm.xsp.component.xp.XspViewColumnHeader

All Implemented Interfaces:

FacesComponent, FacesDataProvider, FacesDojoComponent, ThemeControl, javax.faces.component.StateHolder

public class XspViewColumnHeader
extends UIViewColumnHeader

A control that displays a header for a view column

XPages Container Controls - View Column Header

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String

COMPONENT_TYPE

Fields inherited from class com.ibm.xsp.component.UIViewColumnHeader

CHECKBOX_STYLE, IMAGE_SORT_BOTH, IMAGE_SORT_BOTH_ASCENDING, IMAGE_SORT_BOTH_DESCENDING, IMAGE_SORTED_ASCENDING, IMAGE_SORTED_DESCENDING

Fields inherited from class com.ibm.xsp.component.UIPanelEx

RENDERER_TYPE

Fields inherited from class javax.faces.component.UIPanel

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Fields inherited from interface com.ibm.xsp.component.FacesDataProvider

DATA, DATA_CONTEXTS

Constructor Summary

XspViewColumnHeader()

Method Summary

java.lang.String	getRole() Return the value of the role property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
void	setRole(java.lang.String role) Set the value of the role property.

Methods inherited from class com.ibm.xsp.component.UIViewColumnHeader

buildContents, encodeBegin, getContentType, getHtmlFilter, getIconAlt, getIconSrc, getRendersChildren, getSortIcon, getSortIconAltText, getStyle, getStyleClass, getStyleKitFamily, getValue, isColumnSortable, isRendered, isShowCheckbox, isSortable, setContentType, setHtmlFilter, setIconAlt, setIconSrc, setShowCheckbox, setSortable, setSortable, setStyle, setStyleClass, setValue

Methods inherited from class com.ibm.xsp.component.UIPanelEx

_xspCleanTransientData, addDojoAttribute, getDir, getDojoAttributes, getDojoType, getOnClientLoad, getOuterStyleClass, getTitle, setDir, setDojoAttributes, setDojoType, setOnClientLoad, setOuterStyleClass, setTitle

Methods inherited from class com.ibm.xsp.component.UIDataPanelBase

addData, addDataContext, afterEncoding, beforeEncoding, broadcast, encodeEnd, getAcl, getData, getDataContexts, hasUserAccess, initAfterContents, initBeforeContents, invokeOnComponent, isAllowCreateViewPublish, isReadonly, processDecodes, processUpdates, processValidators, publishControlData, queueEvent, revokeControlData, setAcl, setReadonly, visitTree

Methods inherited from class javax.faces.component.UIPanel

getFamily

Methods inherited from class javax.faces.component.UIComponentBase

_xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, isVisitable, markInitialState, setControlState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

XspViewColumnHeader

public XspViewColumnHeader()

Method Detail

getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.

Overrides:

getRole in class UIPanelEx

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class UIViewColumnHeader

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIViewColumnHeader

setRole

public void setRole(java.lang.String role)

Set the value of the role property.

Overrides:

setRole in class UIPanelEx