Package 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 Details

  • Constructor Details

    • BaseSearchControlHelper

      public BaseSearchControlHelper(DataTable control)

  • Method Details

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

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