API Documentation » \FineUIPHP\UI\Window\Window

package	FineUIPHP\UI

构造函数

__construct()

inherited

魔术方法

__get( $name) : mixed

inherited

Arguments

$name

Response

mixed

魔术方法显示组件（模板中echo 实例化对象时调用）

__toString() : string

inherited

Response

string

绝对定位的X坐标（当父容器的Layout=Absolute时有效）

absoluteX(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

绝对定位的Y坐标（当父容器的Layout=Absolute时有效）

absoluteY(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

AJAX 回发阶段，添加反映属性改变的 JavaScript 脚本

addAjaxScript()

inherited

向页面添加控件无关脚本

addStartupAbsoluteScript( $script, integer $level = \FineUIPHP\Config\Constants::ABSOLUTE_STARTUP_SCRIPT_DEFAULT_LEVEL)

inherited

Arguments

$script

$level

integer

添加CSS样式

addStartupCSS( $key,  $cssContent)

inherited

Arguments

$key

$cssContent

添加控件相关脚本

addStartupScript( $scriptContent)

inherited

Arguments

$scriptContent

锚点值（当父容器的Layout=Anchor时有效）

anchorValue(string $value) : $this

inherited

Arguments

$value

string

Response

$this

显示隐藏的动画类型（仅移动端支持）

animationType(string $value) : $this

Arguments

$value

string

Response

$this

HTML标签属性

attribute( $key,  $value) : $this

inherited

Arguments

$key

$value

Response

$this

HTML标签属性（data-tag）

attributeDataTag( $value) : $this

inherited

Arguments

$value

Response

$this

是否自动滚动

autoScroll(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

块大小，超小屏幕（当本容器的Layout=Block时有效）

block(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

自定义总块数（当本容器的Layout=Block时有效）

blockConfigBlockCount(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

块间距（当本容器的Layout=Block时有效

blockConfigSpace(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

块大小，大屏幕（当本容器的Layout=Block时有效）

blockLG(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

块大小，中等屏幕（当本容器的Layout=Block时有效）

blockMD(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

块大小，小屏幕（当本容器的Layout=Block时有效）

blockSM(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

内容区域的内边距，字符串类型，可以设置上下左右的内边距，比如'0px 5px'或'5px 10px 2px 2px'

bodyPadding( $value) : $this

inherited

Arguments

$value

Response

$this

内容区域的样式

bodyStyle(string $value) : $this

inherited

Arguments

$value

string

Response

$this

控制子控件的位置（当本容器的Layout=VBox或者HBox时有效）

boxConfigAlign(string $value) : $this

inherited

Arguments

$value

string

Response

$this

子控件的外边距（当本容器的Layout=VBox或者HBox时有效）

boxConfigChildMargin(string $value) : $this

inherited

Arguments

$value

string

Response

$this

内边距（当本容器的Layout=VBox或者HBox时有效）

boxConfigPadding(string $value) : $this

inherited

Arguments

$value

string

Response

$this

控制子控件的位置（当本容器的Layout=VBox或者HBox时有效）

boxConfigPosition(string $value) : $this

inherited

Arguments

$value

string

Response

$this

控制子控件的尺寸（当父容器的Layout=VBox或者HBox时有效））

boxFlex(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

关闭窗体后是否清空IFrame

clearIFrameAfterClose(boolean $value) : $this

Arguments

$value

boolean

Response

$this

关闭窗体的动作（点击关闭按钮或者按 ESC 键都会执行此动作）

closeAction(string $value) : $this

Arguments

$value

string

Response

$this

是否折叠

collapsed(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

列的宽度（当父容器的Layout=Column时有效）

columnWidth(string $value) : $this

inherited

Arguments

$value

string

Response

$this

是否将初始大小限制在当前页面内

constrainInitialSize(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否将窗体大小限制在当前页面内

constrainSize(boolean $value) : $this

Arguments

$value

boolean

Response

$this

面板内容

content(string $value) : $this

inherited

Arguments

$value

string

Response

$this

面板内容的jQuery选择器

contentEl(string $value) : $this

inherited

Arguments

$value

string

Response

$this

控件样式类名

cssClass(string $value) : $this

inherited

Arguments

$value

string

Response

$this

控件样式

cssStyle(string $value) : $this

inherited

Arguments

$value

string

Response

$this

自定义工具图标显示在系统工具图标的前面

customToolAhead(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

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

dependsViewPortSize(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用动画（仅Webkit浏览器支持动画效果）

enableAnimation(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否可以关闭

enableClose(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否允许折叠

enableCollapse(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否启用

enabled(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否默认添加CSS类（ui-corner-all）

enableDefaultCorner(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否可以移动

enableDrag(boolean $value) : $this

Arguments

$value

boolean

Response

$this

启用自定义的圆角边框

enableFrame(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否启用IFrame

enableIFrame(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否可以最大化

enableMaximize(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否可以最小化

enableMinimize(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否可以改变窗体大小

enableResize(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用表格样式

enableTableStyle(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否展开

expanded(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否使用（position:fixed）的CSS设置（默认是absolute）

fixedPosition(boolean $value) : $this

Arguments

$value

boolean

Response

$this

页面加载后立即获得焦点

focusOnPageLoad(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

getAbsoluteX

getAbsoluteX() : integer

inherited

Response

integer

getAbsoluteY

getAbsoluteY() : integer

inherited

Response

integer

getAnchorValue

getAnchorValue() : string

inherited

Response

string

getAnimationType

getAnimationType() : string

Response

string

getAttributeDataTag

getAttributeDataTag() : mixed|null

inherited

Response

mixed|null

getAutoScroll

getAutoScroll() : boolean

inherited

Response

boolean

getBlock

getBlock() : integer

inherited

Response

integer

getBlockConfigBlockCount

getBlockConfigBlockCount() : integer

inherited

Response

integer

getBlockConfigSpace

getBlockConfigSpace() : integer|null

inherited

Response

integer|null

getBlockLG

getBlockLG() : integer

inherited

Response

integer

getBlockMD

getBlockMD() : integer

inherited

Response

integer

getBlockSM

getBlockSM() : integer

inherited

Response

integer

getBodyPadding

getBodyPadding() : string

inherited

Response

string

getBodyStyle

getBodyStyle() : string

inherited

Response

string

getBoxConfigAlign

getBoxConfigAlign() : string

inherited

Response

string

getBoxConfigChildMargin

getBoxConfigChildMargin() : string

inherited

Response

string

getBoxConfigPadding

getBoxConfigPadding() : string

inherited

Response

string

getBoxConfigPosition

getBoxConfigPosition() : string

inherited

Response

string

getBoxFlex

getBoxFlex() : integer

inherited

Response

integer

getClearIFrameAfterClose

getClearIFrameAfterClose() : boolean

Response

boolean

getCloseAction

getCloseAction() : string

Response

string

getCollapsed

getCollapsed() : boolean

inherited

Response

boolean

getColumnWidth

getColumnWidth() : string

inherited

Response

string

getConstrainInitialSize

getConstrainInitialSize() : boolean

Response

boolean

getConstrainSize

getConstrainSize() : boolean

Response

boolean

getContent

getContent() : string

inherited

Response

string

getContentEl

getContentEl() : string

inherited

Response

string

getCssClass

getCssClass() : string

inherited

Response

string

getCssStyle

getCssStyle() : string

inherited

Response

string

getCustomToolAhead

getCustomToolAhead() : boolean

inherited

Response

boolean

getDependsViewPortSize

getDependsViewPortSize() : boolean

Response

boolean

getEnableAnimation

getEnableAnimation() : boolean|null

Response

boolean|null

getEnableClose

getEnableClose() : boolean

Response

boolean

getEnableCollapse

getEnableCollapse() : boolean

inherited

Response

boolean

getEnabled

getEnabled() : boolean

inherited

Response

boolean

getEnableDefaultCorner

getEnableDefaultCorner() : boolean

Response

boolean

getEnableDrag

getEnableDrag() : boolean

Response

boolean

getEnableFrame

getEnableFrame() : boolean

inherited

Response

boolean

getEnableIFrame

getEnableIFrame() : boolean

inherited

Response

boolean

getEnableMaximize

getEnableMaximize() : boolean

Response

boolean

getEnableMinimize

getEnableMinimize() : boolean

Response

boolean

getEnableResize

getEnableResize() : boolean

Response

boolean

getEnableTableStyle

getEnableTableStyle() : boolean

inherited

Response

boolean

getCollapsed

getExpanded() : boolean

inherited

Response

boolean

getFixedPosition

getFixedPosition() : boolean

Response

boolean

getFocusOnPageLoad

getFocusOnPageLoad() : boolean

inherited

Response

boolean

getHeight

getHeight() : integer|null

inherited

Response

integer|null

getHidden

getHidden() : boolean

inherited

Response

boolean

getHideMode

getHideMode() : string

inherited

Response

string

getHideOnMaskClick

getHideOnMaskClick() : boolean

Response

boolean

getIcon

getIcon() : string

inherited

Response

string

getIconFont

getIconFont() : string

inherited

Response

string

getIconFontClass

getIconFontClass() : string

inherited

Response

string

getIconUrl

getIconUrl() : string

inherited

Response

string

getId

getId() : mixed

inherited

Response

mixed

getIFrameName

getIFrameName() : string

inherited

Response

string

getIFrameUrl

getIFrameUrl() : string

inherited

Response

string

getIsFluid

getIsFluid() : boolean

inherited

Response

boolean

getIsModal

getIsModal() : boolean

Response

boolean

getIsViewPort

getIsViewPort() : boolean

inherited

Response

boolean

getItems

getItems() : array

inherited

Response

array

getKeepLastPosition

getKeepLastPosition() : boolean

Response

boolean

getKeepLastSize

getKeepLastSize() : boolean

Response

boolean

getLayout

getLayout() : integer|null

inherited

Response

integer|null

getLayoutAfterImagesLoad

getLayoutAfterImagesLoad() : integer|null

inherited

Response

integer|null

getLeft

getLeft() : integer|null

Response

integer|null

getMargin

getMargin() : string

inherited

Response

string

getMarginBottom

getMarginBottom() : integer

inherited

Response

integer

getMarginLeft

getMarginLeft() : integer

inherited

Response

integer

getMarginRight

getMarginRight() : integer

inherited

Response

integer

getMarginTop

getMarginTop() : integer

inherited

Response

integer

getMaxHeight

getMaxHeight() : integer

inherited

Response

integer

getMaximized

getMaximized() : boolean

Response

boolean

getMaxWidth

getMaxWidth() : integer

inherited

Response

integer

getMinHeight

getMinHeight() : integer

inherited

Response

integer

getMinWidth

getMinWidth() : integer

inherited

Response

integer

获取组件参数值

getOption(string $optionName) : mixed

inherited

Throws	\Exception

Arguments

$optionName

string

参数名

Response

mixed

getPercentHeight

getPercentHeight() : string

Response

string

getPercentWidth

getPercentWidth() : string

Response

string

getPositionX

getPositionX() : string

Response

string

getPositionY

getPositionY() : string

Response

string

获取回发页面的客户端脚本

getPostBackEventReference(\FineUIPHP\Event|string $event = '') : string

inherited

Arguments

$event

\FineUIPHP\Event|string

Response

string

getRegionPercent

getRegionPercent() : string

inherited

Response

string

getRegionPosition

getRegionPosition() : string

inherited

Response

string

getRegionSplit

getRegionSplit() : boolean

inherited

Response

boolean

getRegionSplitDraggable

getRegionSplitDraggable() : boolean

inherited

Response

boolean

getRegionSplitHeaderClass

getRegionSplitHeaderClass() : boolean

inherited

Response

boolean

getRegionSplitIcon

getRegionSplitIcon() : boolean

inherited

Response

boolean

getRegionSplitWidth

getRegionSplitWidth() : integer

inherited

Response

integer

getShowBorder

getShowBorder() : boolean

inherited

Response

boolean

getShowHeader

getShowHeader() : boolean

inherited

Response

boolean

getTableColspan

getTableColspan() : integer

inherited

Response

integer

getTableConfigColumns

getTableConfigColumns() : integer

inherited

Response

integer

getTableRowspan

getTableRowspan() : integer

inherited

Response

integer

getTarget

getTarget() : string

Response

string

getTitle

getTitle() : string

inherited

Response

string

getTitleAlign

getTitleAlign() : string

inherited

Response

string

getTitleToolTip

getTitleToolTip() : string

inherited

Response

string

getTitleToolTipType

getTitleToolTipType() : string

inherited

Response

string

getToolbars

getToolbars() : array

inherited

Response

array

getTools

getTools() : array

inherited

Response

array

getTop

getTop() : integer|null

Response

integer|null

getWidth

getWidth() : integer|null

inherited

Response

integer|null

getWindowPosition

getWindowPosition() : string

Response

string

控件外部容器的客户端ID（比如：Button1_wrapper）

getWrapperID() : string

inherited

Response

string

getWrapperNodeInlineBlock

getWrapperNodeInlineBlock() : boolean

inherited

Response

boolean

JavaScript中使用ID（比如：x0, x1）

getXID() : string

inherited

Response

string

判断参数是否有设置

hasOption(string $optionName) : boolean

inherited

Arguments

$optionName

string

参数名

Response

boolean

高度

height(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

是否隐藏

hidden(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

隐藏模式（可选项为：display, visibility, offsets

hideMode(string $value) : $this

inherited

Arguments

$value

string

Response

$this

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

hideOnMaskClick(boolean $value) : $this

Arguments

$value

boolean

Response

$this

预定义图标

icon(string $value) : $this

inherited

Arguments

$value

string

Response

$this

预定义图标字体

iconFont(string $value) : $this

inherited

Arguments

$value

string

Response

$this

自定义图标字体的样式类

iconFontClass(string $value) : $this

inherited

Arguments

$value

string

Response

$this

图标地址

iconUrl(string $value) : $this

inherited

Arguments

$value

string

Response

$this

控件标识符

id(string $id) : $this

inherited

Arguments

$id

string

Response

$this

内联框架名称（iframe节点的name属性）

iFrameName(string $value) : $this

inherited

Arguments

$value

string

Response

$this

内联框架网址

iFrameUrl(string $value) : $this

inherited

Arguments

$value

string

Response

$this

是否处于FineUI的AJAX回发过程

isFineUIAjaxPostBack() : boolean

inherited

Response

boolean

是否流式面板（占据父容器的全部宽度）

isFluid(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否模式窗体

isModal(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否全屏视图（占据整个屏幕）

isViewPort(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

子控件集合

items() : $this

inherited

Response

$this

关闭再打开时保持关闭时的位置

keepLastPosition(boolean $value) : $this

Arguments

$value

boolean

Response

$this

关闭再打开时保持关闭时的大小

keepLastSize(boolean $value) : $this

Arguments

$value

boolean

Response

$this

布局类型

layout(string $value) : $this

inherited

Arguments

$value

string

Response

$this

容器中的全部图片加载完毕后，对容器重新进行布局

layoutAfterImagesLoad(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

左上角位置

left(integer $value) : $this

Arguments

$value

integer

Response

$this

添加客户端事件处理函数

listener( $eventName,  $handler) : $this

inherited

Arguments

$eventName

$handler

Response

$this

外边距

margin(string $value) : $this

inherited

Arguments

$value

string

Response

$this

底部外边距

marginBottom(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

左侧外边距

marginLeft(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

右侧外边距

marginRight(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

顶部外边距

marginTop(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

最大高度

maxHeight(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

是否最大化

maximized(boolean $value) : $this

Arguments

$value

boolean

Response

$this

最大宽度

maxWidth(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

最小高度

minHeight(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

最小宽度

minWidth(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

noRenderTo

noRenderTo() : $this

inherited

Response

$this

关闭窗体事件

onClose() : \FineUIPHP\UI\Window\Window

Response

\FineUIPHP\UI\Window\Window

$this

折叠面板事件

OnCollapse() : $this

inherited

Response

$this

展开面板事件

OnExpand() : $this

inherited

Response

$this

渲染 HTML 之前调用（页面第一次加载或者普通回发）

onFirstPreRender()

inherited

窗体的百分比高度（相对于页面的高度）

percentHeight(string $value) : $this

Arguments

$value

string

Response

$this

窗体的百分比宽度（相对于页面的宽度）

percentWidth(string $value) : $this

Arguments

$value

string

Response

$this

窗体在 X 轴的位置

positionX(string $value) : $this

Arguments

$value

string

Response

$this

窗体在 Y 轴的位置

positionY(string $value) : $this

Arguments

$value

string

Response

$this

区域的百分比尺寸（当父容器的Layout=Region时有效）

regionPercent(string $value) : $this

inherited

Arguments

$value

string

Response

$this

区域所在的位置

regionPosition(string $value) : $this

inherited

Arguments

$value

string

Response

$this

是否启用区域分隔条

regionSplit(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

区域分隔条是否可拖动

regionSplitDraggable(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否为区域分隔条使用表头样式

regionSplitHeaderClass(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否显示区域分隔条图标

regionSplitIcon(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

区域分隔条的宽度

regionSplitWidth(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

删除CSS样式

removeStartupCSS( $key)

inherited

Arguments

$key

解析IFrame地址

resolveIFrameUrl( $url) : mixed|string

inherited

Arguments

$url

Response

mixed|string

setHandler

setHandler(string $handler) : void

inherited

Arguments

$handler

string

是否显示边框

showBorder(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否显示标题栏

showHeader(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

表格合并列（当父容器的Layout=Table时有效）

tableColspan(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

表格列数（当父容器的Layout=Table时有效）

tableConfigColumns(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

表格合并行（当父容器的Layout=Table时有效）

tableRowspan(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

弹出窗体的目标位置（只有在EnableIFrame=true的情况下有效）

target(string $value) : $this

Arguments

$value

string

Response

$this

标题

title(string $value) : $this

inherited

Arguments

$value

string

Response

$this

标题文本的排列位置

titleAlign(string $value) : $this

inherited

Arguments

$value

string

Response

$this

标题的提示文本

titleToolTip(string $value) : $this

inherited

Arguments

$value

string

Response

$this

标题的提示文本类型

titleToolTipType(string $value) : $this

inherited

Arguments

$value

string

Response

$this

转换options为json

toJson() : mixed|string

inherited

Response

mixed|string

工具栏控件集合

toolbars() : $this

inherited

Response

$this

工具图标集合

tools() : $this

inherited

Response

$this

左上角位置

top(integer $value) : $this

Arguments

$value

integer

Response

$this

触发 OnFirstPreRender 事件（这个函数是为了避免修改 OnFirstPreRender 的 protected 前缀）

triggerAjaxPreRenderEvent()

inherited

宽度

width(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

窗体的位置（优先级低于 PositionX 和 PositionY 属性）

windowPosition(string $value) : $this

Arguments

$value

string

Response

$this

是否添加 f-inline-block 样式

wrapperNodeInlineBlock( $value) : $this

inherited

Arguments

$value

Response

$this

是否向页面输出控件的外部容器（默认：true）否：只创建Javascript对象而不添加到页面中是：创建Javascript对象，并添加到页面中，页面上添加占位符

renderWrapperNode : boolean

inherited

var

Type(s)

boolean

服务端事件列表

events : array

inherited

var

Type(s)

array

客户端事件列表

listeners : array

inherited

var

Type(s)

array

虚拟的父控件，为了保证生产JS脚本的顺序（比如按钮的MenuID属性、DropDownBox的PopPanelID属性）

virtualParent : null

inherited

var

Type(s)

null

scriptID

scriptID : string

inherited

Type(s)

string

Window

Methods

构造函数

魔术方法

Arguments

$name

Response

魔术方法 显示组件（模板中echo 实例化对象时调用）

Response

绝对定位的X坐标（当父容器的Layout=Absolute时有效）

Arguments

$value

Response

绝对定位的Y坐标（当父容器的Layout=Absolute时有效）

Arguments

$value

Response

AJAX 回发阶段，添加反映属性改变的 JavaScript 脚本

向页面添加控件无关脚本

Arguments

$script

$level

添加CSS样式

Arguments

$key

$cssContent

添加控件相关脚本

Arguments

$scriptContent

锚点值（当父容器的Layout=Anchor时有效）

Arguments

$value

Response

显示隐藏的动画类型（仅移动端支持）

Arguments

$value

Response

HTML标签属性

Arguments

$key

$value

Response

HTML标签属性（data-tag）

Arguments

$value

Response

是否自动滚动

Arguments

$value

Response

块大小，超小屏幕（当本容器的Layout=Block时有效）

Arguments

$value

Response

自定义总块数（当本容器的Layout=Block时有效）

Arguments

$value

Response

块间距（当本容器的Layout=Block时有效

Arguments

$value

Response

块大小，大屏幕（当本容器的Layout=Block时有效）

Arguments

$value

Response

块大小，中等屏幕（当本容器的Layout=Block时有效）

Arguments

$value

Response

块大小，小屏幕（当本容器的Layout=Block时有效）

Arguments

$value

Response

内容区域的内边距，字符串类型，可以设置上下左右的内边距，比如'0px 5px'或'5px 10px 2px 2px'

Arguments

$value

Response

内容区域的样式

Arguments

魔术方法显示组件（模板中echo 实例化对象时调用）