GridColumn

GridColumn

列定义基类

函数调用流程图示
Column Refresh

Members

(static, readonly) canEdit :boolean

Description:

  • 标记该类型是否可编辑

Source:

标记该类型是否可编辑

Type:
  • boolean

(static, readonly) editing :boolean

Description:

  • 该属性返回 true 后，在任意事件中修改行包装对象的 __editing 值，则会在行列元素变动时及时触发 onChanged 方法，避免例如文本框和日期框还未触发事件就被移除元素而导致的问题

Source:
See:

该属性返回 true 后，在任意事件中修改行包装对象的 __editing 值，则会在行列元素变动时及时触发 onChanged 方法，避免例如文本框和日期框还未触发事件就被移除元素而导致的问题

Type:
  • boolean

(static, readonly) headerEditing :boolean

Description:

  • 标记该类型是否支持列头批量操作

Source:

标记该类型是否支持列头批量操作

Type:
  • boolean

Methods

(abstract, static) create(col, index, grid) → {HTMLElement}

Description:

  • 创建显示单元格时调用的方法

Source:
Parameters:
Name Type Description
col GridColumnDefinition

列定义对象
index number

行元素索引（需要配合 startIndex 相加得到真实数据索引）
grid Grid

Grid 实例
Returns:

返回创建的单元格元素

Type
HTMLElement

(abstract, static) createCaption(col) → {HTMLElement}

Description:

  • 创建列头时调用的方法

Source:
Parameters:
Name Type Description
col GridColumnDefinition

列定义对象
Returns:

返回创建的列头元素

Type
HTMLElement

(abstract, static) createEdit(trigger, col, containeropt, wrapperopt) → {HTMLElement}

Description:

  • 创建编辑单元格时调用的方法

    元素修改后设置行包装对象的 __editing 后，支持在离开编辑状态时及时触发 leaveEdit 方法
    更多例子参考代码中 GridDropdownColumn 的实现。

Source:
Parameters:
Name Type Attributes Description
trigger function

编辑事件回调函数

Properties
Name Type Description
e any

该参数会传递给 getValue 方法
col GridColumnDefinition

列定义对象
container HTMLElement <optional>

父容器元素
wrapper GridItemWrapper <optional>

行包装对象，其 values 属性为行数据对象
Returns:

返回创建的编辑状态的单元格元素

Type
HTMLElement

(abstract, static) getElement(element) → {HTMLElement}

Description:

  • 获取用于判断文本大小的元素

Source:
Parameters:
Name Type Description
element HTMLElement

单元格主内容元素
Returns:

返回文本元素

Type
HTMLElement

(abstract, static) getValue(e, col) → {string|boolean|number}

Description:

  • 获取编辑状态单元格值时调用的方法

Source:
Parameters:
Name Type Description
e any

由 createEdit 方法中 trigger 函数传递来的对象
col GridColumnDefinition

列定义对象
Returns:

返回单元格的值

Type
string | boolean | number

(abstract, static) leaveEdit(element, container)

Description:

  • 单元格离开编辑元素时调用的方法，需要由行包装对象的 __editing 来确定是否触发。

Source:
Parameters:
Name Type Description
element HTMLElement

单元格元素
container HTMLElement

父容器元素

(abstract, static) setClass(element, name)

Description:

  • 设置单元格类名时调用的方法

Source:
Parameters:
Name Type Description
element HTMLElement

单元格元素
name string

要设置的类名

(abstract, static) setEditing(element, editing)

Description:

  • 单元格编辑状态发生改变时调用的方法

Source:
Parameters:
Name Type Description
element HTMLElement

单元格元素
editing boolean

是否处于编辑状态

(abstract, static) setEnabled(element, enabled, editing)

Description:

  • 设置单元格可用性时调用的方法

Source:
Parameters:
Name Type Description
element HTMLElement

单元格元素
enabled boolean

启用值，为 false 时代表禁用
editing boolean

是否处于编辑状态

(abstract, static) setStyle(element, style)

Description:

  • 设置单元格样式时调用的方法

Source:
Parameters:
Name Type Description
element HTMLElement

单元格元素
style object

样式对象

(abstract, static) setValue(element, val, wrapper, col, grid)

Description:

  • 设置单元格值时调用的方法

Source:
Parameters:
Name Type Description
element HTMLElement

单元格元素
val string | boolean | number

待设置的单元格值
wrapper GridItemWrapper

行包装对象
col GridColumnDefinition

列定义对象
grid Grid

Grid 对象