Extends:cola.Widget

size

string

mediumcola.Steps

尺寸

mini

tiny

small

medium

large

big

huge

massive

steps

Array(cola.steps.Step||Object)

cola.Steps

子步骤列表。具体设置如下所示：

new cola.Steps({
  steps:[
  {icon:"home",content:"设置属性",states:"completed"},
  {icon:"home",content:"项目属性",states:"active"},
  {icon:"home",content:"项目人员"},
  {icon:"home",content:"人员详细"},
  {icon:"home",content:"完成"}
  ]
})

currentIndex

number

cola.Steps

当前元素Index

autoComplete

boolean

truecola.Steps

是否自动完成属性。
true:当切换当前时当前元素之前的元素都被改写为complete状态。
false: 不发生变化

float

string

cola.Widget

left

right

浮动:通过属性将根据所设定的值在容器中浮动显示

display

boolean

truecola.Widget

是否显示

ui

string

truecola.Widget

用户可自定样式之后通过此属性激活自定义样式，或者启用框架提供的样式

popup

String

cola.Widget

弹出信息内容，当鼠悬停时显示此内容

dimmer

String

cola.Widget

调光器内容

width

number|string

cola.Widget

宽度(如果传入的值为number将计量单位为px)

height

number|string

cola.Widget

高度(如果传入的值为number将计量单位为px)

tag

string[]

cola.Element

对象拥有的标签

每一个Element的实例都可以拥有1到N的标签，每个标签是一个String类型的值。通过标签，我们可以快速的获取一批Element的实例，以便于对他们进行统一的操作。参考：cola.tag()

另外，在设置tag时如果只需要设置一个tag，我们可以直接使用简单的字符串，Cola-UI会自动将其转换成字符串的数组。例如： element.set("tag", "invisible");

userData

any

cola.Element

自定义数据。这里的自定义数据可以是任意数据类型，Cola-UI不会对其内容做任何处理。

addStep(config)添加Stepcola.Steps

Parameters:

configobject||cola.steps.Step
steps.addStep({ caption:"首页", icon:"home" }); steps.addStep(new cola.step.Step())

Returns:void

getStep()根据index获得指定的Stepcola.Steps

Returns:void

setCurrent(item)根据index或者Step设定当前项cola.Steps

Parameters:

itemnumber||cola.steps.Step
step本身或者序号

Returns:void

getCurrent()获得当前Stepcola.Steps

Returns:void

remobeStep(item)根据index或者Step删除指定Stepcola.Steps

Parameters:

itemnumber||cola.steps.Step
step本身或者序号

Returns:void

clear()清空所有Stepcola.Steps

Returns:void

next()流转到下一步cola.Steps

Returns:void

previous()流转到上一步cola.Steps

Returns:void

complete()完成整个流程cola.Steps

Returns:void

goTo(index)流转到指定步骤cola.Steps

Parameters:

indexnumber
目标Index

Returns:void

showDimmer(options)显示调光器cola.Widget

Parameters:

optionsobject

Returns:void


var widget=new cola.Widget();
widget.showDimmer({content:"中间内容"})
widget.showDimmer({
  tagName:"div",
  content:{
    tagName:"div",
    content:"中间内容"
  }
})

hideDimmer()关闭调光器cola.Widget

Returns:void

refresh()刷新控件cola.RenderableElement

Returns:void

appendTo(dom)追加到指定的dom中cola.RenderableElement

Parameters:

domHTMLElement | jQuery | zepto

Returns:void

getDom()cola.RenderableElement

Returns:void

get$Dom()获得此组件Dom的jQuery或zepto实例cola.RenderableElement

Returns:jQeury|zepto

remove()从dom树上移除此组件cola.RenderableElement

Returns:void

destroy()销毁此组件cola.RenderableElement

Returns:void

get(key)根据属性名或路径获取一个Attribute的值cola.Element

Parameters:

keystring
Attribute名或路径

Returns:any

注意设置或读取Attribute时，我们不但可以直接使用属性名也可以利用路径对属性值记性钻取式的读写。
请参考： Element

set(key,value)根据属性名或路径设置一个Attribute的值cola.Element

Parameters:

keystring
Attribute名或路径
valueany
要写入的值

Returns:cola.Element

注意设置或读取Attribute时，我们不但可以直接使用属性名也可以利用路径对属性值记性钻取式的读写。
请参考： Element

on(eventName,listener)绑定一个事件监听器cola.Element

Parameters:

eventNamestring
在定义此处的事件名时，我们可以通过":"分割的方式在事件名后面定义本事件监听器的别名。
listenerFunction
事件监听器

Returns:cola.Element

one(eventName,listener)绑定一个一次性事件监听器cola.Element

Parameters:

eventNamestring
事件名
listenerFunction
事件监听器

Returns:cola.Element

一次性事件监听器表示只要事件触发过一次，该事件监听器就会自动解除绑定。即这样的时间监听器只会触发一次。

off(eventName,listener)解绑一个事件监听器cola.Element

Parameters:

eventNamestring
事件名
listenerFunction
事件监听器

Returns:cola.Element

beforeChangecola.Steps

Parameters:

selfObject
事件的发起者,即组件本身
argObject
- undefined:cola.steps.Step
  原当前项
- undefined:cola.steps.Step
  目标当前项

切换当前项前时触发此事件

Returns: