Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TableColumn

table组件列的基类

Hierarchy

Implements

  • ITableColumn
  • IColumnDrag

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • config: ITableColumn

    Returns TableColumn

Properties

$bodyTd

$bodyTd: JQuery<HTMLElement>

td内的元素

Private $dragClone

$dragClone: JQuery<HTMLElement>

拖拽时候的临时复制的对象

$fixHeaderth

$fixHeaderth: JQuery<HTMLTableHeaderCellElement>

固定列的表头 th 元素

$headerth

$headerth: JQuery<HTMLElement>

列的表头

Protected $sortSpan

$sortSpan: JQuery<HTMLElement>

Optional align

align: TableColumnAlginType

对齐 默认 left

Optional allowNull

allowNull: boolean

允许为空 true 允许 则反之

canMove

canMove: boolean

是否允许移动修改列的位置

canResize

canResize: boolean

是否允许修改宽度

Optional childs

childs: ITableColumn[]

Optional colspan

colspan: number

列合并跨度

dataType

dataType: FieldType

字段的数据类型

Protected doResizeingHandle

doResizeingHandle: DebouncedFunc<(e: MouseMoveEvent<any, any, any, any>) => void> = ...

dragCursor

dragCursor: string

editor

editor: string | ITableColumnEditor

编辑类型

Private editorInst

editorInst: TableColumnEditorBase

field

field: string

字段编号

fixed

fixed: TableColumnFixType

是否固定 注意：如果是固定在左，该列必须放在表头最前面；如果是固定在右，该列必须放在表头最后面。

font

font: string

字体

Optional format

format: string

格式化字符

griddown

griddown: boolean

是否显示下拉提示: 默认 true

hide

hide: boolean

是否隐藏 如果需设置值使用 setHide

length

length: number

长度

mergeColumn

mergeColumn: boolean

是否合并列 如果需设置值使用

Optional minWidth

minWidth: number

最小宽度 默认值40像素

onEditorCheckValueScript

onEditorCheckValueScript: string

编辑时的值校验脚本

onEditorValueChangedScript

onEditorValueChangedScript: string

编辑框发生值改变的脚本

onEditorValueChangingScript

onEditorValueChangingScript: string

编辑框发生值改变中的脚本

Optional parentId

parentId: string

Optional parents

parents: string

父列

prohibit

prohibit: TableColumnProhibitType[]

设计模式view编辑器内禁止的列行为 search 查询, sort 排序, total 合计

readonly

readonly: boolean

只读 ; 默认 true

Optional rowspan

rowspan: number

行合并跨度

Optional scale

scale: any

小数点位数

Optional searchType

searchType: TableColumnSearchTtype

查询类型

sort

sort: boolean

是否排序字段

sortDirection

sortDirection: TableColumnSortDirection

排序的方向

Optional style

style: string

样式

subCols

subCols: string

子列,都好隔开的列名字符串

templet

templet: string

自定义的模板javascript脚本 脚本内必须含有retrun 语句返回是html 字符串, 脚本预设的变量: row 是当前数据行的变量.可以通过row.get(filename)获取列的值

title

title: string

标题

Optional toolbar

toolbar: string

工具栏

totalFunc

totalFunc: DataSourceTotalType

后端的统计方式

totalRow

totalRow: TableColumnTotalType

是否开启合计行

totalRowScript

totalRowScript: any

自定义的合计脚本

type

type: TableColumnColType

Optional unique

unique: boolean

唯一

view

view: TableViewBase

view实例

width

width: string

宽度 如果需设置宽度使用 setWidth

Private Static dragColumn

dragColumn: TableColumn

源拖拽的列实例

Private Static isDraging

isDraging: boolean

拖拽中....

Private Static isStartDrag

isStartDrag: boolean

是否开始拖拽

Private Static resize

resize: { allowResize?: boolean; minWidth?: number; offset?: number[]; resizeStart?: boolean; rule?: any; ruleWidth?: number } = ...

改列宽需要的临时变量

Type declaration

  • Optional allowResize?: boolean

    允许拖拽

  • Optional minWidth?: number
  • Optional offset?: number[]
  • Optional resizeStart?: boolean
  • Optional rule?: any
  • Optional ruleWidth?: number

Methods

MoveArrayItem

  • 移动数组内的元素

    Parameters

    Returns void

addChildColumn

  • addChildColumn(column: ITableColumn): void

  • 添加子列 函数还修改了parentId,parents

    Parameters

    • column: ITableColumn

    Returns void

beginDrag

  • beginDrag(e: MouseDownEvent<any, any, any, any>): void

  • Parameters

    • e: MouseDownEvent<any, any, any, any>

    Returns void

beginEdit

  • beginEdit($cell: JQuery<HTMLElement>, value: any, row: Row): void

  • 开始编辑

    Parameters

    • $cell: JQuery<HTMLElement>
    • value: any
    • row: Row

    Returns void

checkEditorValue

  • checkEditorValue(row: Row, newValue: any): string

  • 校验值是否合法,在编辑时候需要检验值的合法性,比如: 是否数字....

    Parameters

    • row: Row
    • newValue: any

      需要校验的值

    Returns string

    null/''/undefine 允许通过, 非空则返回错误信息

clearSort

  • clearSort(): void

  • 清除排序

    Returns void

Private createFixElemContainer

  • createFixElemContainer(): void

  • Returns void

Protected doBeginResize

  • doBeginResize(e: MouseDownEvent<any, any, any, any>): void

  • 开始改列宽

    Parameters

    • e: MouseDownEvent<any, any, any, any>

    Returns void

doCanDrag

  • doCanDrag(e: any): void

  • Parameters

    • e: any

    Returns void

Protected doCanResize

  • doCanResize(e: MouseMoveEvent<any, any, any, any>): void

  • 是否允许拖拽改变列宽事件处理

    Parameters

    • e: MouseMoveEvent<any, any, any, any>

    Returns void

Protected doCheckEditorValue

  • doCheckEditorValue(row: Row, newValue: any): any

  • 列校验编辑的值

    Parameters

    • row: Row

      行对象

    • newValue: any

      需要校验的值

    Returns any

    null/''/undefine 允许通过, 非空则返回错误信息

Protected doEndResize

  • doEndResize(e: MouseUpEvent<any, any, any, any>): void

  • 结束改列宽

    Parameters

    • e: MouseUpEvent<any, any, any, any>

    Returns void

Protected doGetBodyCellHtml

  • doGetBodyCellHtml(row: Row, rowNo: number): string

  • 得到单元的内容的渲染html内容

    Parameters

    • row: Row

      行实例

    • rowNo: number

      行号

    Returns string

Protected doGetBodyHtml

  • doGetBodyHtml(row: Row, rowNo: number): string

  • 得到单元格html

    Parameters

    • row: Row

      行实例

    • rowNo: number

      行号

    Returns string

Protected doGetDisplayValue

  • doGetDisplayValue(row: Row): string

  • 获取对应行的显示内容

    Parameters

    • row: Row

      行实例

    Returns string

    返回显示的内容

Protected doGetErrClass

  • doGetErrClass(row: Row): void

  • 得到错误的单元格类字符串

    Parameters

    • row: Row

      行实例

    Returns void

Protected doGetHeaderCellHtml

  • doGetHeaderCellHtml(): string

  • 获取渲染的标题cell's html

    Returns string

Protected doGetHeaderHtml

  • doGetHeaderHtml(): string

  • 得到表头单元格html

    Returns string

Protected doInitBodyEvent

  • doInitBodyEvent(row: Row): void

  • 初始化列单元的事件

    Parameters

    • row: Row

      对应的行实例

    Returns void

Protected doInitHeaderEvent

  • doInitHeaderEvent(): void

  • 初始化列标题的事件

    Returns void

Protected doRenderBackground

  • doRenderBackground(): void

  • Returns void

Protected doRenderEditor

  • doRenderEditor(edElem: JQuery<HTMLElement>, value: any, row: Row): void

  • 渲染编辑框

    Parameters

    • edElem: JQuery<HTMLElement>
    • value: any
    • row: Row

    Returns void

Protected doRenderFixBody

  • doRenderFixBody(row: Row, rowNo: number, rowIndex: number): void

  • 渲染固定列数据部分

    Parameters

    • row: Row
    • rowNo: number
    • rowIndex: number

    Returns void

Protected doRenderFixHeader

  • doRenderFixHeader(): JQuery<HTMLTableHeaderCellElement>

  • 渲染数据列表头部分

    Returns JQuery<HTMLTableHeaderCellElement>

Protected doRenderSort

  • doRenderSort(): void

  • 渲染排序小图标

    Returns void

Protected doResizeing

  • doResizeing(e: MouseMoveEvent<any, any, any, any>): void

  • 鼠标移动改列宽中

    Parameters

    • e: MouseMoveEvent<any, any, any, any>

    Returns void

Protected doSetLazyLoad

  • doSetLazyLoad($bodyTd: JQuery<HTMLElement>): void

  • 懒加载图片的拦截处理

    Parameters

    • $bodyTd: JQuery<HTMLElement>

    Returns void

draging

  • draging(e: MouseMoveEvent<any, any, any, any>): void

  • Parameters

    • e: MouseMoveEvent<any, any, any, any>

    Returns void

endDrag

  • endDrag(e: MouseUpEvent<any, any, any, any>): void

  • Parameters

    • e: MouseUpEvent<any, any, any, any>

    Returns void

endEdit

  • endEdit(row: Row): void

  • 结束编辑

    Parameters

    • row: Row

    Returns void

getAttrEditors

  • getAttrEditors(): AttributeEditorBase[]

  • Returns AttributeEditorBase[]

Protected getCellAttrs

  • getCellAttrs(row: Row): string

  • 获取cell的各种设置属性

    Parameters

    • row: Row

    Returns string

Protected getCellClass

  • getCellClass(key: any): string

  • Parameters

    • key: any

    Returns string

getChildColumns

  • getChildColumns(): ITableColumn[]

  • 获取子列 注意返回的是只读,如果需要增加修改子列参考 addChildColumn removeChildColumn

    Returns ITableColumn[]

    返回子列数组

Protected getColClass

  • getColClass(row: Row): string

  • 获取列的类

    Parameters

    • row: Row

    Returns string

getColumnByXY

  • 通过x坐标判断是否在那个列上方

    Parameters

    • x: number

      横坐标

    • y: number

      纵坐标

    Returns TableColumn

getDValue

  • getDValue(row: Row): string

  • 获取对应行的显示内容.不包含editor.getTitle()

    Parameters

    • row: Row

      行实例

    Returns string

getDefalutWidth

  • getDefalutWidth(): string

  • 获取默认长度 不同的数据类型是不一样的长度

    Returns string

getDefaultAlgin

  • getDefaultAlgin(): TableColumnAlginType

  • 默认的对齐方式

    Returns TableColumnAlginType

getDragFlagHtml

  • getDragFlagHtml(): string

  • Returns string

getEditor

Private getHeaderMaxLev

  • getHeaderMaxLev(): number

  • 获取表头的最大lev

    Returns number

getHide

  • getHide(): boolean

  • 获取列的隐藏/显示

    Returns boolean

    返回是否隐藏/显示 true 隐藏,则反之

getLev

  • getLev(): number

  • 得到多表头的层数

    Returns number

    层数

getNameString

  • getNameString(): string

  • Returns string

getReadOnly

  • getReadOnly(): boolean

  • 获取列是否可以被修改 需要考虑父组件tabel,view 的readOnly

    Returns boolean

    true 只读,否则可编辑

getTempleteHtml

  • getTempleteHtml(row: any): any

  • 返回模板渲染后的html

    Parameters

    • row: any

    Returns any

    非空时返回html 否则返回undefine

getTotalRowText

  • getTotalRowText(): string

  • 获取列的统计值字符串

    Returns string

    返回统计的字符串

getView

  • 获取视图实例

    Returns TableViewBase

    返回视图实例

getWidth

  • getWidth(): string

  • 获取列的宽度

    Returns string

    返回列的宽度

Private iniOnColumnClickEvent

  • iniOnColumnClickEvent($th: JQuery<HTMLElement>): void

  • 列点击事件

    Parameters

    • $th: JQuery<HTMLElement>

    Returns void

Protected iniOnSortClickEvent

  • iniOnSortClickEvent($container: JQuery<HTMLElement>): void

  • 初始化排序的点击事件

    Parameters

    • $container: JQuery<HTMLElement>

      点击改变排序的容器

    Returns void

initDragEvent

  • initDragEvent(): void

  • 初始化拖拽类顺序的事件

    Returns void

initResizeEvent

  • initResizeEvent(): void

  • 初始化改变列宽度的事件

    Returns void

Private isLazyLoad

  • isLazyLoad(): boolean

  • 是否异步加载图片

    Returns boolean

moveTo

  • 移动到目标列前

    Parameters

    Returns void

onColumnResize

  • 注册改变大小事件

    Parameters

    Returns void

onEditorValueChanged

  • 注册编辑框发生值改变事件

    Parameters

    Returns void

onEditorValueChanging

  • 注册编辑框发生值改变中事件

    Parameters

    Returns void

onSort

  • 注册排序事件

    Parameters

    Returns void

Private raiseOnEditorCheckValueScript

  • raiseOnEditorCheckValueScript(column: TableColumn, row: Row, newValue: any): string

  • 触发编辑器修改的校验脚本

    Parameters

    • column: TableColumn

      列

    • row: Row

      行

    • newValue: any

      新值

    Returns string

    null/''/undefine 允许通过, 非空则返回错误信息

raiseOnEditorValueChanged

  • raiseOnEditorValueChanged(column: TableColumn, row: Row, value: any): void

  • 触发编辑器修改事件

    Parameters

    • column: TableColumn

      列

    • row: Row

      行

    • value: any

      修改的值

    Returns void

Private raiseOnEditorValueChangedScript

  • raiseOnEditorValueChangedScript(column: TableColumn, row: Row, value: any): void

  • Parameters

    Returns void

raiseOnEditorValueChanging

  • raiseOnEditorValueChanging(column: TableColumn, row: Row, newValue: any, oldValue: any): boolean

  • 触发编辑器修改中事件

    Parameters

    • column: TableColumn

      列

    • row: Row

      行

    • newValue: any

      新值

    • oldValue: any

      旧值

    Returns boolean

    true允许修改,false不允许修改

Private raiseOnEditorValueChangingScript

  • raiseOnEditorValueChangingScript(column: TableColumn, row: Row, newValue: any, oldValue: any): boolean

  • Parameters

    • column: TableColumn
    • row: Row
    • newValue: any
    • oldValue: any

    Returns boolean

Private raiseTotalRowScript

  • raiseTotalRowScript(field: string, val: number): any

  • 触发合计脚本

    Parameters

    • field: string
    • val: number

    Returns any

removeChildColumn

  • removeChildColumn(column: ITableColumn): void

  • 移除子列

    Parameters

    • column: ITableColumn

      需要删除的列

    Returns void

renderBody

  • renderBody(row: Row, rowNo: number, rowIndex: number, ingnoreLazyLoad?: boolean): void

  • 渲染数据部分

    Parameters

    • row: Row

      行数据

    • rowNo: number

      全局行号

    • rowIndex: number

      本页行号

    • ingnoreLazyLoad: boolean = false

      忽略懒加载

    Returns void

renderCell

  • renderCell($cell: JQuery<HTMLElement>, row: Row, rowNo?: number): void

  • 重新渲染单元格

    Parameters

    • $cell: JQuery<HTMLElement>
    • row: Row

      行实例

    • Optional rowNo: number

    Returns void

renderHeader

  • renderHeader(): void

  • 渲染列的头部

    Returns void

retSetFixHeaderHeight

  • retSetFixHeaderHeight(): void

  • 重新设置固定表头的高度,由于存现渲染的先后顺序 导致多表头的高度不一致

    Returns void

setColspan

  • setColspan(value: number): void

  • Parameters

    • value: number

    Returns void

setHide

  • setHide(value: boolean): void

  • 设置列隐藏/显示

    Parameters

    • value: boolean

    Returns void

Private setParentColSpan

  • setParentColSpan(hide: boolean): void

  • 同步表头父列的合并行列的相关值

    Parameters

    • hide: boolean

    Returns void

setRowspan

  • setRowspan(value: number): void

  • Parameters

    • value: number

    Returns void

setSortDirection

  • setSortDirection(value: TableColumnSortDirection): void

  • Parameters

    • value: TableColumnSortDirection

    Returns void

setView

  • 关联view

    Parameters

    Returns void

setWidth

  • setWidth(value: string | number): void

  • 设置列的宽度

    Parameters

    • value: string | number

    Returns void

Generated using TypeDoc