Class Index | File Index

Classes


Namespace Sucang.page


Defined in: page.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
页面布局和模板及UI组件的相关操作类
Field Summary
Field Attributes Field Name and Description
<static>  
Sucang.page.isFrame
当前页是否被内嵌框架中
<static>  
Sucang.page.sql
用于在布局中Ajax同步方式请求获取服务器端数据
<static>  
Sucang.page.sql2
参数同Sucang.page.sql函数,只是返回结果是数组或者为空
<static>  
Sucang.page.tbar
当前页的顶部工具条对象 as Ext.Toolbar
Method Summary
Method Attributes Method Name and Description
<static>  
Sucang.page.addButton(Array, boolean)
当前面添加按钮
<static>  
Sucang.page.closeTab(win)
关闭当前活动Tab标签
<static>  
Sucang.page.closeWindow(Integer)
关闭当前模式窗口
<static>  
Sucang.page.getCookieValue(String)
获取指定name的Cookie值
<static>  
Sucang.page.getParentDom(HTMLElement, String)
查找对象obj的最近上级的标签为$tagName的对象
<static>  
Sucang.page.getTabFrame(String)
获取指定的标签页的Iframe对象,用.contentWindow属性获取iframe内的window对象
<static>  
Sucang.page.getTabTitle()
获取当前活动标签的标题
<static>  
Sucang.page.getWindow()
获取当前弹出窗口的window对象
<static>  
Sucang.page.getWindowToolbar()
获取当前弹出窗口的工具条对象
<static>  
Sucang.page.getWindowType(HTMLWindow)
获取指定的window对象内嵌在模式窗口中的类型,0表示当前window对象无内嵌,1表示Brwoser框,2表示当前Frame内的窗口
<static>  
Sucang.page.go(String, boolean)
用于当前页面或流程的转向,会跳过,当启用关闭窗口时的确认对话框
<static>  
Sucang.page.initCopyBtn(as, as)
将工具条按钮或指定的id的input按钮转换成带复制功能的按钮
<static>  
Sucang.page.initPrinter(String)
初始化打印选项并调用打印窗口, 定义:如果布局中需要在打印预览窗口出现前设置一些参数可以定义回调函数initPrinter(){ .
<static>  
Sucang.page.isWindow(HTMLWindow)
判断指定的window对象是否内嵌在模式窗口中
<static>  
Sucang.page.msg(String, String, String)
弹出消息提醒框
<static>  
Sucang.page.openHTMLWindow(String|Object, Function, Object)
在当前iframe窗口内打开模式对话框
<a href="$url" target="_window">链接文本</a> 只有在页面初始加载HTML时才有效
<static>  
Sucang.page.openTab(String, String, String)
将url链接在Tab标签中打开
可以是<a href="test.html" onclick="return Sucang.page.openTab(this,event)">test.html</a>
<a href="test.html" tabtext="标签文本" target="_tab">test.html</a>该方式需要页面初始HTML加载才有效.
<static>  
Sucang.page.openWindow(String, Array, Function|Object)
打开模式对话窗口,会覆盖在最顶层
<a href="$url" target="_browser" _bar="$values" _callback="$callback">链接文本</a> 只有在页面初始加载HTML时才有效
<static>  
Sucang.page.print(String, String|Object)
指定打印选项参数和打印布局
<static>  
Sucang.page.refreshTab(String)
刷新当前活动标签、当前窗口页面或转到指定的url页面
<static>  
Sucang.page.runDataInterface(String|Object, String|Object, boolean)
根据指定的接口id和参数,生成布局中赋值的接口脚本,一般用于浏览框自动带出数据或填充明细行数据
<static>  
Sucang.page.toggle(boolean|HTMLInputElement[checkbox], String|Array, as)
根据指定对象和ID自动设置目标targetid是否显示还是隐藏
Namespace Detail
Sucang.page
页面布局和模板及UI组件的相关操作类
Field Detail
<static> Sucang.page.isFrame
当前页是否被内嵌框架中

<static> {val} Sucang.page.sql
用于在布局中Ajax同步方式请求获取服务器端数据

<static> {result} Sucang.page.sql2
参数同Sucang.page.sql函数,只是返回结果是数组或者为空

<static> Sucang.page.tbar
当前页的顶部工具条对象 as Ext.Toolbar
Method Detail
<static> {tbar} Sucang.page.addButton(Array, boolean)
当前面添加按钮
Parameters:
{btns} Array
//Ext.Toolbar.Button的对象格式
{isPageCreate} boolean
{parentEl} Ext.Element
//当isPageCreate==true,且未发现#pageToolbar工具旋转位置时,将工具放到该元素的最前面
Returns:
{tbar} Ext.Toolbar

<static> Sucang.page.closeTab(win)
关闭当前活动Tab标签
Parameters:
win

<static> Sucang.page.closeWindow(Integer)
关闭当前模式窗口
Parameters:
{winIndex} Integer
//如果为空表示第一层默认窗口,一般无须指定

<static> {val} Sucang.page.getCookieValue(String)
获取指定name的Cookie值
Parameters:
{name} String
Returns:
{val} String

<static> {obj} Sucang.page.getParentDom(HTMLElement, String)
查找对象obj的最近上级的标签为$tagName的对象
Parameters:
{obj} HTMLElement
{tagName} String
//大写的HTML标记名
Returns:
{obj} HTMLElement

<static> Sucang.page.getTabFrame(String)
获取指定的标签页的Iframe对象,用.contentWindow属性获取iframe内的window对象
Parameters:
{frameId} String
//如果为空表示当前活动标签页

<static> {title} Sucang.page.getTabTitle()
获取当前活动标签的标题
Returns:
{title} String

<static> {win} Sucang.page.getWindow()
获取当前弹出窗口的window对象
Returns:
{win} HTMLWindow

<static> {tbar} Sucang.page.getWindowToolbar()
获取当前弹出窗口的工具条对象
Returns:
{tbar} Ext.Toolbar

<static> {nType} Sucang.page.getWindowType(HTMLWindow)
获取指定的window对象内嵌在模式窗口中的类型,0表示当前window对象无内嵌,1表示Brwoser框,2表示当前Frame内的窗口
Parameters:
{win} HTMLWindow
//如果为空时表示当前窗口的window对象
Returns:
{nType} Number

<static> Sucang.page.go(String, boolean)
用于当前页面或流程的转向,会跳过,当启用关闭窗口时的确认对话框
Parameters:
{surl} String
//URL转向的地址,如果为空则默认为about:blank
{isReplace} boolean
//表示是否替换当前页面,即无法退回到上一个页面
Returns:
void

<static> Sucang.page.initCopyBtn(as, as)
将工具条按钮或指定的id的input按钮转换成带复制功能的按钮
Parameters:
{btn} as
Ext.Toolbar.Button|String
{handler} as
Function 当btn参数是String,按钮id时必填

<static> Sucang.page.initPrinter(String)
初始化打印选项并调用打印窗口, 定义:如果布局中需要在打印预览窗口出现前设置一些参数可以定义回调函数initPrinter(){ .. }
Parameters:
{options} String

<static> Sucang.page.isWindow(HTMLWindow)
判断指定的window对象是否内嵌在模式窗口中
Parameters:
{win} HTMLWindow
//如果为空时表示当前窗口的window对象
Returns:
boolean

<static> Sucang.page.msg(String, String, String)
弹出消息提醒框
Parameters:
{title} String
标题
{msgContent} String
内容
{icon} String
//图标,默认为success,可选项有:danger,info,warning,success

<static> {dom} Sucang.page.openHTMLWindow(String|Object, Function, Object)
在当前iframe窗口内打开模式对话框
<a href="$url" target="_window">链接文本</a> 只有在页面初始加载HTML时才有效
Parameters:
{shtml} String|Object
//如果是URL则内嵌Iframe打开,如果是HTML内容则在<form标记中打开
{callback} Function
窗口关闭时的回调函数fucntion callback(win|form,isCancel){...}
{config} Object
//同Ext.Window的构造函数参数,tbar:[true|false]可以使默认的工具条隐藏或显示
Returns:
{dom} HTMLIFrameElement | HTMLFormElement

<static> {boolean} Sucang.page.openTab(String, String, String)
将url链接在Tab标签中打开
可以是<a href="test.html" onclick="return Sucang.page.openTab(this,event)">test.html</a>
<a href="test.html" tabtext="标签文本" target="_tab">test.html</a>该方式需要页面初始HTML加载才有效.
Parameters:
{id} String
标签Tab标签的ID
{url} String
要打开的URL
{title} String
Tab标签的标题
Returns:
{boolean} 返回值总是为false

<static> Sucang.page.openWindow(String, Array, Function|Object)
打开模式对话窗口,会覆盖在最顶层
<a href="$url" target="_browser" _bar="$values" _callback="$callback">链接文本</a> 只有在页面初始加载HTML时才有效
Parameters:
{url} String
需要打开的URL地址
{values} Array
可以为空或工具栏按钮,如:[{"text":"查询","handler":DefaultBtn.Query,"icon":"page_find"}] icon表示/images/icon下的文件名
{callback} Function|Object
对话框关闭时的回调函数格式function callback(val){...},如果为Object时须指定callback属性的回调函数和height,width。

<static> Sucang.page.print(String, String|Object)
指定打印选项参数和打印布局
Parameters:
{options} String
//打印选项参数,见Sucang.page.initPrinter();方法
{layoutid} String|Object
按指定的页面打印或者是指定的参数对象

<static> Sucang.page.refreshTab(String)
刷新当前活动标签、当前窗口页面或转到指定的url页面
Parameters:
{url} String
如果url为空表示刷新当前活动Tab标签和当前页

<static> Sucang.page.runDataInterface(String|Object, String|Object, boolean)
根据指定的接口id和参数,生成布局中赋值的接口脚本,一般用于浏览框自动带出数据或填充明细行数据
Parameters:
{dataInterfaceId} String|Object
数据接口的ID或者浏览框的字段名或按钮对象,见DataInterface.id
{params} String|Object
当为string时参数值默认设置参数名为value来表示
{isSync} boolean
表示是否同步获取,默认为异步

<static> Sucang.page.toggle(boolean|HTMLInputElement[checkbox], String|Array, as)
根据指定对象和ID自动设置目标targetid是否显示还是隐藏
Parameters:
{visible} boolean|HTMLInputElement[checkbox]
是选中还是不选
{targetId} String|Array
表示目标HTML对象的ID
{hasRequired} as
boolean 表示目标对象是否控制显示且必填,不显示不必填。

Documentation generated by JsDoc Toolkit 2.3.0 on Wed Jun 05 2019 11:25:20 GMT+0800 (CST)