DataGridSearchBox 类

全称	mx.datacontrols.DataGridSearchBox
命名空间	mx.datacontrols
类	DataGridSearchBox
继承层次结构	DataGridSearchBoxControl
源文件	~\mx\scripts\datacontrols\DataGridSearchBox.js

提供一个查询框，它要和 PagedControl 配合使用。帮助有需要进行查询的的表格控件实现查询功能。

构造函数

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

初始化函数

名称	说明
init()	设置存储自定义高级查询过滤条件的数组。

方法

名称	说明
addJsonFilter(p_fieldName, p_operator, p_value, p_junction, p_colJunction)	添加组合查询过滤条件，需要在加载数据前调用。
appendField(p_field)	添加一个查询字段。
contains($p_target)	返回一个 Boolean 值，该值表示控件的容器中是否包含该 JQuery 对象。
dispose()	释放对象运行时动态生成的内容（属性、方法、事件）。
getContext()	获取控件当前所属 Weblet 的上下文信息（ WebletContext 类型）。
getEl()	获取控件容器对应的 HTML DOM 元素对象。
getHeight()	获取查询框的高度。
getJsonSearchParam()
getSearchParam()	获取查询参数，是由需要查询的参数拼成的字符串，如 key1=value1&key2=value2。
hide()	隐藏控件，设置控件不可见。
moveTo(p_left, p_top)	移动控件到指定位置。
reset()	提供一个方法，重置所有查询条件。
resizeTo(p_width, p_height)	重设控件的大小。
setBorder(p_border)	设置控件的边框样式。
setBottom(p_bottom)	设置 bottom 字段的值。
setContainer(p_container)	设置包含DataGridSearchBox的容器，默认为与之关联的表格控件。
setCss(p_css)	设置 css 字段的值。
setCssClass(p_cssClass)	设置 cssClass} 字段的值
setDisplay(p_display)	设置 display 字段的值。
setEnabled(p_enabled)	设置 enabled 字段的值。
setFields()	设置查询参数。
setFieldVisible(p_fieldName, p_visible)	设置字段的可见性。
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()	显示控件，设置控件可见。
toggleShowState([p_isHidden])	切换查询框的显示状态。
$(p_expression)	该方法与 me.$e.find(p_expression) 等同。
$wrap([p_obj])	返回一个 JQuery 对象。
_updateEditor()	受保护的。

字段

名称	说明
alias	获取或设置一个字符串，表示控件的别名。
allowHiding	获取和设置查询框是否可以隐藏。
border	获取控件的边框样式。如“1px solid red”，表示边框的样式为 1 像素红色的实线。请使用 setBorder 方法设置该字段的值。
bottom	获取控件的下边界与父容器下边界的像素距离。请使用 setBottom 方法设置该字段的值。
buttons	获取一个集合，包含查询框中所有的扩展的按钮（Button）。
buttonWidth
captionColumnWidth	获取标题列的宽度。
container	包含自身的容器，是一个Container实例
cssClass	指定css伪类名称，设置控件显示样式
display	获取控件的显示样式值。如“none”，表示隐藏控件； “block”表示强制作为块对象呈递。请使用 setDisplay。注：该"block"值不能在ComplexGrid控件中使用。方法设置该字段的值。
displayButton	获取或设置一个 Boolean 值，表示查询按钮和重置按钮是否显示。
editors	获取一个集合，包含查询框中所有的编辑器（Editor）。
enabled	获取控件是否可以对用户交互作出响应。如果该值为 true，则表示控件可以对用户交互作出响应；反之则不能。请使用 setEnabled 方法设置该字段的值。
eTag	获取控件的标签。
fields	获取一个集合，包含控件中显示的所要显示的查询项的集合。
height	获取控件的高度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setHeight 方法设置该字段的值。
initHidden	获取和设置查询框是否初始化时隐藏。
isAdvance	获取或设置是否使用高级查询功能。
itemNumOfRow	获取和设置查询框每行显示的查询项个数。
layoutConfigs	获取或者设置一个 JSON 对象，该属性表示控件在父容器中的布局配置参数。该属性只有在控件父容器运用布局器才会生效。
left	获取控件的左边界与父容器左边界的像素距离。请使用 setLeft 方法设置该字段的值。
padding	获取控件的内边距。如“4px”表示上下左右的内边距均为 4 像素； “4px 2px 3px 1px”则表示上边距为 4 像素，右边距为 2 像素，下边距为 3 像素，左边距为 1 像素。请使用 setPadding 方法设置该字段的值。
pagedControl	获取和设置查询框所属的 PagedControl 对象。
parent	获取控件所属的父对象。
permissionID	获取或设置一个字符串，表示控件的权限标识。
position	获取控件位置样式值。如“static”，表示无特殊定位，对象遵循 HTML 定位规则。请使用 setPosition 方法设置该字段的值。该字段的可选值包括: static relative absolute fixed
resetButton	获取或设置一个 Button 对象，表示查询框的重置按钮。
right	获取控件的右边界与父容器右边界的像素距离。请使用 setRight 方法设置该字段的值。
searchButton	获取或设置一个 Button 对象，表示查询框的查询按钮。
sqlInjectionCheck	获取或设置一个 Boolean 值，表示是否对查询框中输入的文本做sql注入检查。默认检查
top	获取控件的上边界与父容器上边界的像素距离。请使用 setTop 方法设置该字段的值。
visible	获取一个 Boolean 值，表示控件是否可见。如果该值为 true，则表示控件可见；反之则不可见。请使用 setVisible 方法设置该字段的值。
width	获取控件的宽度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setWidth 方法设置该字段的值。
$e	获取该控件的占位符，该占位符为一个 JQuery 对象。

事件

名称	说明
onfieldadd	添加一个查询字段后触发事件。
onsearching	在点击查询按钮时触发。
onsearchparamchanged	在搜索条件改变时触发。

构造函数详细信息

DataGridSearchBox() 方法

构建 DataGridSearchBox 类的新实例。

初始化函数详细信息

init() 方法

设置存储自定义高级查询过滤条件的数组。

继承自

mx.controls.Control.init

方法详细信息

addJsonFilter(p_fieldName, p_operator, p_value, p_junction, p_colJunction) 方法

添加组合查询过滤条件，需要在加载数据前调用。

参数

p_fieldName
一个字符串，表示查询条件的字段信息。
p_operator
一个字符串，表示查询条件的操作符信息。
该参数可选的值包括以下内容。
- ^ 表示‘包含’
- * 表示‘开始包含’
- & 表示‘结尾包含’
- <> 表示‘不等于’
- = 表示‘等于’
- >= 表示‘大于等于’
- <= 表示‘小于等于’
p_value
一个字符串，表示查询条件的字段的值信息。
p_junction
一个字符串，表示列内的关系运算符信息。
p_colJunction
一个字符串，表示列之间的关系运算符信息。
参数 p_junction、p_colJunction 可选的值包括以下内容。
- and 表示‘并且’
- or 表示‘或者’

appendField(p_field) 方法

添加一个查询字段。

参数

p_field
一个 JSON 对象，该对象表示查询字段的属性。例如： { name: "age", caption: "年龄", editorType："NumberEditor"}。

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

getHeight() 方法

获取查询框的高度。

getJsonSearchParam() 方法

getSearchParam() 方法

获取查询参数，是由需要查询的参数拼成的字符串，如 key1=value1&key2=value2。

hide() 方法

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

继承自

mx.controls.Control.hide

moveTo(p_left, p_top) 方法

移动控件到指定位置。

参数

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

继承自

mx.controls.Control.moveTo

reset() 方法

提供一个方法，重置所有查询条件。

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

setContainer(p_container) 方法

设置包含DataGridSearchBox的容器，默认为与之关联的表格控件。

参数

p_container
一个mx.containers.Container对象

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

setFields() 方法

设置查询参数。

setFieldVisible(p_fieldName, p_visible) 方法

设置字段的可见性。

参数

p_fieldName
字段名称。
p_visible
一个 Boolean 值。

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

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

toggleShowState([p_isHidden]) 方法

切换查询框的显示状态。

参数

p_isHidden
可选的。默认值为“null”。一个 Boolean 值，如果为 true,表示显示查询框，反之表示隐藏查询框。null 表示切换到相反状态。

$(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

_updateEditor() 方法

受保护的。

字段详细信息

alias 字段

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

继承自

mx.controls.Control.alias

allowHiding 字段

获取和设置查询框是否可以隐藏。

默认值

true

border 字段

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

继承自

mx.controls.Control.border

bottom 字段

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

继承自

mx.controls.Control.bottom

buttons 字段

获取一个集合，包含查询框中所有的扩展的按钮（Button）。

集合

该字段是一个集合数组字段。集合中成员的类型为 mx.controls.Button。

集合索引

按钮的标识或按钮在集合中的序号（从 0 开始计数）。

buttonWidth 字段

captionColumnWidth 字段

获取标题列的宽度。

默认值

100

container 字段

包含自身的容器，是一个Container实例

cssClass 字段

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

继承自

mx.controls.Control.cssClass

display 字段

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

继承自

mx.controls.Control.display

displayButton 字段

获取或设置一个 Boolean 值，表示查询按钮和重置按钮是否显示。

editors 字段

获取一个集合，包含查询框中所有的编辑器（Editor）。

集合

该字段是一个集合数组字段。集合中成员的类型为 mx.editors.Editor。

集合索引

编辑器的标识或编辑器在集合中的序号（从 0 开始计数）。

enabled 字段

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

继承自

mx.controls.Control.enabled

默认值

true

eTag 字段

获取控件的标签。

继承自

mx.controls.Control.eTag

默认值

<div/>

fields 字段

获取一个集合，包含控件中显示的所要显示的查询项的集合。

height 字段

获取控件的高度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setHeight 方法设置该字段的值。

继承自

mx.controls.Control.height

默认值

auto

initHidden 字段

获取和设置查询框是否初始化时隐藏。

默认值

false

isAdvance 字段

获取或设置是否使用高级查询功能。

默认值

false

itemNumOfRow 字段

获取和设置查询框每行显示的查询项个数。

默认值

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

pagedControl 字段

获取和设置查询框所属的 PagedControl 对象。

parent 字段

获取控件所属的父对象。

继承自

mx.controls.Control.parent

permissionID 字段

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

继承自

mx.controls.Control.permissionID

position 字段

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

该字段的可选值包括:

static
relative
absolute
fixed

继承自

mx.controls.Control.position

resetButton 字段

获取或设置一个 Button 对象，表示查询框的重置按钮。

right 字段

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

继承自

mx.controls.Control.right

searchButton 字段

获取或设置一个 Button 对象，表示查询框的查询按钮。

sqlInjectionCheck 字段

获取或设置一个 Boolean 值，表示是否对查询框中输入的文本做sql注入检查。默认检查

默认值

true

top 字段

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

继承自

mx.controls.Control.top

visible 字段

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

继承自

mx.controls.Control.visible

默认值

true

width 字段

获取控件的宽度。可以是数字（如 500）、字符串（如“500px”或“50%”）。请使用 setWidth 方法设置该字段的值。

继承自

mx.controls.Control.width

默认值

100%

$e 字段

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

继承自

mx.controls.Control.$e

事件详细信息

onfieldadd 事件

添加一个查询字段后触发事件。

onsearching 事件

在点击查询按钮时触发。

参数

cancel
一个 Boolean 值，表示是否中止当前的查询动作。

onsearchparamchanged 事件

在搜索条件改变时触发。