$colacola.AbstractButtoncola.AbstractCheckboxcola.AbstractContainercola.AbstractDropdowncola.AbstractEditorcola.AbstractInputcola.AbstractItemGroupcola.AbstractListcola.AbstractMenuItemcola.AbstractSlotListcola.AjaxValidatorcola.AsyncValidatorcola.Avatarcola.Breadcrumbcola.Buttoncola.ButtonGroupcola.Calendarcola.CardBookcola.Carouselcola.CascadeBindcola.Checkboxcola.ControlMenuItemcola.Cornercola.CustomDropdowncola.CustomValidatorcola.DataTypecola.DatePickercola.DateTimePickercola.Dialogcola.Dividercola.Dropdowncola.DropdownMenuItemcola.Elementcola.EmailValidatorcola.Entitycola.EntityDataTypecola.EntityListcola.FieldSetcola.GroupBoxcola.HeaderMenuItemcola.IFramecola.Imagecola.Inputcola.ItemsViewcola.Labelcola.Layercola.LengthValidatorcola.Linkcola.ListViewcola.Menucola.MenuButtoncola.MenuItemcola.Modelcola.MultiSlotPickercola.NestedListcola.NestedListBindcola.NestedListNodecola.Nodecola.NumberValidatorcola.Panelcola.PointingLabelcola.Progresscola.Propertycola.Providercola.RadioButtoncola.RadioGroupcola.RangeSlotListcola.Ratingcola.RegExpValidatorcola.RenderableElementcola.RequiredValidatorcola.Revealcola.Ribboncola.Segmentcola.Selectcola.Sidebarcola.Slidercola.SlotListcola.SplitPanecola.Stackcola.Stepscola.Tabcola.TabButtoncola.Tablecola.TableColumncola.TableContentColumncola.TableDataColumncola.TableGroupColumncola.TableSelectColumncola.Tagcola.TimeLinecola.TitleBarcola.Togglecola.Treecola.TreeNodecola.TreeNodeBindcola.UrlValidatorcola.Validatorcola.Widgetcola.breadcrumb.Sectioncola.buttonGroup.Separatorcola.steps.Stepcola.tab.AbstractTabButtoncola.utilcola.util.KeyedArray

cola

cola的命名空间

cola的Javascript库时所使用的名称。

version
string
Cola的版本号
on绑定一个Cola的全局事件cola
Parameters:
  • eventNamestring

    利用事件名称,我们可以为某个事件监听器定义别名。例如 ready:temp 表示我们要为ready事件绑定事件,同时指定改事件监听器的别名为temp。

  • listenerfunction

    事件监听器方法

Returns:cola

cola.on("ready", function() { ... });

off根据事件名解绑一个Cola全局事件下的监听器cola
Parameters:
  • eventNamestring

    如果我们不在事件名中定义别名,那么此方法会解绑该事件下的所有监听器。 如果我们在事件名中定义了别名,那么此方法只会解绑与该别名匹配的监听器。

Returns:cola

cola.off("ready"); // 解绑ready事件下的所有监听器
cola.off("ready:temp"); // 解绑ready事件下别名为temp的监听器

off解绑一个Cola全局事件下的监听器cola
Parameters:
  • eventNamestring

    事件名,此处不支持使用事件别名

  • listenerfunction

    要解绑的监听器方法

Returns:cola
getListeners返回某Cola的全局事件下的所有事件监听器,如果没有绑定任何监听器则返回null。cola
Parameters:
  • eventNamestring

    事件名,此处不支持使用事件别名

Returns:function
ready为Cola绑定一个ready事件的监听器。cola
Parameters:
  • listenerfunction

    事件监听器方法

Returns:array[function]
此方法相当于cola.on("ready", ...)的快捷方式。请参考 cola.on(eventName,listener)
setting读取一个设置项cola
Parameters:
  • keystring

Returns:any
目前Cola支持的设置项有:
  • defaultChartset: 默认使用的字符集。默认值为utf-8。
  • setting改写一个Cola设置项cola
    Parameters:
    • keystring

      设置项的名称

    • valueany

      设置项的值

    Returns:cola
    setting写入一批Cola设置项cola
    Parameters:
    • configjson

      设置项的名称和值的JSON对象。

    Returns:cola
    setting(key)读取Cola设置项cola
    Parameters:
    • keystring

      设置项的名称

    Returns:any
    resource设置一批资源项cola
    Parameters:
    • bundlejson

      以JSON形式定义的一组资源项。

    Returns:cola
    此功能通常用于实现客户端的国际化功能。即根据名称来管理一组资源项。实际使用时,我们可以根据语种的的不同为前端装入不同的资源文件。
    
    resource(key)根据名称获得一个资源项cola
    Parameters:
    • keystring

      资源项的名称

    Returns:string
    resource根据名称获得一个资源项,同时利用传入的参数对资源进行格式化处理cola
    Parameters:
    • keystring

      资源项的名称

    • paramany

      参数

    Returns:cola
    资源项中可以带有{0}、{1}这样的占位符,在实际的使用过程中Cola利用此方法传入的param参数依次替换资源项中的占位符并返回。例如:
    
    cola.resource({ "greeting": "Hello {0}!" });  // 初始化一个资源项
    var greeting = cola.resource("greeting", "Nick"); // greeting变量的值将是"Hello Nick!"
    
    
    tag根据给定的标签返回所有拥有此标签的对象。cola
    Parameters:
    • tagstring

      要查找的标签

    Returns:cola.Element
    此方法返回的数组并不是一个单纯的数组,首先我们可以完全按照数组的方式来使用它。
    然后在即基础上这个数据拥有几个额外的方法,使得我们可以方便的对其中的所有对象执行统一的操作。这三个额外的方法包括:
    
    以上这些方法的使用方法可以完全参照cola.Element中同名方法的描述。
    
    xRender快速渲染。cola
    Parameters:
    • templatejson || [json] || string || colaWidget

      此参数支持很多种定义形式,具体参考:xRender

    • modelcola.Model

      渲染时使用的cola.Model的实例

    • contextjson

      传给内部使用的xCreate方法,用于保存那些定义了contextKey的DOM元素。

    Returns:void
    xCreate方法的目的是通过JSON来定义HTML,以方便开发者在Javascript中创建DOM。
    参考:xRender
    
    alertcola 消息框cola
    Parameters:
    • msgString

      消息内容

    • optionsObject

      可配置项

    Returns:void
    options可配置项如下
    
    • title: 标题
    • icon: 图标
    • ui: 样式风格
    • level: 提示等级(info,warning,error)
    • onHide: 隐藏时触发的回调
    confirmcola 确认框cola
    Parameters:
    • msgString

      消息内容

    • optionsObject

      可配置项

    Returns:void
    options可配置项如下
    
    • title: 标题
    • icon: 图标
    • level: 提示等级(info,warning,error)
    • onApprove: 被认可时触发的回调
    • onDeny: 被否决时触发的回调
    ready当Cola完成页面初始化之后触发的事件cola
    Parameters:
    • selfObject

      cola对象本身

    • argObject

    Returns:
    是否要继续后续事件的触发操作,不提供返回值时系统将按照返回值为true进行处理
    settingChange当Cola的某个设置项的值被改变时触发的事件cola
    Parameters:
    • selfObject

      cola对象本身

    • argObject

      • key:string

    Returns:
    是否要继续后续事件的触发操作,不提供返回值时系统将按照返回值为true进行处理
    excpetion当Cola抛出一个异常是触发的事件cola
    Parameters:
    • selfObject

      cola对象本身

    • argObject

      • exception:cola.Exception

    注意,此处所指的异常特指那些由Cola框架抛出的异常。不能认为通过此事件可以捕获所有的前端异常。
    
    Returns:
    是否要继续后续事件的触发操作,不提供返回值时系统将按照返回值为true进行处理
    beforeRouterSwitch当当前Router发生切换之前触发的事件cola
    Parameters:
    • selfObject

      cola对象本身

    • argObject

      • path:string

      • prev:json

      • next:json

    参考 Router(路由)
    
    Returns:
    是否要继续后续事件的触发操作,不提供返回值时系统将按照返回值为true进行处理
    routerSwitch当当前Router发生切换之后触发的事件cola
    Parameters:
    • selfObject

      cola对象本身

    • argObject

      • path:string

      • prev:json

      • next:json

    参考 Router(路由)
    
    Returns:
    是否要继续后续事件的触发操作,不提供返回值时系统将按照返回值为true进行处理