DockPanelPort 类

全称	mx.containers.DockPanelPort
命名空间	mx.containers
类	DockPanelPort
继承层次结构	DockPanelPortContainerControl
源文件	~\mx\scripts\containers\DockPanelPort.js

提供一个DockPanelPort布局容器。

示例 1

以下是面板容器的使用示例。

JavaScript 代码

JavaScript 代码
`//生成一个不包含任何DockPage的DockPanelPort实例 var panel = mx.containers.DockPanelPort({ }); //生成一个包含左DockPage和底部DokcPage的实例DockPanelPort new mx.containers.DockPanelPort({ dockPages:[ { name : "dockPage_left1", text : "left", imageKey : "save", displayHead: true, dockPosition : "left" }, { name : "dockPage_bottom", text : "bottom", imageKey : "save", displayHead: true, dockPosition : "bottom" } ] });`


//生成一个不包含任何DockPage的DockPanelPort实例
var panel = mx.containers.DockPanelPort({

});
//生成一个包含左DockPage和底部DokcPage的实例DockPanelPort
new mx.containers.DockPanelPort({
   dockPages:[
         {
	          name : "dockPage_left1",
	          text : "left",
	          imageKey : "save",
	          displayHead: true,
	          dockPosition : "left"
	        },
	         {
	          name : "dockPage_bottom",
	          text : "bottom",
	          imageKey : "save",
	          displayHead: true,
	          dockPosition : "bottom"
	        }
   ]
});

构造函数

名称	说明
DockPanelPort()	构建 DockPanelPort 类的新实例。

初始化函数

名称	说明
init()	初始化方法。执行设置样式并初始化属性等操作。

方法

名称	说明
addControl(p_control)	向内容区添加控件
addControls(p_controls)	将一组 Control 对象添加到集合 controls 中。
addControlToDockPage(p_control, p_position, p_index)	向dockpage中添加控件,前提是对应位置dockPage是已经存在的
addDockPage(p_dockpage)	添加dockPage方法
append($p_obj)	向容器中添加内容。
contains($p_target)	返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
dispose()	释放对象运行时动态生成的内容（属性、方法、事件）。
findControl(p_alias)
findControlByPermissionID(p_permissionID)	根据指定的权限标识查找当前视图中对应的控件。
getContext()	获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。
getEl()	获取控件容器对应的 HTML DOM 元素对象。
hide()	隐藏控件，设置控件不可见。
moveTo(p_left, p_top)	移动控件到指定位置。
removeControl(p_control, p_deep)	从 controls 集合中移除指定的 Control 对象。从集合中移除控件时，该控件会被从上下文的 DOM 中移除，但仍驻留在内存中，可以重用。
resizeTo(p_width, p_height)	重设控件的大小。
setBorder(p_border)	设置控件的边框样式。
setBottom(p_bottom)	设置 bottom 字段的值。
setCss(p_css)	设置 css 字段的值。
setCssClass(p_cssClass)	设置 cssClass} 字段的值
setDisplay(p_display)	设置 display 字段的值。
setEnabled(p_enabled)	设置 enabled 字段的值。
setHeight(p_height)	设置 height 字段的值。
setLeft(p_left)	设置 left 字段的值。
setPadding(p_padding)	设置控件的内边距。
setPosition(p_position)	设置 position 字段的值。
setRight(p_right)	设置 right 字段的值。
setTop(p_top)	设置 top 字段的值。
setVisible(p_visible)	设置 visible 字段的值。
setWidth(p_width)	设置 width 字段的值。
show()	显示控件，设置控件可见。
$(p_expression)	该方法与 me.$e.find(p_expression) 等同。
$wrap([p_obj])	返回一个 JQuery 对象。

字段

名称	说明
alias	获取或设置一个字符串，表示控件的别名。
border	获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。
bottom	获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。
contextMenu	获取或设置容器的上下文菜单。
controls	获取容器包含的控件集合。集合中的单个控件也可能是一个容器。请使用 addControl 和 removeControl 方法向集合中添加或移除控件。
cssClass	指定css伪类名称，设置控件显示样式
display	获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。方法设置该字段的值。
dockPages	控件包含的dockPage集合
enabled	获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。请使用 setEnabled 方法设置该字段的值。
eTag	获取控件的标签。
height	请参见 Control.height 字段。
layout	获取和设置一个容器控件的布局器。详见 LayoutFactoryClass.createLayout 方法的 p_layout参数。
layoutConfigs	获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
layoutOptions	获取和设置布局参数，该属性是一个 JSON 对象。
left	获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
name	获取或设置页面的名称。该字段也是页面的唯一标识。
padding	获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
parent	获取控件所属的父对象。
permissionID	获取或设置一个字符串，表示控件的权限标识。
position	详见 Control.position 属性。
right	获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
top	获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
visible	获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。
width	请参见 Control.width 字段。
$container	获取容器控件中用来包含控件 DOM 元素的占位符。
$e	获取该控件的占位符，该占位符为一个 JQuery 对象。
_dockPanels	受保护的。_dockPanels数组
_layoutContainers	受保护的。表示页面布局容器

事件

名称	说明
onctrladded	当添加控件到容器后，将触发该事件。
onctrlremoved	当从容器移除控件后，将触发该事件。
onload	控件在dom中加载完成后触发

构造函数详细信息

DockPanelPort() 方法

构建 DockPanelPort 类的新实例。

初始化函数详细信息

init() 方法

初始化方法。执行设置样式并初始化属性等操作。

继承自

mx.containers.Container.init

方法详细信息

addControl(p_control) 方法

向内容区添加控件

参数

p_control
所有继承自mx.controls.Control的实例

继承自

mx.containers.Container.addControl

addControls(p_controls) 方法

将一组 Control 对象添加到集合 controls 中。

参数

p_controls
一个 Control 控件数组。

继承自

mx.containers.Container.addControls

addControlToDockPage(p_control, p_position, p_index) 方法

向dockpage中添加控件,前提是对应位置dockPage是已经存在的

参数

p_control
所有继承自mx.controls.Control的实例
p_position
代表位置的字符串，"left","right","top","bottom",默认是left
p_index
dockPanel中dockPage的索引,从0开始，默认是0

addDockPage(p_dockpage) 方法

添加dockPage方法

参数

p_dockpage
是一个DockPage实例

append($p_obj) 方法

向容器中添加内容。

参数

$p_obj
一个 JQuery 对象，或一个控件（包含 $container 容器），或一个 HTML DOM 元素。

继承自

mx.containers.Container.append

contains($p_target) 方法

返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。

参数

$p_target
一个 JQuery 对象，或 JQuery 选择器对应的字符串（如“#container”），或 HTML DOM 元素。

继承自

mx.controls.Control.contains

dispose() 方法

释放对象运行时动态生成的内容（属性、方法、事件）。

继承自

mx.controls.Control.dispose

findControl(p_alias) 方法

参数

p_alias

继承自

mx.containers.Container.findControl

findControlByPermissionID(p_permissionID) 方法

根据指定的权限标识查找当前视图中对应的控件。

参数

p_permissionID
一个字符串，表示控件的权限标识。

继承自

mx.containers.Container.findControlByPermissionID

getContext() 方法

获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。

继承自

mx.controls.Control.getContext

getEl() 方法

获取控件容器对应的 HTML DOM 元素对象。

继承自

mx.controls.Control.getEl

hide() 方法

隐藏控件，设置控件不可见。

继承自

mx.controls.Control.hide

moveTo(p_left, p_top) 方法

移动控件到指定位置。

参数

p_left
一个数字，表示 css 样式的 left 属性。
p_top
一个数字，表示 css 样式的 top 属性。

继承自

mx.controls.Control.moveTo

removeControl(p_control, p_deep) 方法

从 controls 集合中移除指定的 Control 对象。从集合中移除控件时，该控件会被从上下文的 DOM 中移除，但仍驻留在内存中，可以重用。

参数

p_control
一个 Control 对象。
p_deep
表示是否从内存中删除指定控件。

继承自

mx.containers.Container.removeControl

resizeTo(p_width, p_height) 方法

重设控件的大小。

参数

p_width
控件的宽度，可以是数字（如 100），也可以是字符串（如 “100%”）。
p_height
控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。

继承自

mx.controls.Control.resizeTo

setBorder(p_border) 方法

设置控件的边框样式。

参数

p_border
一个字符串，表示css样式的 border 属性。

继承自

mx.controls.Control.setBorder

setBottom(p_bottom) 方法

设置 bottom 字段的值。

参数

p_bottom
控件的下边界与父容器下边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setBottom

setCss(p_css) 方法

设置 css 字段的值。

参数

p_css
一个 JSON 对象，表示控件的 CSS 样式。

继承自

mx.controls.Control.setCss

setCssClass(p_cssClass) 方法

设置 cssClass} 字段的值

参数

p_cssClass
一个String 对象，样式classname

继承自

mx.controls.Control.setCssClass

setDisplay(p_display) 方法

设置 display 字段的值。

参数

p_display
css 样式的 display 属性。

继承自

mx.controls.Control.setDisplay

setEnabled(p_enabled) 方法

设置 enabled 字段的值。

参数

p_enabled

继承自

mx.controls.Control.setEnabled

setHeight(p_height) 方法

设置 height 字段的值。

参数

p_height
控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。

继承自

mx.controls.Control.setHeight

setLeft(p_left) 方法

设置 left 字段的值。

参数

p_left
控件的左边界与父容器左边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setLeft

setPadding(p_padding) 方法

设置控件的内边距。

参数

p_padding
css 样式的 padding 属性。

继承自

mx.containers.Container.setPadding

setPosition(p_position) 方法

设置 position 字段的值。

参数

p_position
一个字符串，表示 css 样式的 position 属性。

继承自

mx.controls.Control.setPosition

setRight(p_right) 方法

设置 right 字段的值。

参数

p_right
控件的右边界与父容器右边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setRight

setTop(p_top) 方法

设置 top 字段的值。

参数

p_top
控件的上边界与父容器上边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。

继承自

mx.controls.Control.setTop

setVisible(p_visible) 方法

设置 visible 字段的值。

参数

p_visible
一个 Boolean 值，表示控件是否可见。

继承自

mx.controls.Control.setVisible

setWidth(p_width) 方法

设置 width 字段的值。

参数

p_width
控件的高度,可以是数字（如 500）、字符串（如“500px”或“50%”）.

继承自

mx.controls.Control.setWidth

show() 方法

显示控件，设置控件可见。

继承自

mx.controls.Control.show

$(p_expression) 方法

该方法与 me.$e.find(p_expression) 等同。

参数

p_expression

继承自

mx.controls.Control.$

$wrap([p_obj]) 方法

返回一个 JQuery 对象。

参数

p_obj
可选的。默认值为“me.$e”。一个 JQuery 对象，或继承自 Control 的控件，或字符串，或 HTML DOM 元素。如果参数为 JQuery 对象，则返回本身；如果参数为继承自 Control 的控件，则返回控件的 $e 对象；如果参数为字符串，则返回以字符串为选择器的 JQuery 对象；如果参数为空，则返回控件本身的 $e 对象。