com.ibm.xsp.component
Class UIViewColumn

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIColumn
              com.ibm.xsp.component.UIColumnEx
                  com.ibm.xsp.component.UIViewColumn

All Implemented Interfaces:

FacesAttrsObject, FacesComponent, FacesParentReliantComponent, FacesThemeHandler, ThemeControl, javax.faces.component.NamingContainer, javax.faces.component.StateHolder

Direct Known Subclasses:

XspViewColumn

public class UIViewColumn
extends UIColumnEx
implements FacesComponent, FacesThemeHandler, FacesAttrsObject

By default, the rendererType property must be set to "com.ibm.xsp.ViewColumn" 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	COMPONENT_TYPE
static java.lang.String	DEFAULT_COLLAPSED_IMAGE
static java.lang.String	DEFAULT_COLLAPSED_IMAGE_RTL
static java.lang.String	DEFAULT_EXPANDED_IMAGE
static java.lang.String	HIDDEN value used with displayAs to indicate column text should not be displayed
static java.lang.String	INTERNAL_CHECKBOX_ID
static java.lang.String	INTERNAL_COLUMNICON_ID
static java.lang.String	INTERNAL_COLUMNLINK_ID
static java.lang.String	INTERNAL_COLUMNTEXT_ID
static java.lang.String	LINK value used with displayAs to indicate column content should be displayed as a hyperlink
static java.lang.String	TEXT value used with displayAs to indicate column content should be displayed as a simple text
static java.lang.String	VALUEBINDING_COLUMNS
static java.lang.String	VALUEBINDING_IS_SELECTED
static java.lang.String	VIEW_CHECKBOX_STYLE

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

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 javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIViewColumn()
Abstract View Column Component, used with the viewPanel component, This component adds additional functionality on top of the functionality provided by a standard UIColumn

Method Summary

void	addAttr(Attr attr) Add an Attr, to appear as an attribute in the HTML output of this control or object tag.
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
java.util.List<Attr>	getAttrs() The extra attributes to be output on the base element at the root of this control or object tag.
java.lang.String	getCollapsedImage() Return the value of the collapsedImage property.
java.lang.String	getColumnName() Return the value of the columnName property.
java.lang.String	getContentType() Return the value of the contentType property.
javax.faces.convert.Converter	getConverter() Return the value of the converter property.
javax.faces.model.DataModel	getDataModel()
java.lang.String	getDisplayAs() Return the value of the displayAsLink property.
java.lang.String	getDocumentUrl() Returns the URL need to open the document for the current row.
java.lang.String	getExpandedImage() Return the value of the expandedImage 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.
java.lang.String	getOnclick() Return the value of the onclick property.
java.lang.String	getPageUrl() Return the value of the pageUrl property.
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.
ViewRowData	getViewRowData()
java.lang.String	getWidth() Deprecated. Use style or styleClass instead for width definitions Formerly to define the width of a column
void	initAfterContents(javax.faces.context.FacesContext context) Perform component initialization after it's children and facets are added.
void	initBeforeContents(javax.faces.context.FacesContext context) Perform component initialization before its children and facets are added.
boolean	isIndentResponses() Return the value of the indentResponses property.
boolean	isOpenDocAsReadonly() Return the value of the openDocAsReadonly property.
boolean	isResponseDocument() returns boolean indicating if the current document is a response document.
boolean	isShowCheckbox() Return the value of the showCheckbox property.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAttrs(java.util.List<Attr> attrs) This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.
void	setCollapsedImage(java.lang.String collapsedImage) Set the value of the collapsedImage property.
void	setColumnName(java.lang.String columnName) Set the value of the columnName property.
void	setContentType(java.lang.String contentType) Set the value of the contentType property.
void	setConverter(javax.faces.convert.Converter converter) Set the value of the converter property.
void	setDisplayAs(java.lang.String displayAs) Set the value of the displayAsLink property.
void	setExpandedImage(java.lang.String expandedImage) Set the value of the expandedImage 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	setIndentResponses(boolean indentResponses) Set the value of the indentResponses property.
void	setOnclick(java.lang.String onclick) Set the value of the onclick property.
void	setOpenDocAsReadonly(boolean openDocAsReadonly) Set the value of the openDocAsReadonly property.
void	setPageUrl(java.lang.String pageUrl) Set the value of the pageUrl property.
void	setShowCheckbox(boolean showCheckbox) Set the value of the showCheckbox property.
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.
boolean	setThemeProperty(java.lang.String name, java.lang.Object value) Implemented by components which handle setting their own default styles
void	setValue(java.lang.Object value) Set the value of the value property.
void	setWidth(java.lang.String width) Deprecated. Use style or styleClass for width definitions Set the value of the width property.

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

changedParent, getFamily, getFooterClass, getHeaderClass, setFooterClass, setHeaderClass

Methods inherited from class javax.faces.component.UIColumn

getFooter, getHeader, setFooter, setHeader

Methods inherited from class javax.faces.component.UIComponentBase

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

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

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

DEFAULT_COLLAPSED_IMAGE

public static final java.lang.String DEFAULT_COLLAPSED_IMAGE

See Also:

Constant Field Values

DEFAULT_COLLAPSED_IMAGE_RTL

public static final java.lang.String DEFAULT_COLLAPSED_IMAGE_RTL

See Also:

Constant Field Values

DEFAULT_EXPANDED_IMAGE

public static final java.lang.String DEFAULT_EXPANDED_IMAGE

See Also:

Constant Field Values

VALUEBINDING_COLUMNS

public static final java.lang.String VALUEBINDING_COLUMNS

See Also:

Constant Field Values

VALUEBINDING_IS_SELECTED

public static final java.lang.String VALUEBINDING_IS_SELECTED

See Also:

Constant Field Values

INTERNAL_CHECKBOX_ID

public static final java.lang.String INTERNAL_CHECKBOX_ID

See Also:

Constant Field Values

INTERNAL_COLUMNTEXT_ID

public static final java.lang.String INTERNAL_COLUMNTEXT_ID

See Also:

Constant Field Values

INTERNAL_COLUMNLINK_ID

public static final java.lang.String INTERNAL_COLUMNLINK_ID

See Also:

Constant Field Values

INTERNAL_COLUMNICON_ID

public static final java.lang.String INTERNAL_COLUMNICON_ID

See Also:

Constant Field Values

VIEW_CHECKBOX_STYLE

public static final java.lang.String VIEW_CHECKBOX_STYLE

See Also:

Constant Field Values

LINK

public static final java.lang.String LINK

value used with displayAs to indicate column content should be displayed as a hyperlink

See Also:

Constant Field Values

TEXT

public static final java.lang.String TEXT

value used with displayAs to indicate column content should be displayed as a simple text

See Also:

Constant Field Values

HIDDEN

public static final java.lang.String HIDDEN

value used with displayAs to indicate column text should not be displayed

See Also:

Constant Field Values

Constructor Detail

UIViewColumn

public UIViewColumn()

Abstract View Column Component, used with the viewPanel component, This component adds additional functionality on top of the functionality provided by a standard UIColumn

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 UIColumnEx

Returns:

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

setThemeProperty

public boolean setThemeProperty(java.lang.String name,
                                java.lang.Object value)

Description copied from interface: FacesThemeHandler

Implemented by components which handle setting their own default styles

Specified by:

setThemeProperty in interface FacesThemeHandler

Parameters:

name - TODO

value - TODO

Returns:

TODO

isResponseDocument

public boolean isResponseDocument()

returns boolean indicating if the current document is a response document.

Returns:

getCollapsedImage

public java.lang.String getCollapsedImage()

Return the value of the collapsedImage property. Contents:

Image to be displayed when categorized column is collapsed

getColumnName

public java.lang.String getColumnName()

Return the value of the columnName property. Contents:

Point to a column in the view design element.

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 will 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.

getExpandedImage

public java.lang.String getExpandedImage()

Return the value of the expandedImage property. Contents:

Image to be displayed when categorized column is expanded.

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 that will appear to the left of each value - may be bound to a field (e.g. mail read/unread or doc importance level).

getConverter

public javax.faces.convert.Converter getConverter()

Return the value of the converter property. Contents:

Converter used to convert the value of a cell to a more readable value

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

Specifies CSS style(s) to be applied when this control is rendered.

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.

getValue

public java.lang.Object getValue()

Return the value of the value property. Contents:

The current value of this component.

getPageUrl

public java.lang.String getPageUrl()

Return the value of the pageUrl property. Contents:

Used to specify a custom URL for the columns link. If displayAs is set to "link", and a pageUrl is set, the specified url will be set on the link.

getWidth

public java.lang.String getWidth()

Deprecated. Use style or styleClass instead for width definitions

Formerly to define the width of a column

Return the value of the width property. Contents:

getDataModel

public javax.faces.model.DataModel getDataModel()

getViewRowData

public ViewRowData getViewRowData()

getOnclick

public java.lang.String getOnclick()

Return the value of the onclick property. Contents:

JavaScript code executed when a pointer button is clicked over this element.

getDocumentUrl

public java.lang.String getDocumentUrl()

Returns the URL need to open the document for the current row.

Returns:

getDisplayAs

public java.lang.String getDisplayAs()

Return the value of the displayAsLink property. Contents:

Property that indicates how the field is to be displayed (link, text and so on). Currently only two types are supported, link and text

isIndentResponses

public boolean isIndentResponses()

Return the value of the indentResponses property. Contents:

Indicates if responses are to be indented for this column. If this view is dealing with data that can support responses, (typically to documents), then these responses will appear below their owner document. Visually response documents are typically indented from the owning document and each level of response is indented more that the previous indent level. This flag will trigger this indenting to happen for this column. Typically this is only done on one column, most likely the first (non categorised) column.

isOpenDocAsReadonly

public boolean isOpenDocAsReadonly()

Return the value of the openDocAsReadonly property. Contents:

when the field link is clicked this boolean value indicates if the document to be opened should be in read only mode or editable.

isShowCheckbox

public boolean isShowCheckbox()

Return the value of the showCheckbox property. Contents:

Displays a check box beside each field

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 UIColumnEx

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIColumnEx

setConverter

public void setConverter(javax.faces.convert.Converter converter)

Set the value of the converter property.

setOnclick

public void setOnclick(java.lang.String onclick)

Set the value of the onclick property.

setCollapsedImage

public void setCollapsedImage(java.lang.String collapsedImage)

Set the value of the collapsedImage property.

setColumnName

public void setColumnName(java.lang.String columnName)

Set the value of the columnName property.

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.

setDisplayAs

public void setDisplayAs(java.lang.String displayAs)

Set the value of the displayAsLink property.

setExpandedImage

public void setExpandedImage(java.lang.String expandedImage)

Set the value of the expandedImage property.

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.

setIndentResponses

public void setIndentResponses(boolean indentResponses)

Set the value of the indentResponses property.

setOpenDocAsReadonly

public void setOpenDocAsReadonly(boolean openDocAsReadonly)

Set the value of the openDocAsReadonly property.

setShowCheckbox

public void setShowCheckbox(boolean showCheckbox)

Set the value of the showCheckbox property.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

setValue

public void setValue(java.lang.Object value)

Set the value of the value property.

setPageUrl

public void setPageUrl(java.lang.String pageUrl)

Set the value of the pageUrl property.

getAttrs

public java.util.List<Attr> getAttrs()

The extra attributes to be output on the base element at the root of this control or object tag. This should only be used when none of the properties in the All Properties pane correspond to the desired attribute. This may return null. The addAttr(Attr) method should be used to add an Attr.

Specified by:

getAttrs in interface FacesAttrsObject

addAttr

public void addAttr(Attr attr)

Add an Attr, to appear as an attribute in the HTML output of this control or object tag.

Specified by:

addAttr in interface FacesAttrsObject

Parameters:

action -

setAttrs

public void setAttrs(java.util.List<Attr> attrs)

This method is not used by the XPage generated .java file - instead the addAttr(Attr) method is used to add attributes to the list.

initBeforeContents

public void initBeforeContents(javax.faces.context.FacesContext context)
                        throws javax.faces.FacesException

Description copied from interface: FacesComponent

Perform component initialization before its children and facets are added.

Specified by:

initBeforeContents in interface FacesComponent

Throws:

javax.faces.FacesException

setWidth

public void setWidth(java.lang.String width)

Deprecated. Use style or styleClass for width definitions

Set the value of the width property.

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

Throws:

javax.faces.FacesException

initAfterContents

public void initAfterContents(javax.faces.context.FacesContext context)
                       throws javax.faces.FacesException

Description copied from interface: FacesComponent

Perform component initialization after it's children and facets are added.

Specified by:

initAfterContents in interface FacesComponent

Throws:

javax.faces.FacesException