API Documentation » \FineUIPHP\UI\Grid\Grid

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

添加一条新纪录

addNewRecord( $defaultRecord,  $appendToEndOrInsertIndex,  $editColumnID)

Arguments

$defaultRecord

缺省值

$appendToEndOrInsertIndex

是否添加到末尾 / 插入的位置

$editColumnID

添加后使某列处于编辑状态

向页面添加控件无关脚本

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

允许单元格编辑

allowCellEditing(boolean $value) : $this

Arguments

$value

boolean

Response

$this

允许列锁定

allowColumnLocking(boolean $value) : $this

Arguments

$value

boolean

Response

$this

允许过滤

allowFilters(boolean $value) : $this

Arguments

$value

boolean

Response

$this

允许服务器端分页

allowPaging(boolean $value) : $this

Arguments

$value

boolean

Response

$this

允许服务器端排序

allowSorting(boolean $value) : $this

Arguments

$value

boolean

Response

$this

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

anchorValue(string $value) : $this

inherited

Arguments

$value

string

Response

$this

箭头按键改变选中行和单元格

arrowKeySelection(boolean $value) : $this

Arguments

$value

boolean

Response

$this

HTML标签属性

attribute( $key,  $value) : $this

inherited

Arguments

$key

$value

Response

$this

HTML标签属性（data-tag）

attributeDataTag( $value) : $this

inherited

Arguments

$value

Response

$this

自动扩展宽度以填充剩余空间的列（ColumnID）

autoExpandColumn(string $value) : $this

Arguments

$value

string

Response

$this

是否自动滚动

autoScroll(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

单元格编辑时自动选中编辑框内的文本（默认为false）

autoSelectEditor(boolean $value) : $this

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

只能通过多选框选中行（仅在启用EnableCheckBoxSelect属性时有效）

checkBoxSelectOnly(boolean $value) : $this

Arguments

$value

boolean

Response

$this

分页前清空选中项

clearSelectionBeforePaging(boolean $value) : $this

Arguments

$value

boolean

Response

$this

排序前清空选中项

clearSelectionBeforeSorting(boolean $value) : $this

Arguments

$value

boolean

Response

$this

清空表格选中项

clearSelections()

编辑单元格时点击单元格的次数（默认为2次）

clicksToEdit(integer $value) : $this

Arguments

$value

integer

Response

$this

是否折叠

collapsed(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

添加列

columns() : $this

Response

$this

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

columnWidth(string $value) : $this

inherited

Arguments

$value

string

Response

$this

接受用户编辑单元格（同时消除编辑单元格左上方的红色提示图标）

commitChanges()

面板内容

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

行属性字段

dataAttributeFields(array $value) : $this

Arguments

$value

array

Response

$this

绑定到数据源

dataBind(boolean $keepCurrentRows = false)

Arguments

$keepCurrentRows

boolean

行数据标识字段名

dataIDField(string $value) : $this

Arguments

$value

string

Response

$this

请求网址数据源的方法（GET或者POST）

dataMethod(string $value) : $this

Arguments

$value

string

Response

$this

行数据父节点标识字段名

dataParentIDField(string $value) : $this

Arguments

$value

string

Response

$this

数据源

dataSource(array $value) : $this

Arguments

$value

array

Response

$this

行数据文本字段名

dataTextField(string $value) : $this

Arguments

$value

string

Response

$this

网址数据源

dataUrl(string $value) : $this

Arguments

$value

string

Response

$this

删除指定行

deleteRow() : string

Response

string

删除选中行

deleteSelectedRow(boolean $forceUpdate = false) : string

Arguments

$forceUpdate

boolean

是否强制更新

Response

string

为不可选择的行应用禁用样式

disableUnselectableRows(boolean $value) : $this

Arguments

$value

boolean

Response

$this

数据为空时显示在内容区域的文本，可以是HTML标签

emptyText(string $value) : $this

Arguments

$value

string

Response

$this

启用交替行显示不同的颜色

enableAlternateRowColor(boolean $value) : $this

Arguments

$value

boolean

Response

$this

启用大数据模式

enableBigData(boolean $value) : $this

Arguments

$value

boolean

Response

$this

启用大数据模式下的行数提示

enableBigDataRowTip(boolean $value) : $this

Arguments

$value

boolean

Response

$this

启用多选框

enableCheckBoxSelect(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否允许折叠

enableCollapse(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

启用表格列分隔线（默认为false）

enableColumnLines(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用列移动

enableColumnMove(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用列宽度调整

enableColumnResize(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用

enabled(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

启用自定义的圆角边框

enableFrame(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

启用表头菜单

enableHeaderMenu(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用IFrame

enableIFrame(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

启用多行选择

enableMultiSelect(boolean $value) : $this

Arguments

$value

boolean

Response

$this

点击行是否自动回发

enableRowClickEvent(boolean $value) : $this

Arguments

$value

boolean

Response

$this

取消选中行是否自动回发

enableRowDeselectEvent(boolean $value) : $this

Arguments

$value

boolean

Response

$this

双击行是否自动回发

enableRowDoubleClickEvent(boolean $value) : $this

Arguments

$value

boolean

Response

$this

启用表格行分隔线（默认为true）

enableRowLines(boolean $value) : $this

Arguments

$value

boolean

Response

$this

选中行是否自动回发

enableRowSelectEvent(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用同一分组内移动

enableSameGroupColumnMove(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用模拟树显示

enableSimulateTree(boolean $value) : $this

Arguments

$value

boolean

Response

$this

启用合计行

enableSummary(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用表格样式

enableTableStyle(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

启用表格中的文字选择

enableTextSelection(boolean $value) : $this

Arguments

$value

boolean

Response

$this

启用树表格

enableTree(boolean $value) : $this

Arguments

$value

boolean

Response

$this

启用树节点图标

enableTreeIcons(boolean $value) : $this

Arguments

$value

boolean

Response

$this

Enter键只在可编辑单元格之间导航（仅用于单元格编辑）

enterEditableCell(boolean $value) : $this

Arguments

$value

boolean

Response

$this

Enter键导航单元格（仅用于单元格编辑）

enterNavigate(boolean $value) : $this

Arguments

$value

boolean

Response

$this

Enter键Tab键行为相同（仅用于单元格编辑）

enterSameAsTab(boolean $value) : $this

Arguments

$value

boolean

Response

$this

Enter键纵向导航单元格（仅用于单元格编辑）

enterVerticalNavigate(boolean $value) : $this

Arguments

$value

boolean

Response

$this

展开所有的行扩展列

expandAllRowExpanders(boolean $value) : $this

Arguments

$value

boolean

Response

$this

默认展开全部树节点（仅用于树表格）

expandAllTreeNodes(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否展开

expanded(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

数据字段

fields(array $value) : $this

Arguments

$value

array

Response

$this

过滤数据

filteredData(string $value) : $this

Arguments

$value

string

Response

$this

通过列ID或列索引获取列实例

findColumn( $columnIdOrIndex) : \FineUIPHP\UI\Grid\GridColumn\RenderField\RenderBaseField|mixed|null

Arguments

$columnIdOrIndex

Response

\FineUIPHP\UI\Grid\GridColumn\RenderField\RenderBaseField|mixed|null

通过行序号获取行对象

findRow( $rowIndex) : mixed|null

Arguments

$rowIndex

Response

mixed|null

页面加载后立即获得焦点

focusOnPageLoad(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

成比例改变表格各列的宽度，以防止出现水平滚动条（第一次加载和之后改变表格宽度时都有效）

forceFit(boolean $value) : $this

Arguments

$value

boolean

Response

$this

getAbsoluteX

getAbsoluteX() : integer

inherited

Response

integer

getAbsoluteY

getAbsoluteY() : integer

inherited

Response

integer

获取添加一条新纪录的客户端脚本

getAddNewRecordReference( $defaultRecord,  $appendToEndOrInsertIndex,  $editColumnID = null) : string

Arguments

$defaultRecord

缺省值

$appendToEndOrInsertIndex

bool 是否添加到末尾 / int 插入的位置

$editColumnID

添加后使某列处于编辑状态

Response

string

全部的列

getAllColumns() : array

Response

array

getAllowCellEditing

getAllowCellEditing() : boolean

Response

boolean

getAllowColumnLocking

getAllowColumnLocking() : boolean

Response

boolean

getAllowFilters

getAllowFilters() : boolean

Response

boolean

getAllowPaging

getAllowPaging() : boolean

Response

boolean

getAllowSorting

getAllowSorting() : boolean

Response

boolean

getAnchorValue

getAnchorValue() : string

inherited

Response

string

getArrowKeySelection

getArrowKeySelection() : boolean

Response

boolean

getAttributeDataTag

getAttributeDataTag() : mixed|null

inherited

Response

mixed|null

getAutoExpandColumn

getAutoExpandColumn() : string

Response

string

getAutoScroll

getAutoScroll() : boolean

inherited

Response

boolean

getAutoSelectEditor

getAutoSelectEditor() : boolean

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

getCheckBoxSelectOnly

getCheckBoxSelectOnly() : boolean

Response

boolean

getClearSelectionBeforePaging

getClearSelectionBeforePaging() : boolean

Response

boolean

getClearSelectionBeforeSorting

getClearSelectionBeforeSorting() : boolean

Response

boolean

获取清空表格选中项的客户端脚本

getClearSelectionsReference() : string

Response

string

客户端脚本

getClicksToEdit

getClicksToEdit() : integer

Response

integer

getCollapsed

getCollapsed() : boolean

inherited

Response

boolean

列集合

getColumns() : \FineUIPHP\UI\Grid\GridColumn\GridColumn\GridColumnCollection

Response

\FineUIPHP\UI\Grid\GridColumn\GridColumn\GridColumnCollection

getColumnWidth

getColumnWidth() : string

inherited

Response

string

获取接受用户编辑单元格的客户端脚本（同时消除编辑单元格左上方的红色提示图标）

getCommitChangesReference() : string

Response

string

客户端脚本

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

getDataAttributeFields

getDataAttributeFields() : array

Response

array

getDataIDField

getDataIDField() : string

Response

string

getDataMethod

getDataMethod() : string

Response

string

getDataParentIDField

getDataParentIDField() : string

Response

string

getDataSource

getDataSource() : array

Response

array

getDataTextField

getDataTextField() : string

Response

string

getDataUrl

getDataUrl() : string

Response

string

获取删除的行索引列表

getDeletedList() : mixed

Response

mixed

getDisableUnselectableRows

getDisableUnselectableRows() : boolean

Response

boolean

getEmptyText

getEmptyText() : string

Response

string

getEnableAlternateRowColor

getEnableAlternateRowColor() : boolean

Response

boolean

getEnableBigData

getEnableBigData() : boolean

Response

boolean

getEnableBigDataRowTip

getEnableBigDataRowTip() : boolean

Response

boolean

getEnableCheckBoxSelect

getEnableCheckBoxSelect() : boolean

Response

boolean

getEnableCollapse

getEnableCollapse() : boolean

inherited

Response

boolean

getEnableColumnLines

getEnableColumnLines() : boolean

Response

boolean

getEnableColumnMove

getEnableColumnMove() : boolean

Response

boolean

getEnableColumnResize

getEnableColumnResize() : boolean

Response

boolean

getEnabled

getEnabled() : boolean

inherited

Response

boolean

getEnableFrame

getEnableFrame() : boolean

inherited

Response

boolean

getEnableHeaderMenu

getEnableHeaderMenu() : boolean

Response

boolean

getEnableIFrame

getEnableIFrame() : boolean

inherited

Response

boolean

getEnableMultiSelect

getEnableMultiSelect() : boolean

Response

boolean

getEnableRowClickEvent

getEnableRowClickEvent() : boolean

Response

boolean

getEnableRowDeselectEvent

getEnableRowDeselectEvent() : boolean

Response

boolean

getEnableRowDoubleClickEvent

getEnableRowDoubleClickEvent() : boolean

Response

boolean

getEnableRowLines

getEnableRowLines() : boolean

Response

boolean

getEnableRowSelectEvent

getEnableRowSelectEvent() : boolean

Response

boolean

getEnableSameGroupColumnMove

getEnableSameGroupColumnMove() : boolean

Response

boolean

getEnableSimulateTree

getEnableSimulateTree() : boolean

Response

boolean

getEnableSummary

getEnableSummary() : boolean

Response

boolean

getEnableTableStyle

getEnableTableStyle() : boolean

inherited

Response

boolean

getEnableTextSelection

getEnableTextSelection() : boolean

Response

boolean

getEnableTree

getEnableTree() : boolean

Response

boolean

getEnableTreeIcons

getEnableTreeIcons() : boolean

Response

boolean

getEnterEditableCell

getEnterEditableCell() : boolean

Response

boolean

getEnterNavigate

getEnterNavigate() : boolean

Response

boolean

getEnterSameAsTab

getEnterSameAsTab() : boolean

Response

boolean

getEnterVerticalNavigate

getEnterVerticalNavigate() : boolean

Response

boolean

getExpandAllRowExpanders

getExpandAllRowExpanders() : boolean

Response

boolean

getExpandAllTreeNodes

getExpandAllTreeNodes() : boolean

Response

boolean

getCollapsed

getExpanded() : boolean

inherited

Response

boolean

getFields

getFields() : array

Response

array

getFilteredData

getFilteredData() : array

Response

array

getFocusOnPageLoad

getFocusOnPageLoad() : boolean

inherited

Response

boolean

getForceFit

getForceFit() : boolean

Response

boolean

获取表格是否有选中项的客户端脚本

getHasSelectionReference() : string

Response

string

客户端脚本

getHeight

getHeight() : integer|null

inherited

Response

integer|null

getHidden

getHidden() : boolean

inherited

Response

boolean

getHiddenColumns

getHiddenColumns() : array

Response

array

getHideMode

getHideMode() : string

inherited

Response

string

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

getIsDatabasePaging

getIsDatabasePaging() : boolean

Response

boolean

getIsDatabaseSorting

getIsDatabaseSorting() : boolean

Response

boolean

getIsFluid

getIsFluid() : boolean

inherited

Response

boolean

getIsViewPort

getIsViewPort() : boolean

inherited

Response

boolean

getItems

getItems() : array

inherited

Response

array

getKeepCurrentSelection

getKeepCurrentSelection() : boolean

Response

boolean

getKeepPagedSelection

getKeepPagedSelection() : boolean

Response

boolean

getLayout

getLayout() : integer|null

inherited

Response

integer|null

getLayoutAfterImagesLoad

getLayoutAfterImagesLoad() : integer|null

inherited

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

getMaxPagingNumberButton

getMaxPagingNumberButton() : integer

Response

integer

getMaxWidth

getMaxWidth() : integer

inherited

Response

integer

getMinColumnWidth

getMinColumnWidth() : integer|null

Response

integer|null

getMinHeight

getMinHeight() : integer

inherited

Response

integer

getMinWidth

getMinWidth() : integer

inherited

Response

integer

获取用户修改的数据

getModifiedData() : mixed

Response

mixed

获取用户修改的行数据

getModifiedDict() : mixed

Response

mixed

getMouseWheelSelection

getMouseWheelSelection() : boolean

Response

boolean

获取新增的行数据

getNewAddedList() : mixed

Response

mixed

获取表格没有任何选中项时在父级窗口弹出提示对话框的客户端脚本

getNoSelectionAlertInParentReference( $message, string $title = '', string $icon = \FineUIPHP\StaticClass\Alert::DEFAULT_MESSAGE_BOX_ICON) : string

Arguments

$message

对话框消息

$title

string

对话框标题

$icon

string

对话框图标

Response

string

获取表格没有任何选中项时在顶级窗口弹出提示对话框的客户端脚本

getNoSelectionAlertInTopReference( $message, string $title = '', string $icon = \FineUIPHP\StaticClass\Alert::DEFAULT_MESSAGE_BOX_ICON) : string

Arguments

$message

对话框消息

$title

string

对话框标题

$icon

string

对话框图标

Response

string

获取表格没有任何选中项时在本窗口弹出提示对话框的客户端脚本

getNoSelectionAlertReference( $message, string $title = '', string $icon = \FineUIPHP\StaticClass\Alert::DEFAULT_MESSAGE_BOX_ICON) : string

Arguments

$message

对话框消息

$title

string

对话框标题

$icon

string

对话框图标

Response

string

获取组件参数值

getOption(string $optionName) : mixed

inherited

Throws	\Exception

Arguments

$optionName

string

参数名

Response

mixed

获取总页数

getPageCount() : integer

Response

integer

获取当前显示页索引

getPageIndex() : integer

Response

integer

分页工具条项集合

getPageItems() : \FineUIPHP\Base\ControlBase\ControlBaseCollection

Response

\FineUIPHP\Base\ControlBase\ControlBaseCollection

getPageSize

getPageSize() : integer

Response

integer

getPagingType

getPagingType() : string

Response

string

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

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

inherited

Arguments

$event

\FineUIPHP\Event|string

Response

string

getQuickPaging

getQuickPaging() : boolean

Response

boolean

getQuickPagingThenSelect

getQuickPagingThenSelect() : boolean

Response

boolean

getRecordCount

getRecordCount() : integer

Response

integer

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

获取拒绝用户编辑单元格的客户端脚本（同时消除编辑单元格左上方的红色提示图标）

getRejectChangesReference() : string

Response

string

获取解析后的数据源

getResolvedDataSource() : array

Response

array

getRowDataBoundFunction

getRowDataBoundFunction() : string

Response

string

获取行扩展列

getRowExpanderColumn() : null

Response

null

getRowRendererFunction

getRowRendererFunction() : string

Response

string

行数据

getRows() : \FineUIPHP\UI\Grid\GridRow\GridRowCollection

Response

\FineUIPHP\UI\Grid\GridRow\GridRowCollection

getRowVerticalAlign

getRowVerticalAlign() : string

Response

string

获取选中表格单元格的客户端脚本（仅用于AllowCellEditing模式）

getSelectCellReference( $rowIdOrRowIndex,  $columnId) : string

Arguments

$rowIdOrRowIndex

int $rowIndex / string $rowId

$columnId

Response

string

getSelectedCell

getSelectedCell() : array

Response

array

获取表格选中单元格的客户端脚本（仅用于AllowCellEditing模式）

getSelectedCellReference() : string

Response

string

客户端脚本

获取表格选中项数的客户端脚本

getSelectedCountReference() : string

Response

string

客户端脚本

getSelectedRowID

getSelectedRowID() : string

Response

string

getSelectedRowIDArray

getSelectedRowIDArray() : array|mixed

Response

array|mixed

getSelectedRowIndex

getSelectedRowIndex() : integer

Response

integer

getSelectedRowIndexArray

getSelectedRowIndexArray() : array|mixed

Response

array|mixed

getShowBorder

getShowBorder() : boolean

inherited

Response

boolean

getShowGridHeader

getShowGridHeader() : boolean

Response

boolean

getShowHeader

getShowHeader() : boolean

inherited

Response

boolean

getShowPagingMessage

getShowPagingMessage() : boolean

Response

boolean

getShowSelectedCell

getShowSelectedCell() : boolean

Response

boolean

通过列排序字段获取列实例

getSortColumn( $sortField) : mixed

Arguments

$sortField

string 排序字段

Response

mixed

列实例

getSortDirection

getSortDirection() : string

Response

string

getSortField

getSortField() : string

Response

string

获取当前分页的起始行序号（不分页或者数据库分页时，返回零）

getStartRowIndex()

getSummaryData

getSummaryData() : string

Response

string

getSummaryPosition

getSummaryPosition() : string

Response

string

getTabEditableCell

getTabEditableCell() : boolean

Response

boolean

getTableColspan

getTableColspan() : integer

inherited

Response

integer

getTableConfigColumns

getTableConfigColumns() : integer

inherited

Response

integer

getTableRowspan

getTableRowspan() : integer

inherited

Response

integer

getTabVerticalNavigate

getTabVerticalNavigate() : boolean

Response

boolean

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

getTreeColumn

getTreeColumn() : string

Response

string

getTreeExpandOnDblClick

getTreeExpandOnDblClick() : boolean

Response

boolean

getWidth

getWidth() : integer|null

inherited

Response

integer|null

控件外部容器的客户端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

隐藏的列ID列表

hiddenColumns( $value) : $this

Arguments

$value

Response

$this

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

hideMode(string $value) : $this

inherited

Arguments

$value

string

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

是否数据库分页

isDatabasePaging(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否数据库排序（仅在启用网址数据源时有效）

isDatabaseSorting(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否处于FineUI的AJAX回发过程

isFineUIAjaxPostBack() : boolean

inherited

Response

boolean

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

isFluid(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

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

isViewPort(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

子控件集合

items() : $this

inherited

Response

$this

多选时保持当前已选中行

keepCurrentSelection(boolean $value) : $this

Arguments

$value

boolean

Response

$this

多选时保持分页中已选中行

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

添加客户端事件处理函数

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

最多显示数字分页按钮的个数（默认值：5）

maxPagingNumberButton(integer $value) : $this

Arguments

$value

integer

Response

$this

最大宽度

maxWidth(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

最小列宽度

minColumnWidth(integer $value) : $this

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

鼠标滚轮改变选中行

mouseWheelSelection(boolean $value) : $this

Arguments

$value

boolean

Response

$this

noRenderTo

noRenderTo() : $this

inherited

Response

$this

折叠面板事件

OnCollapse() : $this

inherited

Response

$this

展开面板事件

OnExpand() : $this

inherited

Response

$this

过滤条件改变事件（ajax）

onFilterChanged() : \FineUIPHP\UI\Grid\Grid

Response

\FineUIPHP\UI\Grid\Grid

$this

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

onFirstPreRender()

inherited

服务端点击操作（ajax）

onPageIndexChanged() : \FineUIPHP\UI\Grid\Grid

Response

\FineUIPHP\UI\Grid\Grid

$this

行双击事件

onRowDoubleClick() : \FineUIPHP\UI\Grid\Grid

Response

\FineUIPHP\UI\Grid\Grid

$this

行延迟加载事件（仅适用于树表格）事件

onRowLazyLoad() : \FineUIPHP\UI\Grid\Grid

Response

\FineUIPHP\UI\Grid\Grid

$this

行选中事件

onRowSelect() : \FineUIPHP\UI\Grid\Grid

Response

\FineUIPHP\UI\Grid\Grid

$this

排序事件（ajax）

onSort() : \FineUIPHP\UI\Grid\Grid

Response

\FineUIPHP\UI\Grid\Grid

$this

当前显示页索引

pageIndex( $value) : $this

Arguments

$value

Response

$this

分页工具条项集合

pageItems() : $this

Response

$this

每页显示项数

pageSize(integer $value) : $this

Arguments

$value

integer

Response

$this

分页工具栏的显示类型

pagingType(string $value) : $this

Arguments

$value

string

Response

$this

是否启用快速翻页功能（上下按键或者鼠标滚轮改变选中行）

quickPaging(boolean $value) : $this

Arguments

$value

boolean

Response

$this

快速翻页后自动选中第一行或者最后一行

quickPagingThenSelect(boolean $value) : $this

Arguments

$value

boolean

Response

$this

总记录数

recordCount(integer $value) : $this

Arguments

$value

integer

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

拒绝用户编辑单元格（同时消除编辑单元格左上方的红色提示图标）

rejectChanges()

删除CSS样式

removeStartupCSS( $key)

inherited

Arguments

$key

解析IFrame地址

resolveIFrameUrl( $url) : mixed|string

inherited

Arguments

$url

Response

mixed|string

当前分页的开始行和结束行

resolveStartEndRowIndex( &$startRowIndex,  &$endRowIndex)

Arguments

$startRowIndex

$endRowIndex

自定义行数据绑定函数（JavaScript函数）

rowDataBoundFunction(string $value) : $this

Arguments

$value

string

Response

$this

自定义行渲染器函数（JavaScript函数）（推荐使用RowDataBoundFunction属性）

rowRendererFunction(string $value) : $this

Arguments

$value

string

Response

$this

行中文字的垂直排列位置（默认为Middle）

rowVerticalAlign(string $value) : $this

Arguments

$value

string

Response

$this

选中的单元格（[行ID,列ID]）

selectedCell( $value) : $this

Arguments

$value

Response

$this

选中的行ID

selectedRowID( $value) : $this

Arguments

$value

Response

$this

选中的行ID列表

selectedRowIDArray( $value) : $this

Arguments

$value

Response

$this

选中行的索引（列表中的第一项）

selectedRowIndex( $value) : $this

Arguments

$value

Response

$this

选中行的索引列表

selectedRowIndexArray( $value) : $this

Arguments

$value

Response

$this

setHandler

setHandler(string $handler) : void

inherited

Arguments

$handler

string

是否显示边框

showBorder(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

显示表格表头

showGridHeader(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否显示标题栏

showHeader(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

显示分页工具条右侧的分页信息

showPagingMessage(boolean $value) : $this

Arguments

$value

boolean

Response

$this

高亮显示选中的单元格

showSelectedCell(boolean $value) : $this

Arguments

$value

boolean

Response

$this

排序方向("ASC", "DESC")

sortDirection(string $value) : $this

Arguments

$value

string

Response

$this

排序字段

sortField(string $value) : $this

Arguments

$value

string

Response

$this

合计行数据

summaryData(string $value) : $this

Arguments

$value

string

Response

$this

合计行的位置

summaryPosition(string $value) : $this

Arguments

$value

string

Response

$this

Tab键只在可编辑单元格之间导航（仅用于单元格编辑）

tabEditableCell(boolean $value) : $this

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

Tab键纵向导航单元格（仅用于单元格编辑）

tabVerticalNavigate(boolean $value) : $this

Arguments

$value

boolean

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

显示树状层级的列（ColumnID）

treeColumn(string $value) : $this

Arguments

$value

string

Response

$this

双击展开树节点

treeExpandOnDblClick(boolean $value) : $this

Arguments

$value

boolean

Response

$this

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

triggerAjaxPreRenderEvent()

inherited

更新可编辑单元格值

updateCellValue()

当在客户端修改了模板列中的值，调用此函数来告诉表格控件需要更新这些值；如果对表格重新进行了数据绑定，则不需要调用此函数，因为重新绑定后会更新表格的全部内容

updateTemplateFields()

宽度

width(integer $value) : $this

inherited

Arguments

$value

integer

Response

$this

是否添加 f-inline-block 样式

wrapperNodeInlineBlock( $value) : $this

inherited

Arguments

$value

Response

$this

TEMPLATE_PLACEHOLDER_PREFIX

TEMPLATE_PLACEHOLDER_PREFIX

是否向页面输出控件的外部容器（默认：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

Grid

Methods

构造函数

魔术方法

Arguments

$name

Response

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

Response

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

Arguments

$value

Response

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

Arguments

$value

Response

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

添加一条新纪录

Arguments

$defaultRecord

$appendToEndOrInsertIndex

$editColumnID

向页面添加控件无关脚本

Arguments

$script

$level

添加CSS样式

Arguments

$key

$cssContent

添加控件相关脚本

Arguments

$scriptContent

允许单元格编辑

Arguments

$value

Response

允许列锁定

Arguments

$value

Response

允许过滤

Arguments

$value

Response

允许服务器端分页

Arguments

$value

Response

允许服务器端排序

Arguments

$value

Response

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

Arguments

$value

Response

箭头按键改变选中行和单元格

Arguments

$value

Response

HTML标签属性

Arguments

$key

$value

Response

HTML标签属性（data-tag）

Arguments

$value

Response

自动扩展宽度以填充剩余空间的列（ColumnID）

Arguments

$value

Response

是否自动滚动

Arguments

$value

Response

单元格编辑时自动选中编辑框内的文本（默认为false）

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