穿梭框 Transfer

Constructor

Implements: Widget

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

可设置的属性

Name	Type	Default	Description
name	String		控件的名字，唯一标志
title	String		控件title
hidden	Boolean		隐藏
value	String		值
readonly	Boolean		只读
validates	Validators		校验器
hoverTip	String		悬停提示
selections	Array		待选值
url	String		远程加载待选值的URL JSON数据格式举例：示例如下
textField	String	text	待选值中显示值的field
valueField	String	value	待选中真实值的field
disabledField	String	disabled	待选中禁用的field
width	Number		每个框各自的宽度
height	Number		每个框各自的高度
leftTitle	String		左侧框标题
rightTitle	String		右侧框标题
showSearch	Boolean	false	显示搜索框

JSON数据格式举例

[
	{"text" : "男" , "value" : "1" },
	{"text" : "女" , "value" : "2" }
]

可读取的属性

Name	Type	Default	Description
name	String		控件的名字，唯一标志
title	String		控件title
hidden	Boolean		隐藏
value	String		值
readonly	Boolean		只读
validates	Validators		校验器
hoverTip	String		悬停提示
selections	Array		待选值
url	String		远程加载待选值的URL
textField	String	text	待选值中显示值的field
valueField	String	value	待选中真实值的field
disabledField	String	disabled	待选中禁用的field
width	Number		每个框各自的宽度
height	Number		每个框各自的高度
leftTitle	String		左侧框标题
rightTitle	String		右侧框标题
showSearch	Boolean	false	显示搜索框

方法

validate

Description： 执行校验

返回值： Boolean 校验是否成功

调用举例：

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

intoView

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

调用举例：

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

addValidator

Description： 增加校验器

调用参数

Name	Type	Description
validator	Object	校验器对象

返回值： 无

调用举例：

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

removeValidator

Description： 删除校验器

调用参数

Name	Type	Description
name	String	校验器名称

返回值： 无

调用举例：

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

showValidateMsg

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

调用参数

Name	Type	Description
msg	String	提示信息

返回值： 无

调用举例：

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

hideValidateMsg

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

调用举例：

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

select

Description： 把一个选项从左移动到右面

调用参数

Name	Type	Description
val	Any	左侧待选项的值

返回值： 无

调用举例：

var widget = vjsp.Parser.getWidgetByName('transfer');
widget.doMethod('select' , 'leftVal');

unselect

Description： 把一个选项从右移动到左面

调用参数

Name	Type	Description
val	Any	右侧已选项的值

返回值： 无

调用举例：

var widget = vjsp.Parser.getWidgetByName('transfer');
widget.doMethod('unselect' , 'rightVal');

disable

Description： 禁用一个选项

调用参数

Name	Type	Description
val	Any	选项的值

返回值： 无

调用举例：

var widget = vjsp.Parser.getWidgetByName('transfer');
widget.doMethod('disable' , 'val');

Enable

Description： 解除禁用一个选项

调用参数

Name	Type	Description
val	Any	选项的值

返回值： 无

调用举例：

var widget = vjsp.Parser.getWidgetByName('transfer');
widget.doMethod('enable' , 'val');

事件

change

Description： 值改变 绑定举例：

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

click

Description： 单击

回调函数参数

Name	Type	Description
e	Object	jQuery事件对象

绑定举例：

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

dblclick

Description： 双击

回调函数参数

Name	Type	Description
e	Object	jQuery事件对象

绑定举例：

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

contextmenu

Description： 弹出上下文菜单

回调函数参数

Name	Type	Description
e	Object	jQuery事件对象

绑定举例：

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

mousedown

Description： 鼠标按下

回调函数参数

Name	Type	Description
e	Object	jQuery事件对象

绑定举例：

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

mouseup

Description： 鼠标弹起

回调函数参数

Name	Type	Description
e	Object	jQuery事件对象

绑定举例：

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

mousemove

Description： 鼠标移动

回调函数参数

Name	Type	Description
e	Object	jQuery事件对象

绑定举例：

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

mouseover

Description： 鼠标移动控件上

回调函数参数

Name	Type	Description
e	Object	jQuery事件对象

绑定举例：

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

mouseout

Description： 鼠标离开

回调函数参数

Name	Type	Description
e	Object	jQuery事件对象

绑定举例：

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

mouseenter

Description： 鼠标移入

回调函数参数

Name	Type	Description
e	Object	jQuery事件对象

绑定举例：

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

mouseleave

Description： 鼠标移出

回调函数参数

Name	Type	Description
e	Object	jQuery事件对象

绑定举例：

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

hidden

Description： 隐藏事件（隐藏显示触发 回调参数为隐藏状态）

回调函数参数

Name	Type	Description
hiddenState	Boolean	隐藏状态true为隐藏、false为取消隐藏

绑定举例：

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

readonly

Description： 只读事件 （只读状态改变触发 回调参数为只读状态）

回调函数参数

Name	Type	Description
readonlyState	Boolean	只读状态 true为只读、false为取消只读

绑定举例：

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