Package com.webmethods.caf.faces.component.search

Class SearchResultTable

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

javax.faces.component.html.HtmlDataTable

com.webmethods.caf.faces.component.table.html.DataTable

com.webmethods.caf.faces.component.search.SearchResultTable

All Implemented Interfaces:

IDynamicComponent, IExtendedTable, ITableRowStateHolder, Serializable, EventListener, ClientBehaviorHolder, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, UniqueIdVendor, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class SearchResultTable
extends DataTable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.webmethods.caf.faces.component.table.html.DataTable

DataTable.ExportActionEvent, DataTable.ExportActionListener

Nested classes/interfaces inherited from interface com.webmethods.caf.faces.component.table.IExtendedTable

IExtendedTable.RowMovement

Field Summary

Fields

Modifier and Type	Field	Description
protected SearchTableHelper	searchHelper

Fields inherited from class com.webmethods.caf.faces.component.table.html.DataTable

content, lazyRowIndex, NO_LAZY_INDEX, rowsToCreate, rowsToDelete, rowsToMove, rowsToUpdate, saved, skipRowIndexLookup, sortIds, sortKeys, templateRowId, TYPE

Fields inherited from class javax.faces.component.html.HtmlDataTable

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIData

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor	Description
SearchResultTable()

Method Summary

Modifier and Type	Method	Description
String	getExportCharacterEncoding()
String	getExportExcludeComponentsCSV()
String	getExportFileName()
ITableContentProvider	getExportProvider()
boolean	getExportShowEncodingDialog()
ValueBinding	getQuerySupplied()	Deprecated. use getQuerySuppliedExpression() instead
ValueExpression	getQuerySuppliedExpression()
boolean	isDisplayOptions()
boolean	isDragAndDropColumns()
boolean	isExportButtonAvailable()
void	populateInitialComponents()	Perform the initial programmatic manipulation of the component tree.
protected void	prepareForEncode(FacesContext context)	Sub-classes may override to prepare their controls for encoding.
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setDisplayOptions(boolean displayOptions)
void	setDragAndDropColumns(boolean dragAndDropColumns)
void	setExportButtonAvailable(boolean exportButtonAvailable)
void	setExportCharacterEncoding(String exportCharacterEncoding)
void	setExportExcludeComponentsCSV(String excludeComponentsCSV)
void	setExportFileName(String exportFileName)
void	setExportProvider(ITableContentProvider provider)
void	setExportShowEncodingDialog(boolean showEncodingDialog)
void	setQuerySupplied(ValueBinding querySupplied)	Deprecated. use setQuerySuppliedExpression(ValueExpression) instead
void	setQuerySuppliedExpression(ValueExpression querySupplied)
void	setValueBinding(String name, ValueBinding binding)	Deprecated.
void	setValueExpression(String name, ValueExpression binding)

Methods inherited from class com.webmethods.caf.faces.component.table.html.DataTable

broadcast, clearContent, clearDescendantState, convertCreatedToOriginalRowIds, convertOriginalToCreatedRowIds, encodeBegin, filter, fromClientRowId, getCanTemplateRow, getClientId, getContentProvider, getContentProvider, getExportSettings, getFilter, getFirst, getRowCount, getRowData, getRowId, getRowIndex, getRows, getRowsToCreate, getRowsToDelete, getRowsToMove, getRowsToUpdate, getSortInfo, getTableRowState, isNestedWithinUIData, isRowAvailable, isTemplateRow, iterate, keepSaved, processColumnChild, processDecodes, processUpdates, processValidators, queueEvent, resetContent, resetRowCaches, restoreDescendantState, restoreDescendantState, saveDescendantState, saveDescendantState, setFilter, setFirst, setLazyRowIndex, setRowById, setRowIndex, setRows, setRowsToCreate, setRowsToDelete, setRowsToMove, setRowsToUpdate, setTableRowState, setTemplateRow, setTemplateRowId, setValue, sort, toClientRowId, updateRowsToCreate

Methods inherited from class javax.faces.component.html.HtmlDataTable

getBgcolor, getBodyrows, getBorder, getCaptionClass, getCaptionStyle, getCellpadding, getCellspacing, getColumnClasses, getDefaultEventName, getDir, getEventNames, getFooterClass, getFrame, getHeaderClass, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRole, getRowClass, getRowClasses, getRules, getStyle, getStyleClass, getSummary, getTitle, getWidth, setBgcolor, setBodyrows, setBorder, setCaptionClass, setCaptionStyle, setCellpadding, setCellspacing, setColumnClasses, setDir, setFooterClass, setFrame, setHeaderClass, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRole, setRowClass, setRowClasses, setRules, setStyle, setStyleClass, setSummary, setTitle, setWidth

Methods inherited from class javax.faces.component.UIData

createUniqueId, getDataModel, getFamily, getFooter, getHeader, getValue, getVar, invokeOnComponent, isRowStatePreserved, markInitialState, setDataModel, setFooter, setHeader, setRowStatePreserved, setVar, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

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

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

addClientBehavior, getClientBehaviors

Field Details

searchHelper

protected SearchTableHelper searchHelper

Constructor Details

SearchResultTable

public SearchResultTable()

Method Details

prepareForEncode

protected void prepareForEncode(FacesContext context)

Description copied from class: DataTable

Sub-classes may override to prepare their controls for encoding.

Overrides:

prepareForEncode in class DataTable

Parameters:

context - FacesContext for the current request

isExportButtonAvailable

public boolean isExportButtonAvailable()

Returns:

Returns the exportButtonAvailable.

setExportButtonAvailable

public void setExportButtonAvailable(boolean exportButtonAvailable)

Parameters:

exportButtonAvailable - The exportButtonAvailable to set.

getQuerySupplied

@Deprecated
public ValueBinding getQuerySupplied()

Deprecated.

use getQuerySuppliedExpression() instead

Returns:

Returns the querySupplied.

setQuerySupplied

@Deprecated
public void setQuerySupplied(ValueBinding querySupplied)

Deprecated.

use setQuerySuppliedExpression(ValueExpression) instead

Parameters:

querySupplied - The querySupplied to set.

getQuerySuppliedExpression

public ValueExpression getQuerySuppliedExpression()

Returns:

Returns the querySupplied.

setQuerySuppliedExpression

public void setQuerySuppliedExpression(ValueExpression querySupplied)

Parameters:

querySupplied - The querySupplied to set.

isDisplayOptions

public boolean isDisplayOptions()

setDisplayOptions

public void setDisplayOptions(boolean displayOptions)

isDragAndDropColumns

public boolean isDragAndDropColumns()

Returns:

True if using drag-to-resize/reorder-columns-behaviors.

setDragAndDropColumns

public void setDragAndDropColumns(boolean dragAndDropColumns)

Parameters:

dragAndDropColumns - True if using drag-to-resize/reorder-columns-behaviors.

restoreState

public void restoreState(FacesContext context,
 Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class DataTable

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIData

setValueExpression

public void setValueExpression(String name,
 ValueExpression binding)

Overrides:

setValueExpression in class DataTable

setValueBinding

@Deprecated
public void setValueBinding(String name,
 ValueBinding binding)

Deprecated.

Description copied from class: DataTable

Set the ValueBinding used to calculate the value for the specified attribute or property name, if any. In addition, if a ValueBinding is set for the value property, remove any synthesized DataModel for the data previously bound to this component.

Overrides:

setValueBinding in class DataTable

Parameters:

name - Name of the attribute or property for which to set a ValueBinding

binding - The ValueBinding to set, or null to remove any currently set ValueBinding

getExportShowEncodingDialog

public boolean getExportShowEncodingDialog()

setExportShowEncodingDialog

public void setExportShowEncodingDialog(boolean showEncodingDialog)

getExportFileName

public String getExportFileName()

setExportFileName

public void setExportFileName(String exportFileName)

getExportCharacterEncoding

public String getExportCharacterEncoding()

setExportCharacterEncoding

public void setExportCharacterEncoding(String exportCharacterEncoding)

getExportExcludeComponentsCSV

public String getExportExcludeComponentsCSV()

setExportExcludeComponentsCSV

public void setExportExcludeComponentsCSV(String excludeComponentsCSV)

getExportProvider

public ITableContentProvider getExportProvider()

setExportProvider

public void setExportProvider(ITableContentProvider provider)

populateInitialComponents

public void populateInitialComponents()

Description copied from interface: IDynamicComponent

Perform the initial programmatic manipulation of the component tree.

Specified by:

populateInitialComponents in interface IDynamicComponent

Overrides:

populateInitialComponents in class DataTable