全称 mx.datacontrols.PageNaviBar
命名空间 mx.datacontrols
类 PageNaviBar
继承层次结构 PageNaviBarControl
源文件 ~\mx\scripts\datacontrols\PageNaviBar.js
提供一个分页工具条，它要和 PagedControl 配合使用。帮助有需要进行分页的控件实现分页。

构造函数

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

初始化函数

名称 说明
init()

方法

名称 说明
contains($p_target) 返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
dispose() 释放对象运行时动态生成的内容（属性、方法、事件）。
getContext() 获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。
getEl() 获取控件容器对应的 HTML DOM 元素对象。
getPageSizeEditor() 获取分页大小设置编辑器。
hide() 隐藏控件，设置控件不可见。
moveTo(p_left, p_top) 移动控件到指定位置。
refresh()
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) 设置控件的内边距。
setPageIndex(p_pageIndex) 设置pageIndex 字段的值
setPageSize(p_pageSize) 设置 pageSize 字段的值，同时更新 {@link mx.dataControls.PagedControl.pageSize} 字段的值。
setPosition(p_position) 设置 position 字段的值。
setRight(p_right) 设置 right 字段的值。
setTop(p_top) 设置 top 字段的值。
setTotalPageNum(p_totalPageNum) 设置totalPageNum 字段的值
setTotalRowNum(p_totalRowNum) 设置totalRowNum 字段的值
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 方法设置该字段的值。
cssClass 指定css伪类名称，设置控件显示样式
display 获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。 方法设置该字段的值。
displayPageIndex 一个 Boolean 值，表示是否显示跳转到某一页的输入框。
displayPageInfo 一个 Boolean 值，表示是否显示分页信息的文本框。
displayPageSize 一个 Boolean 值，表示是否显示每页大小选择器。
displayRefreshButton 一个 Boolean 值，表示是否显示刷新按钮
enabled 获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。 请使用 setEnabled 方法设置该字段的值。
eTag 获取控件的标签。
height 参见 Control 的 Control.height;
layoutConfigs 获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
left 获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
padding 获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
pageIndex 一个 Number 值，表示当前第几页。
pageSize 一个 Number 值，表示每页大小。
parent 获取控件所属的父对象。
permissionID 获取或设置一个字符串，表示控件的权限标识。
position 获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition 方法设置该字段的值。

该字段的可选值包括:

  • static
  • relative
  • absolute
  • fixed
right 获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
top 获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
totalPageNum 一个 Number 值，表示总页数。
totalRowNum 一个 Number 值，表示总记录数。
visible 获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。
width 参见 Control 的 Control.width;
$e 获取该控件的占位符，该占位符为一个 JQuery 对象。
$firstPageButton 跳转到第一页的按钮的 Jquery 对象。
$lastPageButton 跳转到最后一页的按钮的 Jquery 对象。
$nextPageButton 跳转到下一页的按钮的 Jquery 对象。
$pageInfo 显示分页信息的文本框的 Jquery 对象
$pageSizeSelected 每页大小的选择器的 Jquery 对象
$previousPageButton 跳转到上一页的按钮的 Jquery 对象。
$refreshButton 刷新按钮的 Jquery 对象。

构造函数详细信息

PageNaviBar() 方法

构建 PageNaviBar 类的新实例。

初始化函数详细信息

init() 方法

继承自

mx.controls.Control.init

方法详细信息

contains($p_target) 方法

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

参数

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

继承自

mx.controls.Control.contains

dispose() 方法

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

继承自

mx.controls.Control.dispose

getContext() 方法

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

继承自

mx.controls.Control.getContext

getEl() 方法

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

继承自

mx.controls.Control.getEl

getPageSizeEditor() 方法

获取分页大小设置编辑器。

hide() 方法

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

继承自

mx.controls.Control.hide

moveTo(p_left, p_top) 方法

移动控件到指定位置。

参数

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

继承自

mx.controls.Control.moveTo

refresh() 方法

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.controls.Control.setPadding

setPageIndex(p_pageIndex) 方法

设置pageIndex 字段的值

参数

  • p_pageIndex
    一个 Number 值，表示当前第几页。

setPageSize(p_pageSize) 方法

设置 pageSize 字段的值，同时更新 {@link mx.dataControls.PagedControl.pageSize} 字段的值。

参数

  • p_pageSize
    一个 Number 值，表示每页的大小。

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

setTotalPageNum(p_totalPageNum) 方法

设置totalPageNum 字段的值

参数

  • p_totalPageNum
    一个 Number 值，表示总分页数。

setTotalRowNum(p_totalRowNum) 方法

设置totalRowNum 字段的值

参数

  • p_totalRowNum
    一个 Number 值，表示总记录数。

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

继承自

mx.controls.Control.$wrap

字段详细信息

alias 字段

获取或设置一个字符串，表示控件的别名。

继承自

mx.controls.Control.alias

border 字段

获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。

继承自

mx.controls.Control.border

bottom 字段

获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。

继承自

mx.controls.Control.bottom

cssClass 字段

指定css伪类名称，设置控件显示样式

继承自

mx.controls.Control.cssClass

display 字段

获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。 方法设置该字段的值。

继承自

mx.controls.Control.display

displayPageIndex 字段

一个 Boolean 值，表示是否显示跳转到某一页的输入框。

默认值

true

displayPageInfo 字段

一个 Boolean 值，表示是否显示分页信息的文本框。

默认值

true

displayPageSize 字段

一个 Boolean 值，表示是否显示每页大小选择器。

默认值

true

displayRefreshButton 字段

一个 Boolean 值，表示是否显示刷新按钮

默认值

true

enabled 字段

获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。 请使用 setEnabled 方法设置该字段的值。

继承自

mx.controls.Control.enabled

默认值

true

eTag 字段

获取控件的标签。

继承自

mx.controls.Control.eTag

默认值

<div/>

height 字段

参见 Control 的 Control.height;

继承自

mx.controls.Control.height

默认值

25

layoutConfigs 字段

获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。

继承自

mx.controls.Control.layoutConfigs

left 字段

获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。

继承自

mx.controls.Control.left

padding 字段

获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。

继承自

mx.controls.Control.padding

pageIndex 字段

一个 Number 值，表示当前第几页。

默认值

1

pageSize 字段

一个 Number 值，表示每页大小。

默认值

20

parent 字段

获取控件所属的父对象。

继承自

mx.controls.Control.parent

permissionID 字段

获取或设置一个字符串，表示控件的权限标识。

继承自

mx.controls.Control.permissionID

position 字段

获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition 方法设置该字段的值。

该字段的可选值包括:

  • static
  • relative
  • absolute
  • fixed

继承自

mx.controls.Control.position

right 字段

获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。

继承自

mx.controls.Control.right

top 字段

获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。

继承自

mx.controls.Control.top

totalPageNum 字段

一个 Number 值，表示总页数。

默认值

1

totalRowNum 字段

一个 Number 值，表示总记录数。

默认值

0

visible 字段

获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。

继承自

mx.controls.Control.visible

默认值

true

width 字段

参见 Control 的 Control.width;

继承自

mx.controls.Control.width

默认值

100%

$e 字段

获取该控件的占位符，该占位符为一个 JQuery 对象。

继承自

mx.controls.Control.$e

$firstPageButton 字段

跳转到第一页的按钮的 Jquery 对象。

$lastPageButton 字段

跳转到最后一页的按钮的 Jquery 对象。

$nextPageButton 字段

跳转到下一页的按钮的 Jquery 对象。

$pageInfo 字段

显示分页信息的文本框的 Jquery 对象

$pageSizeSelected 字段

每页大小的选择器的 Jquery 对象

$previousPageButton 字段

跳转到上一页的按钮的 Jquery 对象。

$refreshButton 字段

刷新按钮的 Jquery 对象。