kd.bos.form.control

## 类 AbstractGrid

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

- 所有已实现的接口:
    java.lang.Cloneable, ISuportClick, ITipsSupport
  直接已知子类:
    BillList, EntryGrid, ReportList

      @KSObject
      public abstract class AbstractGrid
      extends Container

  AbstractGrid : Container
  表格基类控件，单据体表格等，都从此派生； 能触发插件表格行点击事件；

- - ### 嵌套类概要

    嵌套类
    限定符和类型 | 类和说明
    --- | ---
    `static class` | `AbstractGrid.GridState` 表格的客户端状态

  - ### 字段概要

    字段
    限定符和类型 | 字段和说明
    --- | ---
    `static java.lang.String` | `VIRTUAL_GRID`

  - ### 构造器概要

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

  - ### 方法概要

    所有方法 实例方法 具体方法
    限定符和类型 | 方法和说明
    --- | ---
    `void` | `addCellClickListener(CellClickListener listener)`
    `void` | `addHeaderCellClickListener(HeaderCellClickListener listener)` 添加列点击事件监听器
    `void` | `addHyperClickListener(HyperLinkClickListener listener)` 添加单元格链接事件
    `void` | `addPagerClickListener(PagerClickListener listener)` 在表格上添加页面点击监听器
    `void` | `addRowClickListener(RowClickEventListener listener)` 添加航电机事件监听器
    `void` | `addSelectRowsListener(SelectRowsEventListener listener)` 在表格上添加记录选中监听器
    `void` | `clearEntryState()` 清除单据所有的状态信息 @Deprecated
    `void` | `clickCell(java.lang.String fieldKey, int row)` 点击单元格
    `void` | `clickHeaderCell(java.lang.String fieldKey)` 点击列（点击表头选中列）
    `void` | `doubleClickCell(java.lang.String fieldKey, int row)` 双击单元格
    `void` | `entryRowClick(java.lang.Integer row)` 点击行
    `void` | `entryRowDoubleClick(java.lang.Integer row)` 双击行
    `void` | `focusCell(int rowIndex, java.lang.String colKey)` 设置焦点所在的单元格
    `java.lang.String` | `getEntryKey()` 获取单据标识
    `AbstractGrid.GridState` | `getEntryState()` 获取表格的状态对象
    `int` | `getPageRow()` 获取设计时设置的每页行数（区分运行时用户设置的每页行数getPageRows）
    `void` | `hideOperateItems(java.lang.String key, int rowIndex, java.util.List<java.lang.String> operationKeys)`
    `void` | `hyperLinkClick(java.lang.String fieldName, int rowIndex)` 单元格链接事件方法
    `boolean` | `isEqualsRow(java.util.List<java.lang.Integer> newRows, java.util.List<java.lang.Integer> oldRows)` 比较数组是否相等
    `boolean` | `isSplitPage()` 获取设计时设置的是否分页选项值
    `void` | `itemClick(java.lang.String id, java.lang.String operationKey)` 工具栏点击事件
    `void` | `postBack(java.lang.Object value)` 输出数据
    `void` | `selectRows(int rowIndex)` 在表格中选择行
    `void` | `selectRows(int[] rowIndex, int focusRowIndex)` 因为业务的变态需求，要求选完行马上能取到状态数据，所以将数据返回来设下
    `void` | `selectRows(int rowIndex, boolean forceRefocus)`
    `void` | `selectRowsChanged(java.util.List<java.lang.Integer> newRows, java.util.List<java.lang.Integer> oldRows)` 选中记录
    `void` | `setCellBackcolor(java.lang.String fieldKey, java.lang.String color, int[] rowIndexes)` 设置单元格背景颜色
    `void` | `setCellStyle(java.util.List<CellStyle> cellStyles)` 设置单元格样式
    `void` | `setColumnProperty(java.lang.String fieldKey, java.lang.String propertyName, java.lang.Object value)`
    `void` | `setCustomProperties(java.lang.String key, int rowIndex, java.util.Map<java.lang.String,java.lang.Object> props)`
    `void` | `setMustInput(java.lang.String fieldKey, boolean value)`
    `void` | `setNextpageData(int rows)`
    `void` | `setPageRow(int pageRow)` 设置每页的行数
    `void` | `setPageRows(int rows)` 设置页面的行数
    `void` | `setRowBackcolor(java.lang.String color, int[] rowIndexes)` 设置行背景颜色
    `void` | `setSplitPage(boolean splitPage)`

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

      `addClickListener, addControls, addItemClickListener, bindData, click, clone, createClientConfig, 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, release, setCustomeStyles, setDraggable, setDroppable, setKey, setModel, setView`

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

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

- - ### 字段详细资料

    - #### VIRTUAL_GRID

          public static final java.lang.String VIRTUAL_GRID

      另请参阅:
        常量字段值

  - ### 构造器详细资料

    - #### AbstractGrid

          public AbstractGrid()

  - ### 方法详细资料

    - #### postBack

          public void postBack(java.lang.Object value)

      从类复制的说明: `Control`
      输出数据
      覆盖:
        `postBack` 在类中 `Control`

    - #### isEqualsRow

          public boolean isEqualsRow(java.util.List<java.lang.Integer> newRows,
                                     java.util.List<java.lang.Integer> oldRows)

      比较数组是否相等
      参数:
        `newRows` -
        `oldRows` -
      返回:

    - #### selectRowsChanged

          public void selectRowsChanged(java.util.List<java.lang.Integer> newRows,
                                        java.util.List<java.lang.Integer> oldRows)

      选中记录
      参数:
        `listener` -

    - #### isSplitPage

          @KSMethod
          public boolean isSplitPage()

      获取设计时设置的是否分页选项值
      返回:

    - #### setSplitPage

          public void setSplitPage(boolean splitPage)

    - #### getPageRow

          @KSMethod
          public int getPageRow()

      获取设计时设置的每页行数（区分运行时用户设置的每页行数getPageRows）
      返回:
        行数目

    - #### setPageRow

          public void setPageRow(int pageRow)

      设置每页的行数
      参数:
        `pageRow` - 行数目

    - #### addSelectRowsListener

          public void addSelectRowsListener(SelectRowsEventListener listener)

      在表格上添加记录选中监听器
      参数:
        `listener` -

    - #### addPagerClickListener

          public void addPagerClickListener(PagerClickListener listener)

      在表格上添加页面点击监听器
      参数:
        `listener` - 页面点击监听器

    - #### getEntryState

          @KSMethod
          public AbstractGrid.GridState getEntryState()

      获取表格的状态对象
      返回:
        表格的状态对象

    - #### clearEntryState

          @KSMethod
          public void clearEntryState()

      清除单据所有的状态信息 @Deprecated

    - #### getEntryKey

          @KSMethod
          public java.lang.String getEntryKey()

      获取单据标识
      返回:
        单据标识

    - #### addHyperClickListener

          @KSMethod
          public void addHyperClickListener(HyperLinkClickListener listener)

      添加单元格链接事件
      参数:
        `listener` - 单元格点击监听器

    - #### addCellClickListener

          @KSMethod
          public void addCellClickListener(CellClickListener listener)

    - #### addHeaderCellClickListener

          public void addHeaderCellClickListener(HeaderCellClickListener listener)

      添加列点击事件监听器
      参数:
        `listener` - 列点击事件监听器

    - #### addRowClickListener

          @KSMethod
          public void addRowClickListener(RowClickEventListener listener)

      添加航电机事件监听器
      参数:
        `listener` - 行点击事件监听器

    - #### clickHeaderCell

          public void clickHeaderCell(java.lang.String fieldKey)

      点击列（点击表头选中列）

    - #### itemClick

          public void itemClick(java.lang.String id,
                                java.lang.String operationKey)

      工具栏点击事件
      参数:
        `id` - 控件id
        `operationKey` - 操作标识

    - #### clickCell

          public void clickCell(java.lang.String fieldKey,
                                int row)

      点击单元格

    - #### doubleClickCell

          public void doubleClickCell(java.lang.String fieldKey,
                                      int row)

      双击单元格

    - #### entryRowDoubleClick

          public void entryRowDoubleClick(java.lang.Integer row)

      双击行

    - #### entryRowClick

          public void entryRowClick(java.lang.Integer row)

      点击行
      参数:
        `row` - 行号

    - #### selectRows

          @KSMethod
          public void selectRows(int[] rowIndex,
                                            int focusRowIndex)

      因为业务的变态需求，要求选完行马上能取到状态数据，所以将数据返回来设下
      参数:
        `rowIndex` - 行号
        `focusRowIndex` - 聚点行号

    - #### selectRows

          @KSMethod
          public void selectRows(int rowIndex)

      在表格中选择行
      参数:
        `rowIndex` - 行号

    - #### selectRows

          @KSMethod
          public void selectRows(int rowIndex,
                                            boolean forceRefocus)

    - #### focusCell

          public void focusCell(int rowIndex,
                                java.lang.String colKey)

      设置焦点所在的单元格
      参数:
        `rowIndex` - 行号
        `colKey` - 列号

    - #### setPageRows

          public void setPageRows(int rows)

      设置页面的行数
      参数:
        `rows` - 行数目

    - #### hyperLinkClick

          public void hyperLinkClick(java.lang.String fieldName,
                                     int rowIndex)

      单元格链接事件方法
      参数:
        `fieldName` - 字段名
        `rowIndex` - 行号

    - #### setCellBackcolor

          public void setCellBackcolor(java.lang.String fieldKey,
                                       java.lang.String color,
                                       int[] rowIndexes)

      设置单元格背景颜色
      参数:
        `fieldKey` - 单元格的key
        `color` -
        `rowIndexes` -

    - #### setCellStyle

          public void setCellStyle(java.util.List<CellStyle> cellStyles)

      设置单元格样式
      参数:
        `fieldKey` - 单元格的key
        `cellStyle` -
        `rowIndexes` -

    - #### setMustInput

          public void setMustInput(java.lang.String fieldKey,
                                   boolean value)

    - #### setColumnProperty

          public void setColumnProperty(java.lang.String fieldKey,
                                        java.lang.String propertyName,
                                        java.lang.Object value)

      参数:
        `fieldKey` - 列字段标识
        `propertyName` - 将要设置的属性名
        `value` - 将要设置的属性值
      另请参阅:
        `#setColumn`, `#initColumnFields`

    - #### setRowBackcolor

          public void setRowBackcolor(java.lang.String color,
                                      int[] rowIndexes)

      设置行背景颜色
      参数:
        `color` -
        `rowIndexes` -

    - #### setCustomProperties

          public void setCustomProperties(java.lang.String key,
                                          int rowIndex,
                                          java.util.Map<java.lang.String,java.lang.Object> props)

      参数:
        `key` - 将要设置字段属性的字段标识
        `rowIndex` - 行索引
        `props` - Map 字段K-V属（属性名-属性值）集合

    - #### hideOperateItems

          public void hideOperateItems(java.lang.String key,
                                       int rowIndex,
                                       java.util.List<java.lang.String> operationKeys)

    - #### setNextpageData

          public void setNextpageData(int rows)