Class ComboBoxFilterRowConfiguration

java.lang.Object
org.eclipse.nebula.widgets.nattable.config.AbstractRegistryConfiguration
org.eclipse.nebula.widgets.nattable.filterrow.combobox.ComboBoxFilterRowConfiguration
All Implemented Interfaces:
IConfiguration

public class ComboBoxFilterRowConfiguration extends AbstractRegistryConfiguration
Special filter row configuration that configures the FilterRowComboBoxCellEditor as editor for the filter row with its necessary configurations regarding matching mode, converter and painter.
  • Field Details

    • cellEditor

      protected ICellEditor cellEditor
      The ICellEditor that should be used for the filter cells. Usually it should be the FilterRowComboBoxCellEditor.
    • filterIconPainter

      protected ImagePainter filterIconPainter
      The ImagePainter that will be registered as the painter of the combobox cells in the filter row.
    • filterRowPainter

      protected FilterRowPainter filterRowPainter
      The FilterRowPainter used for painting cells in the filter row. Supports rendering of additional filter state based icons and is needed to support specific actions based on the filter states.
      Since:
      2.1
    • comboBoxDataProvider

      protected IComboBoxDataProvider comboBoxDataProvider
      The IComboBoxDataProvider that is used to fill the filter row comboboxes.
      Since:
      2.1
  • Constructor Details

    • ComboBoxFilterRowConfiguration

      public ComboBoxFilterRowConfiguration()
      The empty default constructor needed for specialising.

      Note: On using this constructor you need to ensure that the local member variables for cellEditor and filterIconPainter need to be set manually. Otherwise this configuration will not work correctly!

    • ComboBoxFilterRowConfiguration

      public ComboBoxFilterRowConfiguration(IComboBoxDataProvider comboBoxDataProvider)
      Create a ComboBoxFilterRowConfiguration that uses the default FilterRowComboBoxCellEditor showing the maximum number of 10 items at once and the ComboBoxFilterIconPainter with the default filter icon.
      Parameters:
      comboBoxDataProvider - The IComboBoxDataProvider that is used to fill the filter row comboboxes.
    • ComboBoxFilterRowConfiguration

      @Deprecated public ComboBoxFilterRowConfiguration(ICellEditor cellEditor, ImagePainter filterIconPainter)
      Create a ComboBoxFilterRowConfiguration with the given filter cell editor and filter icon painter.
      Parameters:
      cellEditor - The ICellEditor that should be used in the filter row.
      filterIconPainter - The ImagePainter that should be used to render a filter icon in the filter row.
      Since:
      2.0
    • ComboBoxFilterRowConfiguration

      public ComboBoxFilterRowConfiguration(ICellEditor cellEditor, ImagePainter filterIconPainter, IComboBoxDataProvider comboBoxDataProvider)
      Create a ComboBoxFilterRowConfiguration with the given filter cell editor and filter icon painter.
      Parameters:
      cellEditor - The ICellEditor that should be used in the filter row.
      filterIconPainter - The ImagePainter that should be used to render a filter icon in the filter row.
      comboBoxDataProvider - The IComboBoxDataProvider that is used to fill the filter row comboboxes.
      Since:
      2.1
  • Method Details