com.ibm.xsp.component.xp
Class XspViewPanel

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIData
              com.ibm.xsp.component.UIDataEx
                  com.ibm.xsp.component.UIViewPanel
                      com.ibm.xsp.component.xp.XspViewPanel

All Implemented Interfaces:

FacesAjaxComponent, FacesAttrsObject, FacesComponent, FacesDataIterator, FacesNestedDataTable, FacesRefreshableComponent, FacesRowAttrsComponent, FacesRowIndex, ThemeControl, javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class XspViewPanel
extends UIViewPanel

A control that displays sortable rows and columns of data extracted from XML based on a defined query

XPages Container Controls - View

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	RENDERER_TYPE

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

DEFAULT_VAR_NAME, FOOTER_PAGER, HEADER_PAGER, INTERNAL_DATA_TABLE, VIEW_TITLE

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

AJAX_GETROWS, DEFAULT_ROWS_PER_PAGE, TOGGLE_ACTION_CLIENT_ID

Fields inherited from class javax.faces.component.UIData

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

XspViewPanel()

Method Summary

java.lang.String	getCaption() Return the value of the caption property.
java.lang.String	getCaptionStyleClass() Return the value of the captionStyleClass property.
java.lang.String	getCellpadding() Return the value of the cellpadding property.
java.lang.String	getCellspacing() Return the value of the cellspacing property.
java.lang.String	getColumnClasses() Return the value of the columnClasses property.
java.lang.String	getDir() Return the value of the dir property.
java.lang.String	getLang() Return the value of the lang property.
java.lang.String	getReadMarksClass() Return the value of the readMarksClass property.
java.lang.String	getRefreshId() Return the value of the refreshId property.
java.lang.String	getRole() Return the value of the role property.
java.lang.String	getRowClasses() Return the value of the rowClasses property.
java.lang.String	getSummary() Return the value of the summary property.
java.lang.String	getTarget() Return the value of the target property.
java.lang.String	getTitle() Return the value of the title property.
java.lang.String	getUnreadMarksClass() Return the value of the unreadMarksClass property.
java.lang.String	getViewStyle() Return the value of the viewStyle property.
java.lang.String	getViewStyleClass() Return the value of the viewStyleClass property.
boolean	isPartialExecute() Return the value of the partialExecute property.
boolean	isPartialRefresh() Return the value of the partialRefresh property.
boolean	isShowColumnHeader() Return the value of the showColumnHeader property.
boolean	isShowUnreadMarks() Return the value of the showUnreadMarks property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
void	setCaption(java.lang.String caption) Set the value of the caption property.
void	setCaptionStyleClass(java.lang.String captionStyleClass) Set the value of the captionStyleClass property.
void	setCellpadding(java.lang.String cellpadding) Set the value of the cellpadding property.
void	setCellspacing(java.lang.String cellspacing) Set the value of the cellspacing property.
void	setColumnClasses(java.lang.String columnClasses) Set the value of the columnClasses property.
void	setDir(java.lang.String dir) Set the value of the dir property.
void	setLang(java.lang.String lang) Set the value of the lang property.
void	setPartialExecute(boolean partialExecute) Set the value of the partialExecute property.
void	setPartialRefresh(boolean partialRefresh) Set the value of the partialRefresh property.
void	setReadMarksClass(java.lang.String readMarksClass) Set the value of the readMarksClass property.
void	setRefreshId(java.lang.String refreshId) Set the value of the refreshId property.
void	setRole(java.lang.String role) Set the value of the role property.
void	setRowClasses(java.lang.String rowClasses) Set the value of the rowClasses property.
void	setShowColumnHeader(boolean showColumnHeader) Set the value of the showColumnHeader property.
void	setShowUnreadMarks(boolean showUnreadMarks) Set the value of the showUnreadMarks property.
void	setSummary(java.lang.String summary) Set the value of the summary property.
void	setTarget(java.lang.String target) Set the value of the target property.
void	setTitle(java.lang.String title) Set the value of the title property.
void	setUnreadMarksClass(java.lang.String unreadMarksClass) Set the value of the unreadMarksClass property.
void	setViewStyle(java.lang.String viewStyle) Set the value of the viewStyle property.
void	setViewStyleClass(java.lang.String viewStyleClass) Set the value of the viewStyleClass property.

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

addAttr, addRowAttr, buildContents, encodeBegin, getAttrs, getDataTableStyle, getDataTableStyleClass, getHeight, getOuterTableClientId, getPageName, getRowAttrs, getSelectedIds, getStyleKitFamily, getTabularDataModel, getTopPagerPosition, getViewHeight, getViewWidth, getWidth, initAfterContents, initBeforeContents, invokeOnComponent, setAttrs, setDataTableStyle, setDataTableStyleClass, setHeight, setPageName, setRowAttrs, setWidth

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

_xspCleanTransientData, broadcast, computeDataModelKey, createDataModel, encodeEnd, getAjaxUrl, getAjaxUrl, getData, getDataModel, getDataSource, getIndexVar, getLastCreatedDataModel, getNonChildClientId, getRowCount, getRowCount, getRows, getValue, getZeroRows, gotoFirstPage, gotoLastPage, gotoNextPage, gotoPage, gotoPreviousPage, gotoRow, handles, isNestedInDataIterator, processAjaxGetRows, processAjaxRequest, processDecodes, processUpdates, processValidators, publishControlData, queueEvent, resetDataModel, resolveValue, revokeControlData, setData, setDataModel, setIndexVar, setRowIndex, setRows, setValue, setValueBinding, setVar, visitTree

Methods inherited from class javax.faces.component.UIData

getClientId, getFamily, getFirst, getFooter, getHeader, getRowData, getRowIndex, getVar, isRowAvailable, setFirst, setFooter, setHeader

Methods inherited from class javax.faces.component.UIComponentBase

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

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

Methods inherited from interface com.ibm.xsp.component.FacesDataIterator

getFirst, getRowIndex, setFirst

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

XspViewPanel

public XspViewPanel()

Method Detail

getCaption

public java.lang.String getCaption()

Return the value of the caption property. Contents:

The caption which will be displayed above the table

getCaptionStyleClass

public java.lang.String getCaptionStyleClass()

Return the value of the captionStyleClass property. Contents:

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

getCellpadding

public java.lang.String getCellpadding()

Return the value of the cellpadding property. Contents:

Defines how much space should be left between the border of each cell and its contents

getCellspacing

public java.lang.String getCellspacing()

Return the value of the cellspacing property. Contents:

Defines how much space should left between the sides of a table and the edge rows and columns. Also specifies the amount of space to leave between cells.

getColumnClasses

public java.lang.String getColumnClasses()

Return the value of the columnClasses property. Contents:

%property.columnClasses.component.dataTable.descr%

getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).

getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.

getReadMarksClass

public java.lang.String getReadMarksClass()

Return the value of the readMarksClass property. Contents:

The name of a style class to use to format read view entries for display

getRefreshId

public java.lang.String getRefreshId()

Return the value of the refreshId property. Contents:

The id of the component to refresh via an Ajax request if partial refresh is enabled

Overrides:

getRefreshId in class UIDataEx

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.

getRowClasses

public java.lang.String getRowClasses()

Return the value of the rowClasses property. Contents:

A comma separated list of style classes that are iterated through for each row. So applying two style classes here will result in every second row referencing the second style class. Space separated style classes can be used too.

getSummary

public java.lang.String getSummary()

Return the value of the summary property. Contents:

Provides a description of the view.

getTarget

public java.lang.String getTarget()

Return the value of the target property. Contents:

Indicates the name of the frame to use if a view column link is selected.

getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.

getUnreadMarksClass

public java.lang.String getUnreadMarksClass()

Return the value of the unreadMarksClass property. Contents:

The name of a style class to use to format unread view entries for display

getViewStyle

public java.lang.String getViewStyle()

Return the value of the viewStyle property. Contents:

CSS style(s) to be applied to the overall view panel

getViewStyleClass

public java.lang.String getViewStyleClass()

Return the value of the viewStyleClass property. Contents:

Space-separated list of CSS style class(es) to be applied to the overall view panel

isPartialExecute

public boolean isPartialExecute()

Return the value of the partialExecute property. Contents:

Specifies to only execute this control, thus bypassing the lifecycle for other controls.

Overrides:

isPartialExecute in class UIDataEx

isPartialRefresh

public boolean isPartialRefresh()

Return the value of the partialRefresh property. Contents:

Only refreshes the control when a table action is triggered (collapse/expand...), using an Ajax request.

Overrides:

isPartialRefresh in class UIDataEx

isShowColumnHeader

public boolean isShowColumnHeader()

Return the value of the showColumnHeader property. Contents:

Boolean flag indicating if the column headers are to be shown or not

isShowUnreadMarks

public boolean isShowUnreadMarks()

Return the value of the showUnreadMarks property. Contents:

Boolean flag indicating if the unread entries should be specially marked for display in the view

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 UIViewPanel

saveState

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

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class UIViewPanel

setCaption

public void setCaption(java.lang.String caption)

Set the value of the caption property.

setCaptionStyleClass

public void setCaptionStyleClass(java.lang.String captionStyleClass)

Set the value of the captionStyleClass property.

setCellpadding

public void setCellpadding(java.lang.String cellpadding)

Set the value of the cellpadding property.

setCellspacing

public void setCellspacing(java.lang.String cellspacing)

Set the value of the cellspacing property.

setColumnClasses

public void setColumnClasses(java.lang.String columnClasses)

Set the value of the columnClasses property.

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

setPartialExecute

public void setPartialExecute(boolean partialExecute)

Set the value of the partialExecute property.

setPartialRefresh

public void setPartialRefresh(boolean partialRefresh)

Set the value of the partialRefresh property.

setReadMarksClass

public void setReadMarksClass(java.lang.String readMarksClass)

Set the value of the readMarksClass property.

setRefreshId

public void setRefreshId(java.lang.String refreshId)

Set the value of the refreshId property.

setRole

public void setRole(java.lang.String role)

Set the value of the role property.

setRowClasses

public void setRowClasses(java.lang.String rowClasses)

Set the value of the rowClasses property.

setShowColumnHeader

public void setShowColumnHeader(boolean showColumnHeader)

Set the value of the showColumnHeader property.

setShowUnreadMarks

public void setShowUnreadMarks(boolean showUnreadMarks)

Set the value of the showUnreadMarks property.

setSummary

public void setSummary(java.lang.String summary)

Set the value of the summary property.

setTarget

public void setTarget(java.lang.String target)

Set the value of the target property.

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.

setUnreadMarksClass

public void setUnreadMarksClass(java.lang.String unreadMarksClass)

Set the value of the unreadMarksClass property.

setViewStyle

public void setViewStyle(java.lang.String viewStyle)

Set the value of the viewStyle property.

setViewStyleClass

public void setViewStyleClass(java.lang.String viewStyleClass)

Set the value of the viewStyleClass property.