url 窗口打开内容的目标位置
- 类型:
string
- 默认值:
无默认值,该参数为必填参数
- 使用方式:
http://xxx.com/load
部分参数也可以在url中直接添加,页面上可使用EL表达式之类的方式进行获取
例如:
http://xxx.com/load?aa=1&bb=2
title 标题栏显示的标题文本
- 类型:
string | boolean
- 默认值:
'对话框'
- 使用方式:
根据使用需要对标题内容进行设置,若需要关闭标题栏,则传递
false
值即可
width 窗口宽度
- 类型:
number
- 默认值:
700
- 使用方式:
设置窗口宽度,若不传递该参数,则默认使用700的宽度
height 窗口高度
- 类型:
number
- 默认值:
400
- 使用方式:
设置窗口高度,若不传递该参数,则默认使用400的高度
callback 窗口关闭后的回调函数
- 类型:
function
- 默认值:
无
- 使用方式:
参数:data - 窗口关闭时回传的数据
callback:function(data){ if(data && data.results && data.results.length > 0 ){ alert('已完成弹出窗口操作!\\n接收到弹出窗口传回的 userName 参数,值为:\\n' + data.results[0].userName + ''); }else{ alert('弹出窗口未回传参数',$.noop,'error'); } }
params 传递参数
- 类型:
object
- 默认值:
无
- 使用方式:
父窗口打开窗口时需要传递给窗口的参数集
格式:
{'name':'aa','sex':1}
例如:
params : {'name':'aa','sex':1}
backdrop 背景遮罩
- 类型:
boolean | string
- 默认值:
'static'
- 使用方式:
窗口默认类型为模态窗口,打开后,不允许操作窗外以外的内容
设置
'static'
为背景遮罩打开,并不允许点击关闭设置
false
为关闭遮罩,此时仅显示窗口本身设置
true
为打开遮罩,但点击遮罩将自动关闭窗口
dialogCloseButton 窗口标题栏的关闭按钮是否启用
- 类型:
boolean
- 默认值:
true
- 使用方式:
设置窗口右上角的关闭窗口按钮是否显示,默认为启用状态
dialogMaxButton 窗口标题栏的最大化按钮是否启用
- 类型:
boolean
- 默认值:
true
- 使用方式:
设置窗口右上角的最大化窗口按钮是否启用,默认为启用状态
language 插件使用的语言,默认为中文
- 类型:
string
- 默认值:
'cn'
- 使用方式:
目前已预设的语言有:'cn'中文(默认),'en'英文,'jp'日文
dom 需要在窗口里显示的HTML DOM内容
- 类型:
object
- 默认值:
无
- 使用方式:
将页面上预定义好的HTML内容,以模态窗口的形式展现
若参数中同时定义了dom和url则以dom内容为优先展示
例如:
dom : $('#content').html()
animation 窗口打开时的动画效果
- 类型:
boolean
- 默认值:
true
- 使用方式:
窗口打开时会有弹跳的动画效果
scroll 窗口内部是否显示滚动条
- 类型:
boolean
- 默认值:
true
- 使用方式:
根据需要设置窗口内容区域的滚动条,默认显示滚动条
drag 是否允许窗口可拖拽
- 类型:
boolean
- 默认值:
true
- 使用方式:
提示 使用拖拽功能需要导入jquery-ui脚本库
根据需要设置窗口是否可被拖拽,默认允许拖拽
fullWidth 是否展示全宽度窗口
- 类型:
boolean
- 默认值:
false
- 使用方式:
打开该参数,窗口将会占满浏览可视宽度区域,高度依然按照参数指定的数字进行设置
customClass 自定义样式,它会添加到弹出窗口的最外层DIV上
- 类型:
string
- 默认值:
无
- 使用方式:
页面中需要根据不同功能展示不同样式的弹出窗口时,可以使用该参数指定需要使用的样式名称
提示 样式内容需要预先定义,插件本身并不带任何皮肤样式
messageType 消息对话框类型,仅在bDialog.alert()、bDialog.toast()模式下有效
- 类型:
string
- 默认值:
'info'
- 使用方式:
设置对话框模式的窗口类型,不同类型有不同的图标及按钮
可设置的类型有:
info(消息提示模式,默认)
warning(警告模式)
error(错误模式)
success(完成模式)
confirm(确认对话框模式,该模式下,会有'确认'和'取消'两个按钮,仅alert模式下可用)
提示 confirm类型下,可单独设置cancel回调函数以用于点击取消按钮后的专用回调
position 窗口显示位置,仅在bDialog.toast()模式下可用
- 类型:
string
- 默认值:
'bottomRight'
- 使用方式:
设置窗口显示的边角位置
可设置的类型有:
topLeft(左上角)
topCenter(正上方)
topRight(右上角)
bottomLeft(左下角)
bottomCenter(正下方)
bottomRight(右下方)
closeTime 自动关闭窗口的时间,单位:秒,仅在bDialog.toast()模式下可用
- 类型:
number
- 默认值:
3
- 使用方式:
自动关闭窗口的时间,单位:秒,仅在type:toast模式下可用
设置0关闭自动关闭窗口功能
onShow 显示对话框前执行的回调
- 类型:
function
- 默认值:
无
- 使用方式:
该回调函数可在窗口被显示之前做一些内容的预处理工作
例:
onShow : function(dialog){ $('#aa',$(dialog)).val(1); }
onShowed 窗口完全展示完成后执行的回调
- 类型:
function
- 默认值:
无
- 使用方式:
该回调函数可在窗口完全显示完成后做数据处理工作
例:
onShowed : function(dialog){ $('#bb',$(dialog)).focus(); }
onHide 关闭/隐藏对话框前执行的回调
- 类型:
function
- 默认值:
无
- 使用方式:
该回调函数可在窗口被关闭前处理数据关系等操作
例:
onHide:function(dialog){$('#aa',$(dialog)).val($('#bb',$(dialog)).val());}
onHidden 关闭/隐藏对话框后执行的回调
- 类型:
function
- 默认值:
无
- 使用方式:
该回调函数可在窗口被关闭后被执行,若没有特殊应用,仅需要设置callback回调即可,不需要设置本回调
例:
onHidden : function(dialog){ $('#aa',$(dialog)).val(1); }
cancel confirm模式下,取消按钮的执行回调
- 类型:
function
- 默认值:
无
- 使用方式:
该回调函数仅在bDialog.alert()模式,且messageType为'confirm'模式下有效
用于确认对话框中的取消按钮点击后的专用回调
例:
cancel : function(dialog){ $('#aa',$(dialog)).val(1); }
bDialog.open 打开模态窗口
- 类型:
function
- 默认值:
无
- 使用方式:
以模态窗口的形式加载服务端页面或HTML片断内容
参数:以上的参数均为插件的配置参数
var a = bDialog.open({...});
bDialog.alert 打开消息对话窗口
- 类型:
function
- 默认值:
无
- 使用方式:
以模态窗口的形式加载服务端页面或HTML片断内容
参数:
message:显示文本内容
callback:关闭对话框后的回调
param:其它配置参数
示例:
var a = bDialog.alert('我是一个消息对话框!');
var a = bDialog.alert('我是一个消息对话框!',function(){//对话框关闭后的回调});
var a = bDialog.alert('我是一个消息对话框!',function(){},{messageType:'error'});
bDialog.mask 打开遮罩层
- 类型:
function
- 默认值:
无
- 使用方式:
以模态窗口的形式加载服务端页面或HTML片断内容
参数:
message:显示的提示文本,非必传,不传递则显示默认文本
param:配置参数,非必传
示例:
var a = bDialog.mask();//显示遮罩,并使用默认提示文本
var a = bDialog.mask('数据加载中,请稍等……');//显示遮罩,使用自定义文本
bDialog.mask('数据加载中,请稍等……',{ callback : function(){...} });//显示遮罩,使用自定义文本
bDialog.close 关闭窗口API
- 类型:
function
- 默认值:
无
- 使用方式:
该函数可以关闭窗口,并可以在关闭窗口的时候,回传参数给父窗口
参数:
data:向调用者回传的数据,或是bDialog对象
dialog:bDialog对象,用于关闭指定窗口
例:
bDialog.close();
仅关闭窗口(最后一个弹出的窗口),不传递参数bDialog.close({name:'zhangsan',sex:1});
关闭最后弹出的窗口并传递参数var a = bDialog.open({...});bDialog.close({name:'zhangsan',sex:1},a);
关闭窗口并传递参数var a = bDialog.open({...});bDialog.close(a);
关闭指定窗口不传递参数
bDialog.getDialog 获得当前打开窗口对象
- 类型:
function
- 默认值:
无
- 使用方式:
该函数可获得当前被打开的窗口对象,如果打开了多个窗口,则获得最后被打开的窗口
例:
var dialog = bDialog.getDialog();
bDialog.getDialogParams 获得父窗口传递的参数(被打开的窗口使用)
- 类型:
function
- 默认值:
无
- 使用方式:
该函数可以获得父窗口打开窗口时传递的params参数的内容
例:
var params = bDialog.getDialogParams();