com.webmethods.caf.faces.component.search

Class BaseSearchControlHelper

java.lang.Object

com.webmethods.caf.faces.component.search.BaseSearchControlHelper

Direct Known Subclasses:

SearchTableHelper, SearchTreeHelper

public abstract class BaseSearchControlHelper
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Serializable,Object>	_deferredPropertiesMap
protected static String	CONTROL_ID_IF_HAS_SEARCH_QUERY
protected static String	CONTROL_ID_OPTIONS_APPLY_BUTTON
protected static String	CONTROL_ID_OPTIONS_BUTTON
protected static String	CONTROL_ID_OPTIONS_DIALOG
protected static String	CONTROL_ID_OPTIONS_FORM
protected static String	CONTROL_ID_REORDER_COLUMNS
protected static String	CONTROL_ID_RESIZE_COLUMNS
protected static String	CONTROL_ID_SHOW_EXPORT_DIALOG_BUTTON
static String	FACET_EMPTY
static String	FACET_FOOTER
static String	FACET_HEADER
protected Boolean	fDisplayOptions
protected Boolean	fDragAndDropColumns
protected Boolean	fExportButtonAvailable

Constructor Summary

Constructors

Constructor and Description
BaseSearchControlHelper(DataTable control)

Method Summary

Modifier and Type	Method and Description
void	applyDeferredProperties() Apply any changes in the deferred properties map to the underlying controls.
protected Map<Serializable,Object>	getDeferredPropertiesMap()
abstract String	getEmptyTemplate()
String	getExportCharacterEncoding()
String	getExportExcludeComponentsCSV()
String	getExportFileName()
ITableContentProvider	getExportProvider()
UIComponent	getExportSettings()
boolean	getExportShowEncodingDialog()
ExportTableButton	getExportTableButton()
abstract String	getFooterTemplate()
abstract String	getHeaderTemplate()
ValueBinding	getQuerySupplied() Deprecated. use getQuerySuppliedExpression() instead
ValueExpression	getQuerySuppliedExpression()
boolean	isDisplayOptions()
boolean	isDragAndDropColumns()
boolean	isExportButtonAvailable()
void	loadEmptyFacet() Loads the controls for the 'empty' facet
void	loadFooterFacet() Loads the controls for the 'footer' facet
protected UIComponent	loadFromView(String viewId, String namingContainerId) Creates a new naming container, and loads specified view into the container.
void	loadHeaderFacet() Loads the controls for the 'header' facet
void	prepareForEncode(FacesContext context)
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 #setQuerySupplied(ValueExpression) instead
void	setQuerySuppliedExpression(ValueExpression querySupplied)
void	setValueBinding(String name, ValueBinding binding) Deprecated. use setValueExpression(String, ValueExpression) instead
void	setValueExpression(String name, ValueExpression binding)

Methods inherited from class java.lang.Object

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

Field Detail

FACET_HEADER

public static final String FACET_HEADER

See Also:

Constant Field Values

FACET_FOOTER

public static final String FACET_FOOTER

See Also:

Constant Field Values

FACET_EMPTY

public static final String FACET_EMPTY

See Also:

Constant Field Values

CONTROL_ID_SHOW_EXPORT_DIALOG_BUTTON

protected static final String CONTROL_ID_SHOW_EXPORT_DIALOG_BUTTON

See Also:

Constant Field Values

CONTROL_ID_IF_HAS_SEARCH_QUERY

protected static final String CONTROL_ID_IF_HAS_SEARCH_QUERY

See Also:

Constant Field Values

CONTROL_ID_RESIZE_COLUMNS

protected static final String CONTROL_ID_RESIZE_COLUMNS

See Also:

Constant Field Values

CONTROL_ID_REORDER_COLUMNS

protected static final String CONTROL_ID_REORDER_COLUMNS

See Also:

Constant Field Values

CONTROL_ID_OPTIONS_FORM

protected static final String CONTROL_ID_OPTIONS_FORM

See Also:

Constant Field Values

CONTROL_ID_OPTIONS_BUTTON

protected static final String CONTROL_ID_OPTIONS_BUTTON

See Also:

Constant Field Values

CONTROL_ID_OPTIONS_DIALOG

protected static final String CONTROL_ID_OPTIONS_DIALOG

See Also:

Constant Field Values

CONTROL_ID_OPTIONS_APPLY_BUTTON

protected static final String CONTROL_ID_OPTIONS_APPLY_BUTTON

See Also:

Constant Field Values

fExportButtonAvailable

protected Boolean fExportButtonAvailable

fDragAndDropColumns

protected Boolean fDragAndDropColumns

fDisplayOptions

protected Boolean fDisplayOptions

_deferredPropertiesMap

protected transient Map<Serializable,Object> _deferredPropertiesMap

Constructor Detail

BaseSearchControlHelper

public BaseSearchControlHelper(DataTable control)

Method Detail

getDeferredPropertiesMap

protected Map<Serializable,Object> getDeferredPropertiesMap()

getHeaderTemplate

public abstract String getHeaderTemplate()

getFooterTemplate

public abstract String getFooterTemplate()

getEmptyTemplate

public abstract String getEmptyTemplate()

setValueBinding

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

Deprecated. use setValueExpression(String, ValueExpression) instead

setValueExpression

public void setValueExpression(String name,
                               ValueExpression binding)

Since:

9.6

getExportTableButton

public ExportTableButton getExportTableButton()

loadHeaderFacet

public void loadHeaderFacet()

Loads the controls for the 'header' facet

loadFooterFacet

public void loadFooterFacet()

Loads the controls for the 'footer' facet

loadEmptyFacet

public void loadEmptyFacet()

Loads the controls for the 'empty' facet

prepareForEncode

public void prepareForEncode(FacesContext context)

isExportButtonAvailable

public boolean isExportButtonAvailable()

Returns:

Returns the exportButtonAvailable.

setExportButtonAvailable

public void setExportButtonAvailable(boolean exportButtonAvailable)

Parameters:

exportButtonAvailable - The exportButtonAvailable to set.

getQuerySuppliedExpression

public ValueExpression getQuerySuppliedExpression()

Returns:

Returns the querySupplied.

Since:

9.6

getQuerySupplied

@Deprecated
public ValueBinding getQuerySupplied()

Deprecated. use getQuerySuppliedExpression() instead

Returns:

Returns the querySupplied.

setQuerySupplied

@Deprecated
public void setQuerySupplied(ValueBinding querySupplied)

Deprecated. use #setQuerySupplied(ValueExpression) instead

Parameters:

querySupplied - The querySupplied to set.

setQuerySuppliedExpression

public void setQuerySuppliedExpression(ValueExpression querySupplied)

Parameters:

querySupplied - The querySupplied to set.

Since:

9.6

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.

getExportSettings

public UIComponent getExportSettings()

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)

restoreState

public void restoreState(FacesContext context,
                         Object state)

saveState

public Object saveState(FacesContext context)

loadFromView

protected UIComponent loadFromView(String viewId,
                                   String namingContainerId)

Creates a new naming container, and loads specified view into the container. Does not add container to this component.

applyDeferredProperties

public void applyDeferredProperties()

Apply any changes in the deferred properties map to the underlying controls.