ht.widget.Palette(dataModel)

new Palette(dataModel)

创建组件面板或调色板，类似于Toolbar，允许用户快速访问按钮或命令，使用此插件之前，需要先引入 ht-cssanimation.js

Parameters:
Name Type Attributes Description
dataModel ht.DataModel <optional>

数据模型
Requires:
  • module:ht-cssanimation.js
  • module:ht-palette.js

Requires

  • module:ht-cssanimation.js
  • module:ht-palette.js

Methods

addPropertyChangeListener(listener, scope, ahead) → {void}

增加自身属性变化事件监听器

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope object <optional>

监听器函数域
ahead boolean <optional>

是否将当前监听器插入到监听器列表开头
Returns:
void
See:

addToDOM(parentNode) → {void}

将组件加入到指定的DOM元素底下，不指定则加入到 document.body 下

Parameters:
Name Type Attributes Description
parentNode HTMLElement <optional>

父DOM,默认为 document.body
Returns:
void

addViewListener(listener, scope, ahead) → {void}

监听视图事件，如布局、刷新等

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope object <optional>

监听器函数域
ahead boolean <optional>

是否将当前监听器插入到监听器列表开头
Returns:
void

dm() → {ht.DataModel}

获取数据模型，没有参数时相当于 getDataModel 的缩写

Returns:
ht.DataModel -

dataModel

See:

findDataByName(name) → {ht.Node}

通过名称查找节点

Parameters:
Name Type Description
name string

节点名称，如有相同名称的节点，返回第一个此名称节点
Returns:
ht.Node -

节点

firePropertyChange(property, oldValue, newValue, equalFunc, params) → {void}

派发属性变化事件，可使用fp的简写方式

Parameters:
Name Type Attributes Description
property string

属性
oldValue any

旧值
newValue any

新值
equalFunc function <optional>

相等判断函数
params any <optional>

其它参数
Returns:
void
See:

fireViewEvent(kind) → {void}

Parameters:
Name Type Description
kind string
Returns:
void

fp(property, oldValue, newValue, equalFunc, params) → {void}

派发属性变化事件，firePropertyChange 方法的简写

Parameters:
Name Type Attributes Description
property string

属性
oldValue any

旧值
newValue any

新值
equalFunc function <optional>

相等判断函数
params any <optional>

其它参数
Returns:
void
See:

getBodyColor(node) → {string}

获取节点染色信息

Parameters:
Name Type Description
node ht.Node

节点
Returns:
string -

染色

getClass() → {function}

获取类声明(构造函数)

Returns:
function -

类声明(构造函数)

getDataAt(pointOrEvent) → {ht.Node}

传入逻辑坐标点或者交互 event 事件参数，返回当前点下节点

Parameters:
Name Type Description
pointOrEvent object | Event

pointOrEvent 逻辑坐标点或交互事件对象(如鼠标事件对象)
Returns:
ht.Node -

节点

getDataModel() → {ht.DataModel}

获取绑定的数据模型

Returns:
ht.DataModel -

数据模型

getDisabledDiv() → {HTMLElement}

获取被禁用组件的div

Returns:
HTMLElement -

被禁用组件的div

getHeight() → {number}

获取布局高度

Returns:
number -

布局高度

getItemImageHeight() → {number}

获取选项图片高度

Returns:
number -

图片高度

getItemImagePadding() → {number}

获取选项图片内边距

Returns:
number -

图片内边距

getItemImageWidth() → {number}

获取选项图片宽度

Returns:
number -

图片宽度

getItemMargin() → {number}

获取选项外边距

Returns:
number -

外边距

getLayout() → {string}

获取布局方式，默认为 largeicons。

Returns:
string -

布局方式

getScrollBarColor() → {string}

获取滚动条颜色

Returns:
string -

颜色

getScrollBarSize() → {number}

获取滚动条宽度

Returns:
number -

滚动条宽度

getSelectableFunc() → {function}

获取选择过滤器函数

Returns:
function -

选择过滤器函数

getSelectionModel() → {ht.SelectionModel}

获取选择模型

Returns:
ht.SelectionModel

getSuperClass() → {function}

获取父类声明(构造函数)

Returns:
function -

父类声明(构造函数)

getTranslateY() → {number}

获取垂直平移值

Returns:
number -

垂直平移值

getView() → {HTMLDivElement}

获取组件的根层div

Returns:
HTMLDivElement

getViewRect() → {object}

获取视图矩形区域

Returns:
object -

矩形区域

getWidth() → {number}

获取布局宽度

Returns:
number -

布局宽度

handleDragAndDrop(e, state) → {void}

重写此方法可以禁用HTML5原生的 Drag 和 Drop 事件并启用模拟的拖拽事件

Parameters:
Name Type Description
e Event

鼠标事件
state string

状态
Returns:
void

invalidate(delay) → {void}

无效组件，并调用延时刷新

Parameters:
Name Type Attributes Description
delay number <optional>

延迟刷新的间隔事件(单位:ms)
Returns:
void
See:

isAutoHideScrollBar() → {boolean}

是否自动隐藏滚动条

Returns:
boolean

isDisabled() → {boolean}

组件是否处于不可用状态，处于此状态时不能进行任何操作并且会遮挡一层蒙板

Returns:
boolean

isSelectable(data) → {boolean}

判断data对象是否可被选中

Parameters:
Name Type Description
data ht.Data

数据元素
Returns:
boolean

isSelected(data) → {boolean}

判断data对象是否被选中

Parameters:
Name Type Description
data ht.Data

图元
Returns:
boolean

isSelectedById(id) → {boolean}

根据id判断data对象是否被选中

Parameters:
Name Type Description
id string | number

数据元素id
Returns:
boolean

isSelectionModelShared() → {boolean}

当前组件是否共享选中模型

Returns:
boolean

iv(delay) → {void}

无效组件，并调用延时刷新

Parameters:
Name Type Description
delay number

延迟刷新的间隔事件(单位:ms)
Returns:
void
See:

layout(x, y, width, height) → {void}

执行布局

Parameters:
Name Type Description
x number

视图左上角布局 x 点位置
y number

视图左上角布局 y 点位置
width number

视图宽度
height number

视图高度
Returns:
void

mp(listener, scope, ahead) → {void}

增加自身属性变化事件监听器的缩写

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope any <optional>

监听器函数域
ahead boolean <optional>

是否将当前监听器插入到监听器列表开头
Returns:
void
See:

onPropertyChanged(event) → {void}

属性变化回调函数，可重载做后续处理

Parameters:
Name Type Description
event object

属性变化事件
Returns:
void
Example
//event格式：
{
	property: 'name',//发生变化的属性
	oldValue: 'oldValue',//旧值
	newValue: 'newValue',''新值
	data: data//发生变化的data
}

onSelectionModelSharedChanged() → {void}

选择模型共享变化时回调，可重载做后续处理

Returns:
void

redraw() → {void}

重绘

Returns:
void

removePropertyChangeListener(listener, scope) → {void}

删除自身属性变化事件监听器

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope object <optional>

监听器函数域
Returns:
void

removeSelection() → {void}

删除所有选中的图元

Returns:
void

removeViewListener(listener, scope) → {void}

删除视图事件监听器

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope object <optional>

监听器函数域
Returns:
void

selectAll() → {void}

选中所有数据元素

Returns:
void

setAutoHideScrollBar(v) → {void}

设置是否自动隐藏滚动条，默认为true

Parameters:
Name Type Description
v boolean

是否自动隐藏滚动条
Returns:
void

setCursor(style) → {void}

设置 css 的鼠标样式，cursor

Parameters:
Name Type Description
style string

css 的鼠标样式
Returns:
void

setDataModel(dataModel) → {void}

设置绑定的数据模型

Parameters:
Name Type Description
dataModel ht.DataModel

数据模型
Returns:
void

setDisabled(value, iconUrl) → {void}

设置组件是否处于不可用状态，处于不可用状态时不能进行任何操作并且会遮挡一层蒙板

Parameters:
Name Type Attributes Description
value boolean

是否禁用组件
iconUrl string <optional>

蒙板上显示的icon的路径
Returns:
void

setFocus(value) → {void}

根据值给组件设置焦点

Parameters:
Name Type Attributes Description
value string <optional>
Returns:
void

setHeight(height) → {void}

设置布局高度

Parameters:
Name Type Description
height number

高度值
Returns:
void

setItemImageHeight(height) → {void}

设置选项图标高度

Parameters:
Name Type Description
height number

高度值
Returns:
void

setItemImagePadding(padding) → {void}

设置选项图片内边距

Parameters:
Name Type Description
padding number

内边距
Returns:
void

setItemImageWidth(width) → {void}

设置选项图标宽度

Parameters:
Name Type Description
width number

宽度值
Returns:
void

setItemMargin(margin) → {void}

设置选项外边距

Parameters:
Name Type Description
margin number

外边距
Returns:
void

setLayout(layout) → {void}

设置布局方式，可选配置：largeicons 大图标模式，这是默认值；smallicons 小图标模式；iconsonly 仅图标模式。

Parameters:
Name Type Description
layout string

布局
Returns:
void

setScrollBarColor(color) → {void}

设置滚动条颜色

Parameters:
Name Type Description
color string

颜色值
Returns:
void

setScrollBarSize(size) → {void}

设置滚动条宽度

Parameters:
Name Type Description
size number

宽度值
Returns:
void

setSelectableFunc(func) → {void}

设置选择过滤器函数

Parameters:
Name Type Description
func function

过滤器函数
Returns:
void

setSelectionModelShared(v) → {void}

设置组件是否共享选中模型

Parameters:
Name Type Description
v boolean
Returns:
void

setTranslateY(y) → {void}

设置拓扑垂直平移值

Parameters:
Name Type Description
y number

垂直平移值
Returns:
void

setWidth(width) → {void}

设置布局宽度

Parameters:
Name Type Description
width number

宽度值
Returns:
void

sm() → {ht.SelectionModel}

获取选中模型

Returns:
ht.SelectionModel
See:

ty(value) → {number}

获取或设置垂直平移值，没有参数时相当于getTranslateY，有参数时相当于setTranslateY

Parameters:
Name Type Attributes Description
value number <optional>
Returns:
number -

垂直平移值

See:
  • -

ump(listener, scope) → {void}

删除自身属性变化事件监听器，removePropertyChangeListener的缩写

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope object <optional>

监听器函数域
Returns:
void
See:

validate() → {void}

立刻刷新拓扑

Returns:
void

validateImpl() → {void}

刷新

Returns:
void