API
Component

Timer ($UI/system/components/justep/timer/timer)

使用范围：UI2

Contents

component Timer ($UI/system/components/justep/timer/timer) extends ViewComponent

<b>使用场景</b>：可实现定时任务效果； <b>使用方法</b>：设置计时器相关属性和触发事件后，可在组件事件（如按钮点击事件）中控制计时器的启动、停止、暂停； ## <b>文档链接</b>：#http://docs.newdao.net/zhuo-mian-biao-dan-zu-jian/ji-shi-qi.html#

Constructor Top

  Timer ()
  Timer ( options)

Properties Top

boolean enabled

启用timer，默认：true
integer interval

触发间隔，单位为毫秒，默认：1000
integer times

触发次数，0：无限，默认：0

Attributes Top

boolean enabled

启用timer，默认：true
integer interval

触发间隔，单位为毫秒，默认：1000
integer times

触发次数，0：无限，默认：0
string xid

组件标示

Methods Top

Object get (String name)
void pause ()
void set (json arg)
void start ()
void stop ()

Operations Top

void timerPause ()
void timerStart (integer times, integer interval)
void timerStop ()

Events Top

void onStop (ViewEvent event)
void onTimer (TimerEvent event)

Constructor details Top

public Timer ()

<b>使用场景</b>：可实现定时任务效果； <b>使用方法</b>：设置计时器相关属性和触发事件后，可在组件事件（如按钮点击事件）中控制计时器的启动、停止、暂停； ## <b>文档链接</b>：#http://docs.newdao.net/zhuo-mian-biao-dan-zu-jian/ji-shi-qi.html#

public Timer ( options)

构造函数

Inherited from ViewComponent

	
		参数options格式类似{parent:xx, config:{}}，parent是组件的父节点，允许为空或不指定，config是组件的参数选项

Parameters

options

参数选项

Properties Detail Top

public boolean enabled

启用timer，默认：true

public integer interval

触发间隔，单位为毫秒，默认：1000

public integer times

触发次数，0：无限，默认：0

Attributes Detail Top

public boolean enabled

启用timer，默认：true

public integer interval

触发间隔，单位为毫秒，默认：1000

public integer times

触发次数，0：无限，默认：0

public string xid

组件标示

Methods Detail Top

public Object get (String name)

获取属性值

Parameters

String name

属性名称，取值范围："enabled"、"interval"、"times"

Return Value

Object

public void pause ()

暂停，调用timer.start()后可继续

See Pause

Return Value

void

public void set (json arg)

设置属性值

Parameters

json arg

属性值对
结构如下：

{ "enabled" : {boolean} 启用timer "interval" : {integer} 触发间隔，单位为毫秒 "times" : {integer} 触发次数，0：无限 }

Return Value

void

public void start ()

开始，等同于timer.set('enabeld',true)

See Start

Return Value

void

public void stop ()

停止，等同于timer.set('enabeld',false)

See Stop

Return Value

void

Operations Detail Top

public void timerPause ()

计时器暂停

See TimerPause

Return Value

void

public void timerStart (integer times, integer interval)

启动计时器

See TimerStart

Parameters

integer times

触发次数：0或无限
integer interval

间隔时间：默认1000ms

Return Value

void

public void timerStop ()

计时器停止

See TimerStop

Return Value

void

Events Detail Top

public void onStop (ViewEvent event)

[回调型事件]timer停止事件

Parameters

ViewEvent event


结构如下：

{ "source" : 组件的js对象, "bindingContext" : 组件绑定的上下文，包含$model、$object等具体请参考bindingContext说明 }

Return Value

void

public void onTimer (TimerEvent event)

[回调型事件]timer触发事件

Parameters

TimerEvent event


结构如下：

{ "source" : 组件的js对象, "times" : 触发次数 "bindingContext" : 组件绑定的上下文，包含$model、$object等具体请参考bindingContext说明 }

Return Value

void