颜色选择器 ColorPicker

Constructor

Implements: Widget

Tutorials: 控件对象使用快速入门

可设置的属性

NameTypeDefaultDescription
nameString控件的名字,唯一标志
titleString控件title
hiddenBoolean隐藏
valueString
readonlyBoolean只读
validatesValidators校验器
hoverTipString悬停提示
formatStringhex颜色格式(hex|rgb)
alphaBooleanfalse是否开启透明色(rbg模式下)
predefineBooleanfalse是否开启预置颜色
colorsString|Array预置颜色集合(逗号分隔字符串或者颜色数组) ,
predefine=true时生效

可读取的属性

NameTypeDefaultDescription
nameString控件的名字,唯一标志
titleString控件title
hiddenBoolean隐藏
valueString
readonlyBoolean只读
validatesValidators校验器
hoverTipString悬停提示
formatStringhex颜色格式(hex|rgb)
alphaBooleanfalse是否开启透明色(rbg模式下)
predefineBooleanfalse是否开启预置颜色
colorsString|Array预置颜色集合(逗号分隔字符串或者颜色数组) ,
predefine=true时生效

方法

validate

Description: 执行校验

NameTypeDescription
调用参数
返回值Boolean校验是否成功

调用举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
var result = widget.doMethod('validate');

intoView

Description: 把控件移动到页面可视范围

调用举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.doMethod('intoView');

addValidator

Description: 增加校验器

调用参数

NameTypeDescription
validatorObject校验器对象

返回值: 无

调用举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
//通过api增加必填校验器
widget.doMethod('addValidator' , vjsp.Validators.get(
    'required',
    [],
    widgetLang.validate.required
));

removeValidator

Description: 删除校验器

调用参数

NameTypeDescription
nameString校验器名称

返回值: 无

调用举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
//删除必填校验
widget.doMethod('removeValidator' , 'required');

showValidateMsg

Description: 显示校验信息,多用于自定义校验器的开发

调用参数

NameTypeDescription
msgString提示信息

返回值: 无

调用举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
//提示不能为空
widget.doMethod('showValidateMsg' , '控件不能为空');

hideValidateMsg

Description: 隐藏校验信息,多用于自定义校验器的开发

调用举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.doMethod('hideValidateMsg');

Description: 显示下拉面板

调用举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.doMethod('dropDown');

事件

change

Description: 值改变 绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('change' , function(){
    //控制台输出新值
    console.info('new value' , this.get('value'));
});

Preselect

Description: 在面板上预选颜色 没点确定

回调函数参数

NameTypeDescription
colorString颜色

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('preselect' , function(color){
    //在一个id为presetDiv的div上显示预选颜色
    $('#presetDiv').css('backgroundColor' , color);
});

click

Description: 单击

回调函数参数

NameTypeDescription
eObjectjQuery事件对象

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('click' , function(e){
    vjsp.alert('click event');
});

dblclick

Description: 双击

回调函数参数

NameTypeDescription
eObjectjQuery事件对象

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('dblclick' , function(e){
    vjsp.alert('dblclick event');
});

contextmenu

Description: 弹出上下文菜单

回调函数参数

NameTypeDescription
eObjectjQuery事件对象

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('contextmenu' , function(e){
    vjsp.alert('contextmenu event');
});

mousedown

Description: 鼠标按下

回调函数参数

NameTypeDescription
eObjectjQuery事件对象

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('mousedown' , function(e){
    vjsp.alert('mousedown event');
});

mouseup

Description: 鼠标弹起

回调函数参数

NameTypeDescription
eObjectjQuery事件对象

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('mouseup' , function(e){
    vjsp.alert('mouseup event');
});

mousemove

Description: 鼠标移动

回调函数参数

NameTypeDescription
eObjectjQuery事件对象

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('mousemove' , function(e){
    vjsp.alert('mousemove event');
});

mouseover

Description: 鼠标移动控件上

回调函数参数

NameTypeDescription
eObjectjQuery事件对象

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('mouseover' , function(e){
    vjsp.alert('mouseover event');
});

mouseout

Description: 鼠标离开

回调函数参数

NameTypeDescription
eObjectjQuery事件对象

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('mouseout' , function(e){
    vjsp.alert('mouseout event');
});

mouseenter

Description: 鼠标移入

回调函数参数

NameTypeDescription
eObjectjQuery事件对象

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('mouseenter' , function(e){
    vjsp.alert('mouseenter event');
});

mouseleave

Description: 鼠标移出

回调函数参数

NameTypeDescription
eObjectjQuery事件对象

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('mouseleave' , function(e){
    vjsp.alert('mouseleave event');
});

hidden

Description: 隐藏事件(隐藏显示触发 回调参数为隐藏状态)

回调函数参数

NameTypeDescription
hiddenStateBoolean隐藏状态true为隐藏、false为取消隐藏

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('hidden' , function(hiddenState){
    if(hiddenState){
        vjsp.alert('控件被隐藏');
    }else{
        vjsp.alert('控件取消隐藏');
    }
});

readonly

Description: 只读事件 (只读状态改变触发 回调参数为只读状态)

回调函数参数

NameTypeDescription
readonlyStateBoolean只读状态 true为只读、false为取消只读

绑定举例:

var widget = vjsp.Parser.getWidgetByName('colorPicker');
widget.on('readonly' , function(readonlyState){
    if(readonlyState){
        vjsp.alert('控件只读');
    }else{
        vjsp.alert('控件取消只读');
    }
});