DockPanel 类

[方法]、 [字段]、 [事件]

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

提供一个可以停靠在上下左右位置的面板，它要和 DockPage 配合使用。

示例 1

以下是一个创建 DockPanel 的示例。该示例将说明如何创建一个停靠在左边的 DockPanel。

JavaScript 代码
`var dockPanel = new mx.containers.DockPanel({dockPosition:"left"}); // 将一个 dockPage 加到 {@link mx.containers.DockPanel} 中。 var dockPage = new mx.containers.DockPage({ name: "dockPage_left", text: "工具箱", imageKey:"save", dockPosition:"left" // 指定显示位置 }); dockPanel.appendPage(dockPage);`

构造函数

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

初始化函数

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

方法

名称	说明
addControl(p_control, p_page)	向指定的 DockPage 添加 Control。
addControls(p_controls, p_page)	将一组 Control 对象添加到集合 controls 中。
append($p_obj, p_page)	向容器中添加内容。如果设置p_page参数的话会向指定DockPage中添加内容。
appendPage(p_name, p_text)	向 DockPanel 的页面集合（pages）中添加新页面，并返回该 DockPage 对象。
appendPages(p_pages)	向 DockPanel 的页面集合（pages）中添加一组页面。
clear()	容器的dispose方法
contains($p_target)	返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
dispose()	释放对象运行时动态生成的内容（属性、方法、事件）。
findControl(p_alias)	根据指定的控件属性及属性值查找当前视图中对应的控件。如果仅传入一个参数，则默认将该参数作为别名的值进行查找。 @overload function(p_alias) @param p_alias 一个字符串，表示控件的别名。 @overload function(p_attrName, p_attrValue) @param p_attrName 一个字符串，表示控件的属性名。 @param p_attrValue 一个字符串，表示控件的属性值。
findControl(p_attrName, p_attrValue)	根据指定的控件属性及属性值查找当前视图中对应的控件。如果仅传入一个参数，则默认将该参数作为别名的值进行查找。 @overload function(p_alias) @param p_alias 一个字符串，表示控件的别名。 @overload function(p_attrName, p_attrValue) @param p_attrName 一个字符串，表示控件的属性名。 @param p_attrValue 一个字符串，表示控件的属性值。
findControlByPermissionID(p_permissionID)	根据指定的权限标识查找当前视图中对应的控件。
getContext()	获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。
getEl()	获取控件容器对应的 HTML DOM 元素对象。
hide()	隐藏控件，设置控件不可见。
hidePage(p_page)	隐藏 pages 页面集合中的指定页。
moveTo(p_left, p_top)	移动控件到指定位置。@param p_left 一个数字，表示 css 样式的 left 属性。 @param p_top 一个数字，表示 css 样式的 top 属性。
removeControl(p_control, p_deep)	参见 Container.removeControl 方法。
resizeTo(p_width, p_height)	重设控件的大小。@param p_width 控件的宽度，可以是数字（如 100），也可以是字符串（如 “100%”）。 @param p_height 控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。
selectPage(p_page, [p_triggerEvent])	选择并显示 pages 页面集合中的指定页。
setBorder(p_border)	设置控件的边框样式。@param p_border 一个字符串，表示css样式的 border 属性。
setBottom(p_bottom)	设置 bottom 字段的值。@param p_bottom 控件的下边界与父容器下边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。
setCss(p_css)	设置 css 字段的值。 @param p_css 一个 JSON 对象，表示控件的 CSS 样式。
setCssClass(p_cssClass)	设置 cssClass 字段的值 @param p_cssClass 一个String 对象，样式classname
setDisplay(p_display)	设置 display 字段的值。@param p_display css 样式的 display 属性。
setDockMode(p_dockMode)	设置 dockMode 字段。
setEnabled(p_enabled)	设置 enabled 字段的值。
setHeight(p_height)	设置 height 字段的值。注：子类UploadControl上传控件不支持百分比设置高度 @param p_height 控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。
setLeft(p_left)	设置 left 字段的值。 @param p_left 控件的左边界与父容器左边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。
setPadding(p_padding)	设置控件的内边距。 {@excude mx.containers.Wizard}
setPosition(p_position)	设置 position 字段的值。@param p_position 一个字符串，表示 css 样式的 position 属性。
setRight(p_right)	设置 right 字段的值。@param p_right 控件的右边界与父容器右边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。
setSpeed(p_speed)	设置 speed 字段的值。
setTop(p_top)	设置 top 字段的值。 @param p_top 控件的上边界与父容器上边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。
setVisible(p_visible)	设置 visible 字段的值。@param p_visible 一个 Boolean 值，表示控件是否可见。
setWidth(p_width)	设置 width 字段的值。@param p_width 控件的高度,可以是数字（如 500）、字符串（如“500px”或“50%”）.
show()	显示控件，设置控件可见。
$(p_expression)	该方法与 me.$e.find(p_expression) 等同。
$wrap([p_obj])	返回一个 JQuery 对象。

字段

名称	说明
alias	获取或设置一个字符串，表示控件的别名。
border	获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。
bottom	获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。
contextMenu	获取或设置容器的上下文菜单。@default null
controls	获取容器包含的控件集合。集合中的单个控件也可能是一个容器。请使用 addControl 和 removeControl 方法向集合中添加或移除控件。
cssClass	指定css伪类名称，设置控件显示样式
display	获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay方法设置该字段的值。
dockMode	获取或设置面板的停靠模式。该字段可选的值包括： dockable - 停靠 autoHide - 自动隐藏
dockPosition	获取或设置面板的停靠位置。该字段可选的值包括： left top right bottom
enableBrowserContextMenu	获取或初始化设置是否允许浏览器默认的上下文菜单。
enabled	获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。请使用 setEnabled 方法设置该字段的值。@default true
eTag	获取控件的标签。
height	请参见 Control.height 字段。
layoutConfigs	获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
left	获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
padding	获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
pages	获取一个集合，包含容器中所有的页（DockPage 类型）。
parent	获取控件所属的父对象。
permissionID	获取或设置一个字符串，表示控件的权限标识。
position	请参见 Control.position 字段。
right	获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
selection	获取一个对象，表示 DockPanel 中当前显示的页（DockPage 类型）。
speed	获取或设置 DockPage 页面在切换时的速度，可以是字符串（“normal，"fast"，”slow“），或是数字，表示切换时的时间毫秒数。请使用 setSpeed 方法设置改值。
top	获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
visible	获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。@default true
width	请参见 Control.width 字段。
$buttonContainer	表示容器所包含的所有页面对应的控制按钮的容器的 JQuery 对象。
$container	获取容器控件中用来包含控件 DOM 元素的占位符。
$e	获取该控件的占位符，该占位符为一个 JQuery 对象。

事件

名称	说明
onclosed	当dockPage关闭时触发
oncontextmenu	在弹出上下之前执行传入执行方法中参数为 {cancel:false,event:e}; cancel如果为true会中断默认逻辑的执行，event为事件参数
onctrladded	当添加控件到容器后，将触发该事件。
onctrlremoved	当从容器移除控件后，将触发该事件。
ondockmodechanged	当dockMode 改变时触发调用setDockMode方法会触发此事件
onopened	当dockPage展开时触发
onselectionchanged	当控件的显示页发生改变后，将触发该事件。调用 selectPage(p_page, true) 方法后会触发该事件。
onselectionchanging	当控件的显示页发生改变的时候，将触发该事件。调用 selectPage 方法时会触发该事件。

构造函数详细信息

DockPanel() 方法

构建 DockPanel 类的新实例。

初始化函数详细信息

init() 方法

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

继承自

mx.containers.Container.init

方法详细信息

addControl(p_control, p_page) 方法

向指定的 DockPage 添加 Control。

参数

p_control
一个 Control 对象。
p_page
一个 DockPage 对象在 pages中的索引值或者 DockPage.name属性值。

继承自

mx.containers.Container.addControl

addControls(p_controls, p_page) 方法

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

参数

p_controls
一个 Control 控件数组。
p_page
一个 DockPage 对象在 pages中的索引值或者 DockPage.name属性值。

继承自

mx.containers.Container.addControls

append($p_obj, p_page) 方法

向容器中添加内容。如果设置p_page参数的话会向指定DockPage中添加内容。

参数

$p_obj
一个 JQuery 对象，或一个控件（包含 $container 容器），或一个 HTML DOM 元素。
p_page
一个 DockPage 对象或者对象在 pages中的索引值或者 DockPage.name属性值。

继承自

mx.containers.Container.append

appendPage(p_name, p_text) 方法

向 DockPanel 的页面集合（pages）中添加新页面，并返回该 DockPage 对象。

参数

p_name
一个字符串或是 DockPage 类型的对象，如果是字符串表示该页的名称，对应 DockPage 的 DockPage.name 字段.也是所有页的唯一标识，必须唯一。
p_text
一个字符串，表示该页的按钮上显示的文本。

appendPages(p_pages) 方法

向 DockPanel 的页面集合（pages）中添加一组页面。

参数

p_pages
一个数组，该数组包含了一组 DockPage 对象。

clear() 方法

容器的dispose方法

继承自

mx.containers.Container.clear

contains($p_target) 方法

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

参数

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

继承自

mx.controls.Control.contains

dispose() 方法

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

继承自

mx.containers.Container.dispose

findControl(p_alias) 方法

根据指定的控件属性及属性值查找当前视图中对应的控件。如果仅传入一个参数，则默认将该参数作为别名的值进行查找。 @overload function(p_alias) @param p_alias 一个字符串，表示控件的别名。 @overload function(p_attrName, p_attrValue) @param p_attrName 一个字符串，表示控件的属性名。 @param p_attrValue 一个字符串，表示控件的属性值。

参数

p_alias
一个字符串，表示控件的别名。

继承自

mx.containers.Container.findControl

findControl(p_attrName, p_attrValue) 方法

参数

p_attrName
一个字符串，表示控件的属性名。
p_attrValue
一个字符串，表示控件的属性值。 {@exclude mx.datacontrols.DynamicForm}

继承自

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

hidePage(p_page) 方法

隐藏 pages 页面集合中的指定页。

参数

p_page
一个数字（如 0），表示 pages 集合中页的序号；或一个字符串，表示页的唯一标识（DockPage.name 字段）；或者一个 DockPage 对象。

moveTo(p_left, p_top) 方法

移动控件到指定位置。@param p_left 一个数字，表示 css 样式的 left 属性。 @param p_top 一个数字，表示 css 样式的 top 属性。

参数

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

继承自

mx.controls.Control.moveTo

removeControl(p_control, p_deep) 方法

参见 Container.removeControl 方法。

参数

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

继承自

mx.containers.Container.removeControl

resizeTo(p_width, p_height) 方法

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

参数

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

继承自

mx.controls.Control.resizeTo

selectPage(p_page, [p_triggerEvent]) 方法

选择并显示 pages 页面集合中的指定页。

参数

p_page
一个数字（如 0），表示 pages 集合中页的序号；或一个字符串，表示页的唯一标识（DockPage.name 字段）；或者一个 DockPage 对象。
p_triggerEvent
可选的。默认值为“false”。一个 Boolean 值，表示是否要触发 onselectionchanged 事件。如果该值为 true，则触发事件；反之则不触发。

setBorder(p_border) 方法

设置控件的边框样式。@param p_border 一个字符串，表示css样式的 border 属性。

参数

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

继承自

mx.controls.Control.setBorder

setBottom(p_bottom) 方法

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

参数

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

继承自

mx.controls.Control.setBottom

setCss(p_css) 方法

设置 css 字段的值。 @param p_css 一个 JSON 对象，表示控件的 CSS 样式。

参数

p_css
一个 JSON 对象，表示控件的 CSS 样式。 {@exclude mx.datacontrols.ScrollBar}

继承自

mx.controls.Control.setCss

setCssClass(p_cssClass) 方法

设置 cssClass 字段的值 @param p_cssClass 一个String 对象，样式classname

参数

p_cssClass
一个String 对象，样式classname {@exclude mx.datacontrols.ScrollBar}

继承自

mx.controls.Control.setCssClass

setDisplay(p_display) 方法

设置 display 字段的值。@param p_display css 样式的 display 属性。

参数

p_display
css 样式的 display 属性。

继承自

mx.controls.Control.setDisplay

setDockMode(p_dockMode) 方法

设置 dockMode 字段。

参数

p_dockMode
一个字符串，表示控件的停靠模式，参加 dockMode 字段。

setEnabled(p_enabled) 方法

设置 enabled 字段的值。

参数

p_enabled

继承自

mx.controls.Control.setEnabled

setHeight(p_height) 方法

设置 height 字段的值。注：子类UploadControl上传控件不支持百分比设置高度 @param p_height 控件的高度，可以是数字（如 100），也可以是字符串（如 “100%”）。

参数

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

继承自

mx.controls.Control.setHeight

setLeft(p_left) 方法

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

参数

p_left
控件的左边界与父容器左边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。 {@exclude mx.datacontrols.ComplexForm} {@exclude mx.datacontrols.DataGridSearchBox} {@exclude mx.datacontrols.DynamicForm} {@exclude mx.datacontrols.SkinDataForm}

继承自

mx.controls.Control.setLeft

setPadding(p_padding) 方法

设置控件的内边距。 {@excude mx.containers.Wizard}

参数

p_padding
css 样式的 padding 属性。

继承自

mx.containers.Container.setPadding

setPosition(p_position) 方法

设置 position 字段的值。@param p_position 一个字符串，表示 css 样式的 position 属性。

参数

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

继承自

mx.controls.Control.setPosition

setRight(p_right) 方法

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

参数

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

继承自

mx.controls.Control.setRight

setSpeed(p_speed) 方法

设置 speed 字段的值。

参数

p_speed
一个字符串或数字，参见 speed 字段。

setTop(p_top) 方法

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

参数

p_top
控件的上边界与父容器上边界的像素距离，可以是数字（如 50），也可以是字符串（如 50%）。 {@exclude mx.datacontrols.ComplexForm} {@exclude mx.datacontrols.DataGridSearchBox} {@exclude mx.datacontrols.DynamicForm} {@exclude mx.datacontrols.SkinDataForm}

继承自

mx.controls.Control.setTop

setVisible(p_visible) 方法

设置 visible 字段的值。@param p_visible 一个 Boolean 值，表示控件是否可见。

参数

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

继承自

mx.controls.Control.setVisible

setWidth(p_width) 方法

设置 width 字段的值。@param p_width 控件的高度,可以是数字（如 500）、字符串（如“500px”或“50%”）.

参数

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 对象。