Component

F. Component

new Component(options)

Description:
  • 控件的基类

Parameters:
Name Type Description
options Object

初始参数

Properties
Name Type Default Description
renderTo string ''

渲染到的DOM节点

cls string ''

CSS类

disabled boolean false

是否禁用

tooltip string ''

提示信息

tooltipType string 'qtip'

提示信息类型(可选项为:qtip, title)

tooltipTitle string ''

提示信息标题(仅在 tooltipType=qtip 时有效)

tooltipHideMode string 'auto'

提示信息隐藏模式(仅在tooltipType=qtip时有效)(可选项为:auto, user)

tooltipPosition string ''

提示信息的位置(仅在tooltipType=qtip时有效)(可选项为:'', top, topstart, topend, bottom, bottomstart, bottomend, left, leftstart, leftend, right, rightstart, rightend)

hidden boolean false

是否隐藏

hiddenMode string 'display'

隐藏模式(可选项为:display, visibility, offsets)

style string | Object

CSS样式

attrs Object

节点属性

attrSelector string ''

节点属性对应的节点(默认为this.el)

width number

宽度

height number

高度

anchor string ''

锚点值(当父容器的布局为anchor时有效)

columnWidth string ''

列宽度(介于0-1的小数,比如0.25)(当父容器的布局为column时有效)

x number

绝对定位的X坐标(当父容器的布局为absolute时有效)

y number

绝对定位的Y坐标(当父容器的布局为absolute时有效)

rowspan number

表格合并行数(当父容器的布局为table时有效)

colspan number

表格合并列数(当父容器的布局为table时有效)

flex number

子控件的尺寸(当父容器的布局为vbox或者hbox时有效)

block number

块大小,超小屏幕(当父容器的布局为block时有效)

blockSM number

块大小,小屏幕(当父容器的布局为block时有效)

blockMD number

块大小,中等屏幕(当父容器的布局为block时有效)

blockLG number

块大小,大屏幕(当父容器的布局为block时有效)

type string 'component'

控件类型

Extends

Members

el :jQuery

Description:
  • 控件对应的jQuery节点对象

控件对应的jQuery节点对象

Type:
  • jQuery

Methods

disable()

Description:
  • 禁用控件

doLayout(startFormTopmostComonentopt)

Description:
  • 执行布局操作

Parameters:
Name Type Attributes Default Description
startFormTopmostComonent boolean <optional>
false

从最顶层的控件开始布局

enable()

Description:
  • 启用控件

getAttr(key) → {string}

Description:
  • 获取节点属性

Parameters:
Name Type Description
key string

节点属性键

Returns:

节点属性值

Type
string

getHeight() → {number}

Description:
  • 获取控件高度

Returns:

高度

Type
number

getTooltip() → {string}

Description:
  • 获取提示信息

Returns:

提示信息

Type
string

getWidth() → {number}

Description:
  • 获取控件宽度

Returns:

宽度

Type
number

hide()

Description:
  • 隐藏控件

isDisabled() → {boolean}

Description:
  • 是否禁用

Returns:

是否禁用

Type
boolean

isType(value) → {boolean}

Description:
  • 检测当前实例是否指定的控件类型

Inherited From:
Example
grid1.isType('panel') // 返回true
grid1.isType('grid')  // 返回true
Parameters:
Name Type Description
value Object

控件类型

Returns:

如果当前实例是指定的控件类型,返回true;否则返回false

Type
boolean

isVisible() → {boolean}

Description:
  • 是否可见

Returns:

是否可见

Type
boolean

off(eventNames, fn)

Description:
  • 移除事件

Parameters:
Name Type Description
eventNames string

事件名称(可以空格分割多个事件名称)

fn F_Component_on

之前注册的事件处理函数

on(eventNames, fn)

Description:
  • 注册事件

Parameters:
Name Type Description
eventNames string

事件名称(可以空格分割多个事件名称)

fn F_Component_on

触发事件时执行的函数

remove()

Description:
  • 删除父控件中移除当前控件

removeAttr(key)

Description:
  • 删除节点属性

Parameters:
Name Type Description
key string

节点属性键

removeTooltip()

Description:
  • 删除提示信息

setAttr(key, value)

Description:
  • 设置节点属性

Parameters:
Name Type Description
key string

节点属性键

value string

节点属性值

setAttrs(attrs)

Description:
  • 设置节点属性

Parameters:
Name Type Description
attrs Object

节点属性对象

setDisabled(disabled)

Description:
  • 设置控件的禁用状态

Parameters:
Name Type Description
disabled boolean

是否禁用

setEnabled(enabled)

Description:
  • 设置控件的启用状态

Parameters:
Name Type Description
enabled boolean

是否启用

setHeight(height)

Description:
  • 设置控件高度

Parameters:
Name Type Description
height number

高度

setHidden(hidden)

Description:
  • 设置控件的隐藏状态

Parameters:
Name Type Description
hidden boolean

是否隐藏

setSize(width, height)

Description:
  • 设置控件尺寸

Parameters:
Name Type Description
width number

宽度

height number

高度

setTooltip(tooltip)

Description:
  • 设置提示信息

Parameters:
Name Type Description
tooltip string

提示信息

setVisible(visible)

Description:
  • 设置控件的显示状态

Parameters:
Name Type Description
visible boolean

是否可见

setWidth(width)

Description:
  • 设置控件宽度

Parameters:
Name Type Description
width number

宽度

show()

Description:
  • 显示控件

toggleEnabled()

Description:
  • 切换启用状态

toggleVisible()

Description:
  • 切换显示状态

trigger(eventName, args)

Description:
  • 触发事件

Parameters:
Name Type Description
eventName string

事件名称

args Object

事件参数

Events

beforehide

Description:
  • 隐藏控件之前触发(返回false则取消隐藏操作)

beforeshow

Description:
  • 显示控件之前触发(返回false则取消显示操作)

hide

Description:
  • 隐藏控件时触发

layout

Description:
  • 布局控件时触发

render

Description:
  • 渲染控件时触发

show

Description:
  • 显示控件时触发