Window

F. Window

new Window(options)

Description:

  • 窗体控件

Parameters:
Name Type Description
options Object

初始参数

Properties
Name Type Default Description
modal boolean true

是否模式窗体
draggable boolean true

是否可拖动
closable boolean true

是否可关闭
resizable boolean false

是否可改变大小
maximizable boolean false

是否可最大化
maximized boolean false

当前窗体的最大化状态
hideOnMaskClick boolean false

点击遮罩层时是否隐藏窗体
constrainInitialSize boolean true

限制初始尺寸在当前浏览器窗口内
constrainSize boolean false

限制窗体尺寸在当前浏览器窗口内
dependsViewPortSize boolean true

弹出窗体大小依赖于可视窗口的大小
keepLastPosition boolean false

关闭再打开时是否保持上次的位置（左上角）
keepLastSize boolean false

关闭再打开时是否保持上次的尺寸
minWidth number 100

最小宽度
minHeight number 100

最小高度
top number

窗体打开时左上角的位置
left number

窗体打开时左上角的位置
percentWidth number

窗体的百分比宽度（介于0-1的小数，比如0.25）（相对于页面窗口的宽度）
percentHeight number

窗体的百分比高度（介于0-1的小数，比如0.25）（相对于页面窗口的高度）
goldenPosition boolean false

窗体打开时是否位于页面黄金分割点的位置
positionX string 'center'

横坐标的位置（可选项为：left, center, right）
positionY string 'center'

纵坐标的位置（可选项为：top, center, bottom）
fixedPosition boolean false

窗体是否为 fixed 定位（默认为 absolute 定位）
autoFocus boolean true

显示后是否自动获取焦点
target string '_self'

窗体的显示位置（可选项为：_self, _parent, _top）（其中_parent, _top仅在 iframe=true 时有效）
closeAction string 'hide'

点击右上角关闭按钮或者按下ESC键时执行的操作（可选项为：hide, hiderefresh, hidepostback|close）
enableAnimation boolean

是否启用显示隐藏动画（如果未定义，则使用全局设置）
animationType string

显示隐藏的动画类型（可选项为：slideLeft, slideRight, slideUp, slideDown, fade, pop, flip）
type string 'window'

控件类型

Extends

Members

bodyEl :jQuery

Description:

  • 控件主体对应的jQuery节点对象

Inherited From:

控件主体对应的jQuery节点对象

Type:
  • jQuery

el :jQuery

Description:

  • 控件对应的jQuery节点对象

Inherited From:

控件对应的jQuery节点对象

Type:
  • jQuery

items :Object

Description:

  • 子控件列表

Inherited From:

子控件列表

Type:
  • Object

Methods

active()

Description:

  • 激活窗体（使其位于最上层）

add(value)

Description:

  • 添加新的子控件到当前控件

Inherited From:
Example
menu1.add(['-', {
		type: 'menuitem',
		text: '新菜单项'
}]);
Parameters:
Name Type Description
value Object | Array.<Object>

控件实例数组

addTool(item)

Description:

  • 添加工具图标

Inherited From:
Parameters:
Name Type Description
item F.Tool

工具图标实例

clearDirty()

Description:

  • 清空容器内字段的改变状态（接受字段已改变的值）

Inherited From:

close()

Description:

  • 关闭窗体（可以注册beforeclose事件并返回false来阻止窗体关闭）

collapse()

Description:

  • 折叠面板

Inherited From:

disable()

Description:

  • 禁用控件

Inherited From:

doLayout(startFormTopmostComonentopt)

Description:

  • 执行布局操作

Inherited From:
Parameters:
Name Type Attributes Default Description
startFormTopmostComonent boolean <optional>
 false

从最顶层的控件开始布局

enable()

Description:

  • 启用控件

Inherited From:

expand()

Description:

  • 展开面板

Inherited From:

getAttr(key) → {string}

Description:

  • 获取节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键
Returns:

节点属性值

Type
string

getFormFields() → {Array.<F.Field>}

Description:

  • 获取容器内的所有表单字段

Inherited From:
Returns:

表单字段数组

Type
Array.<F.Field>

getHeight() → {number}

Description:

  • 获取控件高度

Inherited From:
Returns:

高度

Type
number

getIFrameEl() → {jQuery}

Description:

  • 获取内联框架元素

Inherited From:
Returns:

内联框架元素

Type
jQuery

getIFrameUrl() → {string}

Description:

  • 获取内联框架地址

Inherited From:
Returns:

内联框架地址

Type
string

getIFrameWindow() → {Window}

Description:

  • 获取内联框架窗体对象

Inherited From:
Returns:

内联框架窗体对象

Type
Window

getIconEl() → {jQuery}

Description:

  • 获取图标元素

Inherited From:
Returns:

图标元素

Type
jQuery

getItem(value) → {F.Component}

Description:

  • 获取子控件

Inherited From:
Parameters:
Name Type Description
value number | string | function

子控件索引、标识符或者函数
Returns:

子控件实例

Type
F.Component

getScrollEl() → {jQuery}

Description:

  • 获取可滚动元素

Inherited From:
Returns:

可滚动元素

Type
jQuery

getTitle() → {string}

Description:

  • 获取面板标题

Inherited From:
Returns:

标题文本

Type
string

getTitleTooltip() → {string}

Description:

  • 获取面板标题提示信息

Inherited From:
Returns:

标题提示信息

Type
string

getTooltip() → {string}

Description:

  • 获取提示信息

Inherited From:
Returns:

提示信息

Type
string

getWidth() → {number}

Description:

  • 获取控件宽度

Inherited From:
Returns:

宽度

Type
number

hasHScrollbar() → {boolean}

Description:

  • 是否存在水平滚动条

Inherited From:
Returns:

是否存在水平滚动条

Type
boolean

hasIcon() → {boolean}

Description:

  • 是否有图标

Inherited From:
Returns:

是否有图标

Type
boolean

hasVScrollbar() → {boolean}

Description:

  • 是否存在垂直滚动条

Inherited From:
Returns:

是否存在垂直滚动条

Type
boolean

hide()

Description:

  • 隐藏窗体

Overrides:

hideLoading()

Description:

  • 隐藏加载动画

Inherited From:

insert(insertIndex, value)

Description:

  • 插入新的子控件到当前控件

Inherited From:
Example
menu1.insert(0, ['-', {
		type: 'menuitem',
		text: '新菜单项'
}]);
Parameters:
Name Type Description
insertIndex number

插入的位置
value Object | Array.<Object>

控件实例数组

insertTool(item, insertIndex)

Description:

  • 插入工具图标

Inherited From:
Parameters:
Name Type Description
item F.Tool

工具图标实例
insertIndex number

插入的位置

isCollapsed() → {boolean}

Description:

  • 是否处于折叠状态

Inherited From:
Returns:

折叠状态

Type
boolean

isDirty() → {boolean}

Description:

  • 容器内的表单字段是否已经改变

Inherited From:
Returns:

容器内的表单字段是否已经改变

Type
boolean

isDisabled() → {boolean}

Description:

  • 是否禁用

Inherited From:
Returns:

是否禁用

Type
boolean

isType(value) → {boolean}

Description:

  • 检测当前实例是否指定的控件类型

Inherited From:
Example
grid1.isType('panel') // 返回true
grid1.isType('grid')  // 返回true
Parameters:
Name Type Description
value Object

控件类型
Returns:

如果当前实例是指定的控件类型，返回true；否则返回false

Type
boolean

isValid(onlyFirstInvalidField) → {Array.<Object>}

Description:

  • 容器内的表单字段是否有效

Inherited From:
Parameters:
Name Type Default Description
onlyFirstInvalidField boolean false

是否仅返回第一个无效的字段
Returns:

容器内的表单字段是否有效（[isValid, firstInvalidField, secondInvalidField, thirdInvalidField...]）

Type
Array.<Object>

isVisible() → {boolean}

Description:

  • 是否可见

Inherited From:
Returns:

是否可见

Type
boolean

maximize()

Description:

  • 最大化窗体

off(eventNames, fn)

Description:

  • 移除事件

Inherited From:
Parameters:
Name Type Description
eventNames string

事件名称（可以空格分割多个事件名称）
fn F_Component_on

之前注册的事件处理函数

on(eventNames, fn)

Description:

  • 注册事件

Inherited From:
Parameters:
Name Type Description
eventNames string

事件名称（可以空格分割多个事件名称）
fn F_Component_on

触发事件时执行的函数

refreshIFrame()

Description:

  • 刷新内联框架

Inherited From:

remove()

Description:

  • 删除父控件中移除当前控件

Inherited From:

removeAttr(key)

Description:

  • 删除节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键

removeTooltip()

Description:

  • 删除提示信息

Inherited From:

reset()

Description:

  • 重置容器内的全部字段

Inherited From:

restore()

Description:

  • 还原窗体

setAttr(key, value)

Description:

  • 设置节点属性

Inherited From:
Parameters:
Name Type Description
key string

节点属性键
value string

节点属性值

setAttrs(attrs)

Description:

  • 设置节点属性

Inherited From:
Parameters:
Name Type Description
attrs Object

节点属性对象

setDisabled(disabled)

Description:

  • 设置控件的禁用状态

Inherited From:
Parameters:
Name Type Description
disabled boolean

是否禁用

setDraggable() → {boolean}

Description:

  • 设置窗体是否可以拖动

Returns:

是否可以拖动

Type
boolean

setEnabled(enabled)

Description:

  • 设置控件的启用状态

Inherited From:
Parameters:
Name Type Description
enabled boolean

是否启用

setHeight(height)

Description:

  • 设置控件高度

Inherited From:
Parameters:
Name Type Description
height number

高度

setHidden(hidden)

Description:

  • 设置控件的隐藏状态

Inherited From:
Parameters:
Name Type Description
hidden boolean

是否隐藏

setIFrameUrl(url)

Description:

  • 设置内联框架地址

Inherited From:
Parameters:
Name Type Description
url string

内联框架地址

setIcon(icon)

Description:

  • 设置图标地址

Inherited From:
Example
F.ui.panel1.setIcon('../res/images/16/1.png');
Parameters:
Name Type Description
icon string

图标地址

setIconFont(iconFont)

Description:

  • 设置图标字体

Inherited From:
Example
F.ui.panel1.setIconFont('bank');
Parameters:
Name Type Description
iconFont string

图标字体

setResizable() → {boolean}

Description:

  • 设置窗体是否可以改变大小

Returns:

是否可以改变大小

Type
boolean

setSize(width, height)

Description:

  • 设置控件尺寸

Inherited From:
Parameters:
Name Type Description
width number

宽度
height number

高度

setSplitDraggable() → {boolean}

Description:

  • 设置分隔条是否可以拖动

Inherited From:
Returns:

是否可以拖动

Type
boolean

setTitle(title)

Description:

  • 设置面板标题

Inherited From:
Parameters:
Name Type Description
title string

标题文本

setTitleTooltip(tooltip)

Description:

  • 设置面板标题提示信息

Inherited From:
Parameters:
Name Type Description
tooltip string

提示信息字符串

setTooltip(tooltip)

Description:

  • 设置提示信息

Inherited From:
Parameters:
Name Type Description
tooltip string

提示信息

setVisible(visible)

Description:

  • 设置控件的显示状态

Inherited From:
Parameters:
Name Type Description
visible boolean

是否可见

setWidth(width)

Description:

  • 设置控件宽度

Inherited From:
Parameters:
Name Type Description
width number

宽度

show(iframeUrlopt, titleopt, width, height)

Description:

  • 显示窗体

Overrides:
Example
window1.show();
window1.show('../grid1.aspx', 'title text');
window1.show(800， 600);
Parameters:
Name Type Attributes Description
iframeUrl string <optional>

内联网址（仅适用于iframe=true的情况）
title string <optional>

标题文本
width number

宽度
height number

高度

showLoading(opacity, container)

Description:

  • 显示加载动画

Inherited From:
Parameters:
Name Type Description
opacity number

透明度（默认值：0.65）
container jQuery

显示动画的目标元素（留空则为内容元素）

toggleCollapse()

Description:

  • 切换面板的折叠状态

Inherited From:

toggleEnabled()

Description:

  • 切换启用状态

Inherited From:

toggleVisible()

Description:

  • 切换显示状态

Inherited From:

trigger(eventName, args)

Description:

  • 触发事件

Inherited From:
Parameters:
Name Type Description
eventName string

事件名称
args Object

事件参数

Events

beforeclose

Description:

  • 关闭窗体之前触发（返回false则阻止关闭窗体）

beforehide

Description:

  • 隐藏控件之前触发（返回false则取消隐藏操作）

Inherited From:

beforeshow

Description:

  • 显示控件之前触发（返回false则取消显示操作）

Inherited From:

close

Description:

  • 关闭窗体时触发

collapse

Description:

  • 折叠面板时触发

Inherited From:
Parameters:
Name Type Description
event jQuery.Event

事件对象

dirtychange

Description:

  • 容器内的字段值改变时触发

Inherited From:

expand

Description:

  • 展开面板时触发

Inherited From:
Parameters:
Name Type Description
event jQuery.Event

事件对象

hide

Description:

  • 隐藏控件时触发

Inherited From:

iframeload

Description:

  • 内联框架加载完毕时触发

Inherited From:

layout

Description:

  • 布局控件时触发

Inherited From:

maximize

Description:

  • 最大化窗体时触发

render

Description:

  • 渲染控件时触发

Inherited From:

resize

Description:

  • 面板尺寸改变时触发

Inherited From:

restore

Description:

  • 还原窗体时触发

show

Description:

  • 显示控件时触发

Inherited From:

splitdrag

Description:

  • 拖动分隔条时触发（拖动操作）

Inherited From:
Parameters:
Name Type Description
event jQuery.Event

事件对象

windowdrag

Description:

  • 拖动窗体时触发（拖动操作）

windowresize

Description:

  • 改变窗体大小时触发（拖动操作）