kd.bos.filter

## 类 FilterContainer

- java.lang.Object
- - kd.bos.form.control.Control
  - - kd.bos.form.TipsSupport
    - - kd.bos.form.container.Container
      - - kd.bos.filter.FilterContainer

- 所有已实现的接口:
    java.lang.Cloneable, ISuportClick, ICloseCallBack, ITipsSupport, ITemplateControl

      public class FilterContainer
      extends Container
      implements ITemplateControl, ICloseCallBack

  过滤容器

- - ### 构造器概要

    构造器
    构造器和说明
    `FilterContainer()`

  - ### 方法概要

    所有方法 实例方法 具体方法 已过时的方法
    限定符和类型 | 方法和说明
    --- | ---
    `void` | `addAfterBindDataListener(AfterBindDataListener listener)` 添加绑定数据之后事件
    `void` | `addAfterSearchClickListener(AfterSearchClickListener listener)`
    `void` | `addBeforeBindDataListener(BeforeBindDataListener listener)` 添加绑定数据之前事件
    `void` | `addBeforeF7SelectListener(BeforeFilterF7SelectListener listener)`
    `void` | `addFilterContainerInitListener(FilterContainerInitListener listener)` 添加到过滤容器初始化监听列表
    `void` | `addSearchClickListener(SearchClickListener listener)` 添加到查找监听列表
    `void` | `addSearchClickListener(java.lang.String billListId)` 已过时。 添加到查找监听列表
    `void` | `addSetFilterListeners(java.util.function.Consumer<SetFilterEvent> setFilterListener)`
    `void` | `bindData(BindingContext bctx)` 绑定上下文，并赋值
    `void` | `clearFast()` 发指令给前端清空快速过滤
    `void` | `closedCallBack(ClosedCallBackEvent e)`
    `void` | `commonSearch(java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> fastFilter, java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> filter, java.lang.String entryEntity)` 常用过滤查询
    `java.util.Map<java.lang.String,java.lang.Object>` | `createClientConfig()` 创建客户端（前端）的配置信息
    `void` | `deleteScheme(java.lang.String schemeId)` 删除过滤方案
    `void` | `f7Click(java.lang.String fieldName, boolean isMulti, java.util.List<java.lang.String> selectedIds)` 常用过滤 F7点击处理
    `void` | `f7Click(java.lang.String entityId, java.lang.String fieldName, java.lang.String compareTypeId, int clientType, int rowIndex, java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> filter)` F7点击处理
    `void` | `fieldValueClick(java.lang.String entityId, java.lang.String fieldName, java.lang.String compareTypeId, int clientType, int rowIndex, java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> filter)` 弹出框-文本类型字段点击时事件
    `java.lang.String` | `getBillFormId()`
    `FilterContainerFilterValues` | `getCachedFilterValues()`
    `ControlContext` | `getContext()`
    `Tips` | `getCtlTips()`
    `java.lang.String` | `getEntityId()`
    `MainEntityType` | `getEntityType()` 获取实体类型
    `java.lang.String` | `getFilterModelClassName()` 获取列表过滤模型类
    `java.lang.String` | `getSchemeId()` 获取过滤方案ID
    `java.util.List<java.lang.String>` | `getSearchFields()`
    `java.util.Map<java.lang.String,java.util.List<java.lang.Object>>` | `getSearchValueMap()`
    `java.util.List<java.lang.Long>` | `getSelectedMainOrgIds()`
    `java.util.Map<java.lang.String,java.lang.Object>` | `getSelectedValues()` 获取常用过滤选中的基础资料和下拉列表值
    `java.util.List<java.util.function.Consumer<SetFilterEvent>>` | `getSetFilterListeners()`
    `kd.bos.dataentity.entity.LocaleString` | `getTitle()` 获取标题
    `int` | `getVisible()` 查看过滤容器的可见性
    `boolean` | `isMultiKeySearch()`
    `boolean` | `isQuickSearchAll()`
    `void` | `loadScheme(java.lang.String schemeId)` 加载过滤方案
    `void` | `refresh()`
    `void` | `saveScheme(java.util.Map<java.lang.String,java.lang.Object> filterSchemeMap)` 保存过滤方案
    `void` | `schemeSearch(java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> fastFilter, java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> filter, java.lang.String entryEntity)` 方案过滤查询
    `void` | `setBillFormId(java.lang.String billFormId)`
    `void` | `setCachedFilterValues(FilterContainerFilterValues cachedFilterValues)`
    `void` | `setColumns()` 重绘过滤字段信息
    `void` | `setColumns(boolean isInit)` 已过时。 重绘过滤字段信息 (已过时，请使用setColumns)
    `void` | `setContext(ControlContext context)`
    `void` | `setCtlTips(Tips ctlTips)`
    `void` | `setDefaultScheme(java.lang.String schemeId, boolean isDefault)` 设置默认过滤方案
    `void` | `setEntityId(java.lang.String entityId)`
    `void` | `setEntityType(MainEntityType entityType)`
    `void` | `setFilterModelClassName(java.lang.String filterModelClassName)` 设置列表过滤模型类
    `void` | `setMultiKeySearch(boolean isMultiKeySearch)`
    `void` | `setQuickSearchAll(boolean quickSearchAll)`
    `void` | `setSchemeId(java.lang.String schemeId)` 设置过滤方案ID
    `void` | `setSearchFields(java.util.List<java.lang.String> searchFields)`
    `void` | `setSearchValueMap(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> searchValueMap)`
    `void` | `setSelectedMainOrgIds(java.util.List<java.lang.Long> selectedMainOrgIds)`
    `void` | `setSetFilterListeners(java.util.List<java.util.function.Consumer<SetFilterEvent>> setFilterListeners)`
    `void` | `setTitle(kd.bos.dataentity.entity.LocaleString title)` 设置标题
    `void` | `setVisible(int visible)` 设置过滤容器的可见性

    - ### 从类继承的方法 kd.bos.form.container.Container

      `addClickListener, addControls, addItemClickListener, click, clone, deleteControls, getCollapseFields, getItems, getOperationKey, insertControls, setBackgroundImg, setCollapse, setCollapseFields, setCollapseFieldsVisible, setOperationKey`

    - ### 从类继承的方法 kd.bos.form.TipsSupport

      `addTips, addTipsListener, hideTips, showFormByTips`

    - ### 从类继承的方法 kd.bos.form.control.Control

      `getCustomeStyles, getKey, getModel, getView, postBack, release, setCustomeStyles, setDraggable, setDroppable, setKey, setModel, setView`

    - ### 从类继承的方法 java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### 构造器详细资料

    - #### FilterContainer

          public FilterContainer()

  - ### 方法详细资料

    - #### getCachedFilterValues

          public FilterContainerFilterValues getCachedFilterValues()

    - #### setCachedFilterValues

          public void setCachedFilterValues(FilterContainerFilterValues cachedFilterValues)

    - #### getSearchFields

          public java.util.List<java.lang.String> getSearchFields()

    - #### setSearchFields

          public void setSearchFields(java.util.List<java.lang.String> searchFields)

    - #### getSearchValueMap

          public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> getSearchValueMap()

    - #### setSearchValueMap

          public void setSearchValueMap(java.util.Map<java.lang.String,java.util.List<java.lang.Object>> searchValueMap)

    - #### addSetFilterListeners

          public void addSetFilterListeners(java.util.function.Consumer<SetFilterEvent> setFilterListener)

    - #### getSetFilterListeners

          public java.util.List<java.util.function.Consumer<SetFilterEvent>> getSetFilterListeners()

    - #### setSetFilterListeners

          public void setSetFilterListeners(java.util.List<java.util.function.Consumer<SetFilterEvent>> setFilterListeners)

    - #### getSelectedMainOrgIds

          public java.util.List<java.lang.Long> getSelectedMainOrgIds()

    - #### setSelectedMainOrgIds

          public void setSelectedMainOrgIds(java.util.List<java.lang.Long> selectedMainOrgIds)

    - #### getSelectedValues

          public java.util.Map<java.lang.String,java.lang.Object> getSelectedValues()

      获取常用过滤选中的基础资料和下拉列表值
      返回:
        常用过滤选中的基础资料和下拉列表值

    - #### setContext

          public void setContext(ControlContext context)

    - #### getContext

          public ControlContext getContext()

    - #### isQuickSearchAll

          public boolean isQuickSearchAll()

      返回:
        是否支持快速过滤全选

    - #### setQuickSearchAll

          public void setQuickSearchAll(boolean quickSearchAll)

    - #### isMultiKeySearch

          public boolean isMultiKeySearch()

      返回:
        是否多关键字搜索

    - #### setMultiKeySearch

          public void setMultiKeySearch(boolean isMultiKeySearch)

      参数:
        `isMultiKeySearch` - 是否多关键字搜索

    - #### getSchemeId

          public java.lang.String getSchemeId()

      获取过滤方案ID
      返回:
        过滤方案ID

    - #### setSchemeId

          @KSMethod
          public void setSchemeId(java.lang.String schemeId)

      设置过滤方案ID
      参数:
        `schemeId` - 过滤方案ID

    - #### getVisible

          public int getVisible()

      查看过滤容器的可见性
      返回:
        可见性

    - #### setVisible

          public void setVisible(int visible)

      设置过滤容器的可见性
      参数:
        `visible` - 可见性

    - #### getCtlTips

          public Tips getCtlTips()

    - #### setCtlTips

          public void setCtlTips(Tips ctlTips)

    - #### addBeforeBindDataListener

          public void addBeforeBindDataListener(BeforeBindDataListener listener)

      添加绑定数据之前事件
      参数:
        `listener` -

    - #### addAfterBindDataListener

          public void addAfterBindDataListener(AfterBindDataListener listener)

      添加绑定数据之后事件
      参数:
        `listener` -

    - #### addBeforeF7SelectListener

          public void addBeforeF7SelectListener(BeforeFilterF7SelectListener listener)

    - #### addSearchClickListener

          public void addSearchClickListener(SearchClickListener listener)

      添加到查找监听列表
      参数:
        `listener` - 监听器

    - #### addAfterSearchClickListener

          public void addAfterSearchClickListener(AfterSearchClickListener listener)

    - #### addFilterContainerInitListener

          public void addFilterContainerInitListener(FilterContainerInitListener listener)

      添加到过滤容器初始化监听列表
      参数:
        `listener` - 监听器

    - #### getTitle

          public kd.bos.dataentity.entity.LocaleString getTitle()

      获取标题
      返回:
        标题

    - #### setTitle

          public void setTitle(kd.bos.dataentity.entity.LocaleString title)

      设置标题
      参数:
        `title` - 标题

    - #### setBillFormId

          public void setBillFormId(java.lang.String billFormId)

      指定者:
        `setBillFormId` 在接口中 `ITemplateControl`

    - #### getBillFormId

          public java.lang.String getBillFormId()

      返回:

    - #### getFilterModelClassName

          public java.lang.String getFilterModelClassName()

      获取列表过滤模型类
      返回:
        类名

    - #### setFilterModelClassName

          public void setFilterModelClassName(java.lang.String filterModelClassName)

      设置列表过滤模型类
      参数:
        `filterModelClassName` - 类名

    - #### setEntityId

          public void setEntityId(java.lang.String entityId)

      指定者:
        `setEntityId` 在接口中 `ITemplateControl`
      参数:
        `entityId` - 实体标识

    - #### getEntityId

          public java.lang.String getEntityId()

      指定者:
        `getEntityId` 在接口中 `ITemplateControl`

    - #### getEntityType

          public MainEntityType getEntityType()

      获取实体类型
      返回:
        实体类型

    - #### setEntityType

          public void setEntityType(MainEntityType entityType)

    - #### createClientConfig

          public java.util.Map<java.lang.String,java.lang.Object> createClientConfig()

      从类复制的说明: `Control`
      创建客户端（前端）的配置信息
      覆盖:
        `createClientConfig` 在类中 `Container`
      返回:
        配置信息字典

    - #### addSearchClickListener

          @Deprecated
           @KSMethod
          public void addSearchClickListener(java.lang.String billListId)

      已过时。 添加到查找监听列表
      参数:
        `billListId` - 单据列表ID

    - #### bindData

          public void bindData(BindingContext bctx)

      从类复制的说明: `Control`
      绑定上下文，并赋值
      覆盖:
        `bindData` 在类中 `Container`

    - #### setColumns

          @Deprecated
           @KSMethod
          public void setColumns(boolean isInit)

      已过时。 重绘过滤字段信息 (已过时，请使用setColumns)
      参数:
        `isInit` - 是否是初始调用

    - #### setColumns

          @KSMethod
          public void setColumns()

      重绘过滤字段信息

    - #### refresh

          public void refresh()

      指定者:
        `refresh` 在接口中 `ITemplateControl`

    - #### commonSearch

          public void commonSearch(java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> fastFilter,
                                   java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> filter,
                                   java.lang.String entryEntity)

      常用过滤查询
      参数:
        `fastFilter` - 快速过滤条件
        `filter` - 过滤条件
        `entryEntity` - 单据实体

    - #### schemeSearch

          public void schemeSearch(java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> fastFilter,
                                   java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> filter,
                                   java.lang.String entryEntity)

      方案过滤查询
      参数:
        `fastFilter` -
        `filter` -
        `entryEntity` -

    - #### f7Click

          public void f7Click(java.lang.String fieldName,
                              boolean isMulti,
                              java.util.List<java.lang.String> selectedIds)

      常用过滤 F7点击处理

    - #### f7Click

          public void f7Click(java.lang.String entityId,
                              java.lang.String fieldName,
                              java.lang.String compareTypeId,
                              int clientType,
                              int rowIndex,
                              java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> filter)

      F7点击处理
      参数:
        `entityId` - 实体标识
        `fieldName` - 字段名
        `compareTypeId` - 比较类ID，如“=”的id
        `clientType` - 不清楚
        `rowIndex` - 行号
        `filter` - 已输入过滤条件

    - #### fieldValueClick

          public void fieldValueClick(java.lang.String entityId,
                                      java.lang.String fieldName,
                                      java.lang.String compareTypeId,
                                      int clientType,
                                      int rowIndex,
                                      java.util.List<java.util.Map<java.lang.String,java.util.List<java.lang.Object>>> filter)

      弹出框-文本类型字段点击时事件
      参数:
        `entityId` - 实体标识
        `fieldName` - 当前点击的文本框对应的字段名
        `compareTypeId` - 比较符Id
        `clientType` - 客户端类型
        `rowIndex` - 行号
        `filter` - 前端传递的参数

    - #### closedCallBack

          public void closedCallBack(ClosedCallBackEvent e)

      指定者:
        `closedCallBack` 在接口中 `ICloseCallBack`

    - #### clearFast

          public void clearFast()

      发指令给前端清空快速过滤

    - #### loadScheme

          public void loadScheme(java.lang.String schemeId)

      加载过滤方案
      参数:
        `schemeId` - 过滤方案ID

    - #### setDefaultScheme

          public void setDefaultScheme(java.lang.String schemeId,
                                       boolean isDefault)

      设置默认过滤方案
      参数:
        `schemeId` - 过滤方案ID
        `isDefault` - 是否为默认过滤方案

    - #### saveScheme

          public void saveScheme(java.util.Map<java.lang.String,java.lang.Object> filterSchemeMap)

      保存过滤方案
      参数:
        `filterSchemeMap` - 过滤方案配置字典Map

    - #### deleteScheme

          public void deleteScheme(java.lang.String schemeId)

      删除过滤方案
      参数:
        `schemeId` - 方案ID