ht.widget.RulerFrame(component)

new RulerFrame(component)

创建刻度尺

Parameters:
Name Type Attributes Description
component any <optional>

视图，可以是 HT 组件(拓扑和树、表格等通用组件)及 HTML 元素(如 div )
Requires:
  • module:ht-rulerframe.js

Requires

  • module:ht-rulerframe.js

Methods

addComponentPropertyChangeListener(component, handler) → {void}

为 component 增加属性变化监听器

Parameters:
Name Type Description
component any

视图
handler function

监听函数
Returns:
void

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

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

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope object <optional>

监听器函数域
ahead boolean <optional>

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

addToDOM(parentNode) → {void}

将视图插入到 dom 中

Parameters:
Name Type Attributes Description
parentNode HTMLDivElement <optional>

父DOM
Returns:
void

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

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

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope object <optional>

监听器函数域
ahead boolean <optional>

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

dispose() → {void}

销毁此组件

Returns:
void

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

formatScaleText(number) → {void}

格式化缩放文本

Parameters:
Name Type Description
number number

文本
Returns:
void

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

派发属性变化事件

Parameters:
Name Type Attributes Description
property string

属性
oldValue any

旧值
newValue any

新值
equalFunc function <optional>

相等判断函数
params any <optional>

其它参数
Returns:
void
See:

getBottomRulerConfig() → {RulerConfig}

获取下面刻度尺培训

Returns:
RulerConfig

getClass() → {function}

获取类声明(构造函数)

Returns:
function -

类声明(构造函数)

getComponent() → {any}

获取表示刻度尺的组件

Returns:
any

getComponentHZoom(component) → {number}

获取视图垂直缩放值

Parameters:
Name Type Description
component any

视图
Returns:
number

getComponentViewRect(component) → {void}

获取视图矩形区域

Parameters:
Name Type Description
component any

视图
Returns:
void

getComponentVZoom(component) → {number}

获取视图水平缩放值

Parameters:
Name Type Description
component any

视图
Returns:
number

getDefaultRulerConfig() → {RulerConfig}

获取默认刻度尺的属性

Returns:
RulerConfig

getDisabledDiv() → {HTMLElement}

获取被禁用组件的 div

Returns:
HTMLElement -

被禁用组件的 div

getHeight() → {number}

获取布局高度

Returns:
number

getHTipText(pointOrEvent) → {number}

传入逻辑坐标点或者交互 event 事件参数，返回当前点下刻度垂直值

Parameters:
Name Type Description
pointOrEvent object | Event

逻辑坐标点或交互事件对象(如鼠标事件对象)
Returns:
number -

当前点下刻度垂直值

getLeftRulerConfig() → {RulerConfig}

获取左侧刻度尺的属性

Returns:
RulerConfig

getRightRulerConfig() → {RulerConfig}

获取右侧刻度尺的属性

Returns:
RulerConfig

getSuperClass() → {function}

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

Returns:
function -

父类声明(构造函数)

getTopRulerConfig() → {RulerConfig}

获取上方刻度尺的属性

Returns:
RulerConfig

getView() → {HTMLElement}

获取组件的根层div

Returns:
HTMLElement -

组件的根层div

getVTipText(pointOrEvent) → {number}

传入逻辑坐标点或者交互 event 事件参数，返回当前点下刻度水平值

Parameters:
Name Type Description
pointOrEvent object | Event

逻辑坐标点或交互事件对象(如鼠标事件对象)
Returns:
number -

当前点下刻度水平值

getWidth() → {number}

获取布局宽度

Returns:
number -

布局宽度

invalidate(delay) → {void}

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

Parameters:
Name Type Attributes Description
delay number <optional>

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

invalidateComponent(component) → {void}

使 component 无效

Parameters:
Name Type Description
component any

组件
Returns:
void

isDisabled() → {boolean}

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

Returns:
boolean

iv(delay) → {void}

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

Parameters:
Name Type Attributes Description
delay number <optional>

延迟刷新的间隔事件(单位: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() → {void}

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

Returns:
void

removeComponentPropertyChangeListener(component, handler) → {void}

为 component 移除属性变化监听器

Parameters:
Name Type Description
component any

视图
handler any

监听函数
Returns:
void

removePropertyChangeListener(listener, scope) → {void}

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

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope object <optional>

监听器函数域
Returns:
void

removeViewListener(listener, scope) → {void}

删除视图事件监听器

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope object <optional>

监听器函数域
Returns:
void

setBottomRulerConfig(config) → {void}

设置下方刻度尺的属性

Parameters:
Name Type Description
config RulerConfig

刻度尺配置
Returns:
void

setComponent(component) → {void}

设置刻度尺表示视图

Parameters:
Name Type Description
component any

视图组件
Returns:
void

setCursor(style) → {void}

设置 css 的鼠标样式，cursor

Parameters:
Name Type Description
style string
Returns:
void

setDefaultRulerConfig(config) → {void}

设置默认刻度尺的属性

Parameters:
Name Type Description
config RulerConfig

刻度尺配置
Returns:
void

setDisabled(value, iconUrl) → {void}

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

Parameters:
Name Type Attributes Description
value boolean

是否禁用组件
iconUrl string <optional>

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

setFocus() → {void}

设置视图聚焦

Returns:
void

setHeight(height) → {void}

设置布局高度

Parameters:
Name Type Description
height number

高度值
Returns:
void

setLeftRulerConfig(config) → {void}

设置左侧刻度尺的属性

Parameters:
Name Type Description
config RulerConfig

刻度尺配置
Returns:
void

setRightRulerConfig(config) → {void}

设置右侧刻度尺的属性

Parameters:
Name Type Description
config RulerConfig

刻度尺配置
Returns:
void

setTopRulerConfig(config) → {void}

设置上方刻度尺的属性

Parameters:
Name Type Description
config RulerConfig

刻度尺配置
Returns:
void

setWidth(width) → {void}

设置布局宽度

Parameters:
Name Type Description
width number
Returns:
void

ump(listener, scope) → {void}

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

Parameters:
Name Type Attributes Description
listener function

监听器函数
scope object <optional>

监听器函数域
Returns:
void
See:

validate() → {void}

立刻刷新拓扑

Returns:
void

validateComponent(component) → {void}

使 component 立即生效

Parameters:
Name Type Description
component any

视图组件
Returns:
void

validateImpl() → {void}

刷新

Returns:
void