使用$.fn.iPanel.defaults重写默认值对象。
面板作为承载其它内容的容器。这是构建其他组件的基础(比如:layout,tabs,accordion等)。它还提供了折叠、关闭、最大化、最小化和自定义行为。面板可以很容易地嵌入到web页面的任何位置。

1. 通过标签创建面板
通过标签创建更简单。添加data-toggle="topjui-panel"到< div/>标签。
panel content.
panel content.
2. 创建面板程序
通过Javascrip创建面板右上角的的工具栏。
panel content.
panel content.
$('#p').iPanel({
width:500,
height:150,
title: 'My Panel',
tools: [{
iconCls:'icon-add',
handler:function(){alert('new')}
},{
iconCls:'icon-save',
handler:function(){alert('save')}
}]
});
调用'move'方法移动面板到新的位置。
$('#p').iPanel('move',{
left:100,
top:100
});
当加载成功的时候让我们通过ajax加载面板内容并显示一些消息。
$('#p').iPanel({
href:'content_url.php',
onLoad:function(){
alert('loaded successfully');
}
});
| 属性名 | 属性值类型 | 描述 | 默认值 |
|---|---|---|---|
| id | string | 面板的ID属性。 | null |
| title | string | 在面板头部显示的标题文本。 | null |
| iconCls | string | 设置一个16x16图标的CSS类ID显示在面板左上角。 | null |
| width | number | 设置面板宽度。 | auto |
| height | number | 设置面板高度。 | auto |
| left | number | 设置面板距离左边的位置(即X轴位置)。 | null |
| top | number | 设置面板距离顶部的位置(即Y轴位置)。 | null |
| cls | string | 添加一个CSS类ID到面板。 | null |
| headerCls | string | 添加一个CSS类ID到面板头部。 | null |
| bodyCls | string | 添加一个CSS类ID到面板正文部分。 | null |
| style | object | 添加一个当前指定样式到面板。
如下代码示例更改面板边框宽度:
|
{} |
| fit | boolean | 当设置为true的时候面板大小将自适应父容器。下面的例子显示了一个面板,可以自动在父容器的最大范围内调整大小。
|
false |
| border | boolean | 定义是否显示面板边框。 | true |
| doSize | boolean | 如果设置为true,在面板被创建的时候将重置大小和重新布局。 | true |
| noheader | boolean | 如果设置为true,那么将不会创建面板标题。 | false |
| content | string | 面板主体内容。 | null |
| halign | string | 定义面板头部对齐方式。可用值有:'top', 'left', 'right'。 | top |
| titleDirection | string | 定义面板标题方向。可用值有:'up', 'down'。该属性仅在halign值为'left'或'right'时有效。 | down |
| collapsible | boolean | 定义是否显示可折叠按钮。 | false |
| minimizable | boolean | 定义是否显示最小化按钮。 | false |
| maximizable | boolean | 定义是否显示最大化按钮。 | false |
| closable | boolean | 定义是否显示关闭按钮。 | false |
| tools | array,selector | 自定义工具菜单,可用值: 1) 数组,每个元素都包含'iconCls'和'handler'属性。 2) 指向工具菜单的选择器。 面板工具菜单可以声明在已经存在的< div>标签上:
|
[] |
| header | selector | 定义面板标题。 代码示例:
|
|
| footer | selector | 定义面板页脚。
代码示例:
|
null |
| openAnimation | string | 定义打开面板的动画,可用值有:'slide','fade','show'。 | |
| openDuration | number | 定义打开面板的持续时间。 | 400 |
| closeAnimation | string | 定义关闭面板的动画,可用值有:'slide','fade','show'。 | |
| closeDuration | number | 定义关闭面板的持续时间。 | 400 |
| collapsed | boolean | 定义是否在初始化的时候折叠面板。 | false |
| minimized | boolean | 定义是否在初始化的时候最小化面板。 | false |
| maximized | boolean | 定义是否在初始化的时候最大化面板。 | false |
| closed | boolean | 定义是否在初始化的时候关闭面板。 | false |
| href | string | 从URL读取远程数据并且显示到面板。注意:内容将不会被载入,直到面板打开或扩大,在创建延迟加载面板时是非常有用的:
|
null |
| cache | boolean | 如果为true,在超链接载入时缓存面板内容。 | true |
| loadingMessage | string | 在加载远程数据的时候在面板内显示一条消息。 | Loading… |
| extractor | function | 定义如何从ajax应答数据中提取内容,返回提取数据。
extractor: function(data){
var pattern = /< body[^>]*>((.|[\n\r])*)<\/body>/im;
var matches = pattern.exec(data);
if (matches){
return matches[1]; // 仅提取主体内容
} else {
return data;
}
}
|
|
| method | string | 使用HTTP的哪一种方法读取内容页。可用值:'get','post'。 | get |
| queryParams | object | 在加载内容页的时候添加的请求参数。 | {} |
| loader | function | 定义了如何从远程服务器加载内容页,该函数接受以下参数: param:参数对象发送给远程服务器。 success(data):在检索数据成功的时候调用的回调函数。 error():在检索数据失败的时候调用的回调函数。 |
| 事件名 | 事件参数 | 描述 |
|---|---|---|
| onBeforeLoad | none | 在加载内容页之前触发,返回false将忽略该动作。 |
| onLoad | none | 在加载远程数据时触发。 |
| onLoadError | none | 在加载内容页发生错误时触发。 |
| onBeforeOpen | none | 在打开面板之前触发,返回false可以取消打开操作。 |
| onOpen | none | 在打开面板之后触发。 |
| onBeforeClose | none | 在关闭面板之前触发,返回false可以取消关闭操作。下列的面板将不能关闭。
|
| onClose | none | 在面板关闭之后触发。 |
| onBeforeDestroy | none | 在面板销毁之前触发,返回false可以取消销毁操作。 |
| onDestroy | none | 在面板销毁之后触发。 |
| onBeforeCollapse | none | 在面板折叠之前触发,返回false可以终止折叠操作。 |
| onCollapse | none | 在面板折叠之后触发。 |
| onBeforeExpand | none | 在面板展开之前触发,返回false可以终止展开操作。 |
| onExpand | none | 在面板展开之后触发。 |
| onResize | width, height | 在面板改变大小之后触发。 width:新的宽度。 height:新的高度。 |
| onMove | left,top | 在面板移动之后触发。 left:新的左边距位置。 top:新的上边距位置。 |
| onMaximize | none | 在窗口最大化之后触发。 |
| onRestore | none | 在窗口恢复到原始大小以后触发。 |
| onMinimize | none | 在窗口最小化之后触发。 |
| 方法名 | 方法参数 | 描述 |
|---|---|---|
| options | none | 返回属性对象。 |
| panel | none | 返回面板对象。 |
| header | none | 返回面板头对象。 |
| footer | none | 返回面板页脚对象。 |
| body | none | 返回面板主体对象。 |
| setTitle | title | 设置面板头的标题文本。 |
| open | forceOpen | 在'forceOpen'参数设置为true的时候,打开面板时将跳过'onBeforeOpen'回调函数。 |
| close | forceClose | 在'forceClose'参数设置为true的时候,关闭面板时将跳过'onBeforeClose'回调函数。 |
| destroy | forceDestroy | 在'forceDestroy'参数设置为true的时候,销毁面板时将跳过'onBeforeDestory'回调函数。 |
| clear | none | 清除面板内容。 |
| refresh | href | 刷新面板来装载远程数据。如果'href'属性有了新配置,它将重写旧的'href'属性。 代码示例:
// 打开面板且刷新其内容。
$('#pp').iPanel('open').iPanel('refresh');
// 刷新一个新的URL内容$('#pp').iPanel('open').iPanel('refresh','new_content.php');
|
| resize | options | 设置面板大小和布局。参数对象包含下列属性: width:新的面板宽度。 height:新的面板高度。 left:新的面板左边距位置。 top:新的面板上边距位置。 代码示例:
$('#pp').iPanel('resize',{
width: 600,
height: 400
});
|
| doLayout | none | 设置面板内子组件的大小。 |
| move | options | 移动面板到一个新位置。参数对象包含下列属性: left:新的左边距位置。 top:新的上边距位置。 |
| maximize | none | 最大化面板到容器大小。 |
| minimize | none | 最小化面板。 |
| restore | none | 恢复最大化面板回到原来的大小和位置。 |
| collapse | animate | 折叠面板主题。 |
| expand | animate | 展开面板主体。 |