API Documentation
Back to top  

RenderField

Extends \FineUIPHP\UI\Grid\GridColumn\RenderField\RenderBaseField

表格列

package

FineUIPHP\UI\Grid\GridColumn\RenderField

Methods

构造函数

__construct()
inherited

魔术方法

__get( $name) : mixed
inherited

Arguments

$name

Response

mixed

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

__toString() : string
inherited

Response

string

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

addAjaxScript()
inherited

向页面添加控件无关脚本

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

HTML标签属性

attribute( $key,  $value) : $this
inherited

Arguments

$key

$value

Response

$this

HTML标签属性（data-tag）

attributeDataTag( $value) : $this
inherited

Arguments

$value

Response

$this

HTML标签属性

attributes(\FineUIPHP\OptionBuilder $value) : $this
inherited

Arguments

$value

\FineUIPHP\OptionBuilder

Response

$this

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

autoSelectEditor(boolean $value) : $this

Arguments

$value

boolean

Response

$this

控制子控件的尺寸（表格列使用HBox布局）

boxFlex(integer $value) : $this
inherited

Arguments

$value

integer

Response

$this

是否在客户端进行HTML编码（默认为false）

clientHtmlEncode(boolean $value) : $this

Arguments

$value

boolean

Response

$this

列ID

columnID(string $value) : $this
inherited

Arguments

$value

string

Response

$this

列顺序

columnOrder( $value) : $this
inherited

Arguments

$value

Response

$this

字段名称

dataField(string $value) : $this
inherited

Arguments

$value

string

Response

$this

此列模拟树显示时的层次字段

dataSimulateTreeLevelField(string $value) : $this

Arguments

$value

string

Response

$this

自定义编辑器获取函数（JavaScript函数）

editGetterFunction(string $value) : $this

Arguments

$value

string

Response

$this

自定义编辑器设置函数（JavaScript函数）

editSetterFunction(string $value) : $this

Arguments

$value

string

Response

$this

启用本列的单元格编辑功能

enableColumnEdit(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

启用表头菜单的隐藏列功能

enableColumnHide(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

是否启用

enabled(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

允许过滤

enableFilter(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

启用表头菜单

enableHeaderMenu(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

允许锁定

enableLock(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

是否可以改变列宽度

enableResize(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

双击展开折叠行扩展列

expandOnDblClick(boolean $value) : $this

Arguments

$value

boolean

Response

$this

回车按键展开折叠行扩展列

expandOnEnter(boolean $value) : $this

Arguments

$value

boolean

Response

$this

点击行扩展列的图标时选中行

expandToSelectRow(boolean $value) : $this

Arguments

$value

boolean

Response

$this

此列会扩展所有未使用的宽度

expandUnusedSpace(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

字段类型

fieldType(string $value) : $this

Arguments

$value

string

Response

$this

过滤

filter(\FineUIPHP\UI\Grid\GridColumn\GridFilter\GridFilter $value) : $this
inherited

Arguments

$value

\FineUIPHP\UI\Grid\GridColumn\GridFilter\GridFilter

Response

$this

getAttributeDataTag

getAttributeDataTag() : mixed|null
inherited

Response

mixed|null

getAttributes

getAttributes() : \FineUIPHP\OptionBuilder
inherited

Response

\FineUIPHP\OptionBuilder

getAutoSelectEditor

getAutoSelectEditor() : boolean

Response

boolean

getBoxFlex

getBoxFlex() : mixed
inherited

Response

mixed

getClientHtmlEncode

getClientHtmlEncode() : boolean

Response

boolean

getColumnID

getColumnID() : string
inherited

Response

string

列索引

getColumnIndex() : false|integer|string
inherited

Response

false|integer|string

getColumnOrder

getColumnOrder() : null
inherited

Response

null

getDataField

getDataField() : string
inherited

Response

string

getDataSimulateTreeLevelField

getDataSimulateTreeLevelField() : string

Response

string

getEditGetterFunction

getEditGetterFunction() : string

Response

string

单元格编辑控件

getEditor() : \FineUIPHP\UI\Grid\Editor\GridColumnEditorCollection

Response

\FineUIPHP\UI\Grid\Editor\GridColumnEditorCollection

getEditSetterFunction

getEditSetterFunction() : string

Response

string

getEnableColumnEdit

getEnableColumnEdit() : boolean
inherited

Response

boolean

getEnableColumnHide

getEnableColumnHide() : mixed
inherited

Response

mixed

getEnabled

getEnabled() : boolean
inherited

Response

boolean

getEnableFilter

getEnableFilter() : boolean
inherited

Response

boolean

getEnableHeaderMenu

getEnableHeaderMenu() : mixed
inherited

Response

mixed

getEnableLock

getEnableLock() : boolean
inherited

Response

boolean

getEnableResize

getEnableResize() : boolean
inherited

Response

boolean

getExpandOnDblClick

getExpandOnDblClick() : boolean

Response

boolean

getExpandOnEnter

getExpandOnEnter() : boolean

Response

boolean

getExpandToSelectRow

getExpandToSelectRow() : boolean

Response

boolean

getExpandUnusedSpace

getExpandUnusedSpace() : mixed
inherited

Response

mixed

getFieldType

getFieldType() : string

Response

string

getFilter

getFilter() : \FineUIPHP\UI\Grid\GridColumn\GridFilter\GridFilter
inherited

Response

\FineUIPHP\UI\Grid\GridColumn\GridFilter\GridFilter

获取表格对象

getGrid() : \FineUIPHP\UI\Grid\Grid
inherited

Response

\FineUIPHP\UI\Grid\Grid

getHeaderText

getHeaderText() : string
inherited

Response

string

getHeaderTextAlign

getHeaderTextAlign() : mixed
inherited

Response

mixed

getHeaderToolTip

getHeaderToolTip() : string
inherited

Response

string

getHeaderToolTip

getHeaderToolTipType() : string
inherited

Response

string

取得列头渲染后的HTML

getHeaderValue() : string
inherited

Response

string

getHidden

getHidden() : boolean
inherited

Response

boolean

getHideMode

getHideMode() : string
inherited

Response

string

getId

getId() : mixed
inherited

Response

mixed

getLocked

getLocked() : boolean
inherited

Response

boolean

getMaxWidth

getMaxWidth() : mixed
inherited

Response

mixed

getMinWidth

getMinWidth() : mixed
inherited

Response

mixed

getNullDisplayText

getNullDisplayText() : string

Response

string

获取组件参数值

getOption(string $optionName) : mixed
inherited
Throws
\Exception

Arguments

$optionName

string

参数名

Response

mixed

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

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

Arguments

$event

\FineUIPHP\Event|string

Response

string

getRenderAsRowExpander

getRenderAsRowExpander() : boolean

Response

boolean

getRenderer

getRenderer() : string

Response

string

getRendererArgument

getRendererArgument() : string

Response

string

getRendererFunction

getRendererFunction() : string

Response

string

getSortField

getSortField() : boolean
inherited

Response

boolean

getTextAlign

getTextAlign() : mixed
inherited

Response

mixed

getWidth

getWidth() : mixed
inherited

Response

mixed

控件外部容器的客户端ID（比如：Button1_wrapper）

getWrapperID() : string
inherited

Response

string

JavaScript中使用ID（比如：x0, x1）

getXID() : string
inherited

Response

string

判断参数是否有设置

hasOption(string $optionName) : boolean
inherited

Arguments

$optionName

string

参数名

Response

boolean

标题栏显示的文字

headerText(string $value) : $this
inherited

Arguments

$value

string

Response

$this

标题文本的排列位置

headerTextAlign(string $value) : $this
inherited

Arguments

$value

string

Response

$this

标题栏文字的提示文本

headerToolTip(string $value) : $this
inherited

Arguments

$value

string

Response

$this

标题栏文字的提示文本类型

headerToolTipType(string $value) : $this
inherited

Arguments

$value

string

Response

$this

是否隐藏

hidden(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

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

hideMode(string $value) : $this
inherited

Arguments

$value

string

Response

$this

控件标识符

id(string $id) : $this
inherited

Arguments

$id

string

Response

$this

是否处于FineUI的AJAX回发过程

isFineUIAjaxPostBack() : boolean
inherited

Response

boolean

添加客户端事件处理函数

listener( $eventName,  $handler) : $this
inherited

Arguments

$eventName

$handler

Response

$this

是否处于锁定状态

locked(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

最大列宽度

maxWidth(integer $value) : $this
inherited

Arguments

$value

integer

Response

$this

最小列宽度

minWidth(integer $value) : $this
inherited

Arguments

$value

integer

Response

$this

noRenderTo

noRenderTo() : $this
inherited

Response

$this

处理数据库中null值，默认为空字符串

nullDisplayText(string $value) : $this

Arguments

$value

string

Response

$this

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

onFirstPreRender()
inherited

删除CSS样式

removeStartupCSS( $key)
inherited

Arguments

$key

是否渲染为行扩展列

renderAsRowExpander(boolean $value) : $this

Arguments

$value

boolean

Response

$this

渲染器

renderer(string $value) : $this

Arguments

$value

string

Response

$this

渲染器的参数

rendererArgument(string $value) : $this

Arguments

$value

string

Response

$this

自定义渲染器函数（JavaScript函数）

rendererFunction(string $value) : $this

Arguments

$value

string

Response

$this

setHandler

setHandler(string $handler) : void
inherited

Arguments

$handler

string

排序字段

sortField(string $value) : $this
inherited

Arguments

$value

string

Response

$this

文本的排列位置

textAlign(string $value) : $this
inherited

Arguments

$value

string

Response

$this

转换options为json

toJson() : mixed|string
inherited

Response

mixed|string

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

triggerAjaxPreRenderEvent()
inherited

列宽度

width(integer $value) : $this
inherited

Arguments

$value

integer

Response

$this

是否添加 f-inline-block 样式

wrapperNodeInlineBlock( $value) : $this
inherited

Arguments

$value

Response

$this

Properties

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