com.ibm.xsp.component
Class UIViewColumnHeader

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

All Implemented Interfaces:

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

Direct Known Subclasses:

XspViewColumnHeader

public class UIViewColumnHeader
extends UIPanelEx

Abstract View Column Header Component used in conjunction with the viewColumn on a viewPanel This adds additional functionality such as sorting and checkboxes.

By default, the rendererType property must be set to "com.ibm.xsp.ViewColumnHeader" This value can be changed by calling the setRendererType() method.

Not intended to be subclassed.

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	CHECKBOX_STYLE
static java.lang.String	COMPONENT_TYPE The standard component type for this component.
static java.lang.String	IMAGE_SORT_BOTH
static java.lang.String	IMAGE_SORT_BOTH_ASCENDING
static java.lang.String	IMAGE_SORT_BOTH_DESCENDING
static java.lang.String	IMAGE_SORTED_ASCENDING
static java.lang.String	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

UIViewColumnHeader()
Abstract View Column Header component constructor.

Method Summary

void	buildContents(javax.faces.context.FacesContext context, FacesComponentBuilder builder) Build the component children and facets, the default implementation is usually: builder.buildAll(context, this, true); // includeFacets=true
void	encodeBegin(javax.faces.context.FacesContext context)
java.lang.String	getContentType() Return the value of the contentType property.
java.lang.String	getHtmlFilter() Return the value of the htmlFilter property.
java.lang.String	getIconAlt() Return the value of the iconAlt property.
java.lang.String	getIconSrc() Return the value of the iconSrc property.
boolean	getRendersChildren()
java.lang.String	getSortIcon() Returns the URL for the current sort order for this column.
java.lang.String	getSortIconAltText() Returns the alt text for the current sort order icon for this column.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getStyleKitFamily() The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source.
java.lang.Object	getValue() Return the value of the value property.
boolean	isColumnSortable() flag indicating if this column is set to sortable
boolean	isRendered()
boolean	isShowCheckbox() Return the value of the showCheckbox property.
boolean	isSortable()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setContentType(java.lang.String contentType) Set the value of the contentType property.
void	setHtmlFilter(java.lang.String htmlFilter) Set the value of the htmlFilter property.
void	setIconAlt(java.lang.String iconAlt) Set the value of the iconAlt property.
void	setIconSrc(java.lang.String iconSrc) Set the value of the iconSrc property.
void	setShowCheckbox(boolean hasCheckbox) Set the value of the showCheckbox property.
void	setSortable(boolean sortable)
void	setSortable(java.lang.String sortable)
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setValue(java.lang.Object value) Set the value of the value property.

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

_xspCleanTransientData, addDojoAttribute, getDir, getDojoAttributes, getDojoType, getOnClientLoad, getOuterStyleClass, getRole, getTitle, setDir, setDojoAttributes, setDojoType, setOnClientLoad, setOuterStyleClass, setRole, 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

The standard component type for this component.

See Also:

Constant Field Values

IMAGE_SORT_BOTH

public static final java.lang.String IMAGE_SORT_BOTH

See Also:

Constant Field Values

IMAGE_SORT_BOTH_ASCENDING

public static final java.lang.String IMAGE_SORT_BOTH_ASCENDING

See Also:

Constant Field Values

IMAGE_SORT_BOTH_DESCENDING

public static final java.lang.String IMAGE_SORT_BOTH_DESCENDING

See Also:

Constant Field Values

IMAGE_SORTED_ASCENDING

public static final java.lang.String IMAGE_SORTED_ASCENDING

See Also:

Constant Field Values

IMAGE_SORTED_DESCENDING

public static final java.lang.String IMAGE_SORTED_DESCENDING

See Also:

Constant Field Values

CHECKBOX_STYLE

public static final java.lang.String CHECKBOX_STYLE

See Also:

Constant Field Values

Constructor Detail

UIViewColumnHeader

public UIViewColumnHeader()

Abstract View Column Header component constructor.

Method Detail

getStyleKitFamily

public java.lang.String getStyleKitFamily()

Description copied from interface: ThemeControl

The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source. For example, "InputField.EditBox" is used for most Edit Box controls. See Domino/xsp/nsf/themes/webstandard.theme for more examples.

The implementation may return different values depending on the configuration of the current control, for example the Button control returns a different value and looks different when it is configured as a cancel button.

Specified by:

getStyleKitFamily in interface ThemeControl

Overrides:

getStyleKitFamily in class UIPanelEx

Returns:

a non-null themeId corresponding to the configuration for this type of control in a theme file.

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class javax.faces.component.UIComponentBase

buildContents

public void buildContents(javax.faces.context.FacesContext context,
                          FacesComponentBuilder builder)
                   throws javax.faces.FacesException

Description copied from interface: FacesComponent

Build the component children and facets, the default implementation is usually:
builder.buildAll(context, this, true); // includeFacets=true

Specified by:

buildContents in interface FacesComponent

Overrides:

buildContents in class UIDataPanelBase

Throws:

javax.faces.FacesException

isColumnSortable

public boolean isColumnSortable()

flag indicating if this column is set to sortable

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

Overrides:

encodeBegin in class UIDataPanelBase

Throws:

java.io.IOException

getSortIcon

public java.lang.String getSortIcon()

Returns the URL for the current sort order for this column.

Returns:

Sort icon URL

getSortIconAltText

public java.lang.String getSortIconAltText()

Returns the alt text for the current sort order icon for this column.

Returns:

Sort icon alternate text

getContentType

public java.lang.String getContentType()

Return the value of the contentType property. Contents:

String value indicating the type of content to expect, currently HTML and Text are supported.

getHtmlFilter

public java.lang.String getHtmlFilter()

Return the value of the htmlFilter property. Contents:

Property indicating which Active Content Filtering processor should be used.

isRendered

public boolean isRendered()

Overrides:

isRendered in class UIDataPanelBase

getIconAlt

public java.lang.String getIconAlt()

Return the value of the iconAlt property. Contents:

Alternative text to display if the image cannot be displayed.

getIconSrc

public java.lang.String getIconSrc()

Return the value of the iconSrc property. Contents:

url to image, used to display an icon to the left of the column header text.

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

CSS style(s) to be applied to the column.

Overrides:

getStyle in class UIPanelEx

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Space-separated list of CSS style class(es) to be applied to the column.

Overrides:

getStyleClass in class UIPanelEx

isShowCheckbox

public boolean isShowCheckbox()

Return the value of the showCheckbox property. Contents:

Displays a check box beside the Header (will cause select all on column).

isSortable

public boolean isSortable()

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 UIPanelEx

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIPanelEx

setContentType

public void setContentType(java.lang.String contentType)

Set the value of the contentType property.

setHtmlFilter

public void setHtmlFilter(java.lang.String htmlFilter)

Set the value of the htmlFilter property.

setShowCheckbox

public void setShowCheckbox(boolean hasCheckbox)

Set the value of the showCheckbox property.

setSortable

public void setSortable(java.lang.String sortable)

setSortable

public void setSortable(boolean sortable)

setIconAlt

public void setIconAlt(java.lang.String iconAlt)

Set the value of the iconAlt property.

setIconSrc

public void setIconSrc(java.lang.String iconSrc)

Set the value of the iconSrc property.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Overrides:

setStyle in class UIPanelEx

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Overrides:

setStyleClass in class UIPanelEx

getValue

public java.lang.Object getValue()

Return the value of the value property. Contents:

String that represents the title of the Column Header.

setValue

public void setValue(java.lang.Object value)

Set the value of the value property.