API Documentation
Back to top  

HiddenField

Extends \FineUIPHP\Base\BoxComponent\Field\TextField\RealTextField\RealTextField

隐藏表单控件

package

FineUIPHP\UI

Methods

构造函数

__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

向页面添加控件无关脚本

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

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

anchorValue(string $value) : $this
inherited

Arguments

$value

string

Response

$this

HTML标签属性

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

Arguments

$key

$value

Response

$this

HTML标签属性（data-tag）

attributeDataTag( $value) : $this
inherited

Arguments

$value

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

控制子控件的位置（当本容器的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

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

columnWidth(string $value) : $this
inherited

Arguments

$value

string

Response

$this

需要比较的控件（对值进行验证）

compareControl(string $value) : $this
inherited

Arguments

$value

string

Response

$this

不满足比较条件时提示信息

compareMessage(string $value) : $this
inherited

Arguments

$value

string

Response

$this

比较操作符

compareOperator(string $value) : $this
inherited

Arguments

$value

string

Response

$this

比较的类型

compareType(string $value) : $this
inherited

Arguments

$value

string

Response

$this

需要比较的值（对值进行验证）

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

值为空时显示的占位文本

emptyText(string $value) : $this
inherited

Arguments

$value

string

Response

$this

是否启用

enabled(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

启用前缀文本

enablePrefix(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

启用后缀文本

enableSuffix(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

验证时去除文本的前后空白字符

enableValidateTrim(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

页面加载后立即获得焦点

focusOnPageLoad(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

getAbsoluteX

getAbsoluteX() : integer
inherited

Response

integer

getAbsoluteY

getAbsoluteY() : integer
inherited

Response

integer

getAnchorValue

getAnchorValue() : string
inherited

Response

string

getAttributeDataTag

getAttributeDataTag() : mixed|null
inherited

Response

mixed|null

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

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

getColumnWidth

getColumnWidth() : string
inherited

Response

string

getCompareControl

getCompareControl() : string
inherited

Response

string

getCompareMessage

getCompareMessage() : string
inherited

Response

string

getCompareOperator

getCompareOperator() : string
inherited

Response

string

getCompareType

getCompareType() : string
inherited

Response

string

getCompareValue

getCompareValue() : string
inherited

Response

string

getCssClass

getCssClass() : string
inherited

Response

string

getCssStyle

getCssStyle() : string
inherited

Response

string

getEnabled

getEnabled() : boolean
inherited

Response

boolean

getEnablePrefix

getEnablePrefix() : boolean
inherited

Response

boolean

getEnableSuffix

getEnableSuffix() : boolean
inherited

Response

boolean

getEnableValidateTrim

getEnableValidateTrim() : boolean
inherited

Response

boolean

getFocusOnPageLoad

getFocusOnPageLoad() : boolean
inherited

Response

boolean

getHeight

getHeight() : integer|null
inherited

Response

integer|null

getHidden

getHidden() : boolean
inherited

Response

boolean

getHideMode

getHideMode() : string
inherited

Response

string

getId

getId() : mixed
inherited

Response

mixed

getLabel

getLabel() : string
inherited

Response

string

getLabelAlign

getLabelAlign() : string|null
inherited

Response

string|null

getLabelSeparator

getLabelSeparator() : string
inherited

Response

string

getLabelWidth

getLabelWidth() : string|null
inherited

Response

string|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

getMaxLength

getMaxLength() : integer|null
inherited

Response

integer|null

getMaxLengthMessage

getMaxLengthMessage() : string
inherited

Response

string

getMinLength

getMinLength() : integer|null
inherited

Response

integer|null

getMinLengthMessage

getMinLengthMessage() : string
inherited

Response

string

getNextClickControl

getNextClickControl() : string
inherited

Response

string

getNextFocusControl

getNextFocusControl() : string
inherited

Response

string

getOffsetRight

getOffsetRight() : string|null
inherited

Response

string|null

获取组件参数值

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

getPrefix

getPrefix() : string
inherited

Response

string

getReadonly

getReadonly() : boolean
inherited

Response

boolean

getRegex

getRegex() : string
inherited

Response

string

getRegexIgnoreCase

getRegexIgnoreCase() : string
inherited

Response

string

getRegexMessage

getRegexMessage() : string
inherited

Response

string

getRegexPattern

getRegexPattern() : string
inherited

Response

string

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

getRequired

getRequired() : boolean
inherited

Response

boolean

getRequiredMessage

getRequiredMessage() : string
inherited

Response

string

getShowEmptyLabel

getShowEmptyLabel() : boolean
inherited

Response

boolean

getShowLabel

getShowLabel() : boolean
inherited

Response

boolean

getShowRedStar

getShowRedStar() : boolean
inherited

Response

boolean

getSuffix

getSuffix() : string
inherited

Response

string

getTabIndex

getTabIndex() : integer|null
inherited

Response

integer|null

getTableColspan

getTableColspan() : integer
inherited

Response

integer

getTableConfigColumns

getTableConfigColumns() : integer
inherited

Response

integer

getTableRowspan

getTableRowspan() : integer
inherited

Response

integer

getValidateForValue

getValidateForValue() : boolean
inherited

Response

boolean

getValidatorFunction

getValidatorFunction() : string
inherited

Response

string

getWidth

getWidth() : integer|null
inherited

Response

integer|null

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

getWrapperID() : string
inherited

Response

string

getWrapperNodeInlineBlock

getWrapperNodeInlineBlock() : boolean

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

隐藏模式（可选项为：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

标签文本

label(string $value) : $this
inherited

Arguments

$value

string

Response

$this

表单中标签的位置

labelAlign(string $value) : $this
inherited

Arguments

$value

string

Response

$this

表单中字段与标签的分隔符

labelSeparator(string $value) : $this
inherited

Arguments

$value

string

Response

$this

标签的宽度

labelWidth(string $value) : $this
inherited

Arguments

$value

string

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

最大长度（对显示文本进行验证）

maxLength(integer $value) : $this
inherited

Arguments

$value

integer

Response

$this

超过最大长度时提示信息

maxLengthMessage(string $value) : $this
inherited

Arguments

$value

string

Response

$this

最小长度（对显示文本进行验证）

minLength(integer $value) : $this
inherited

Arguments

$value

integer

Response

$this

少于最小长度时提示信息

minLengthMessage(string $value) : $this
inherited

Arguments

$value

string

Response

$this

响应回车键自动点击的控件

nextClickControl(string $value) : $this
inherited

Arguments

$value

string

Response

$this

响应回车键获得焦点的控件

nextFocusControl(string $value) : $this
inherited

Arguments

$value

string

Response

$this

noRenderTo

noRenderTo() : $this
inherited

Response

$this

距离右侧边界的宽度（相当于设置CSS样式margin-right）

offsetRight(string $value) : $this
inherited

Arguments

$value

string

Response

$this

失去焦点事件

onBlur() : $this
inherited

Response

$this

失去焦点时需要执行的客户端脚本

onClientBlur(string $param) : $this
inherited

Arguments

$param

string

Response

$this

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

onFirstPreRender()
inherited

文本改变事件

onTextChanged() : $this
inherited

Response

$this

前缀文本

prefix(string $value) : $this
inherited

Arguments

$value

string

Response

$this

表单控件的只读状态

readonly(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

需要验证的正则表达式（对显示文本进行验证）

regex(string $regex = '') : $this
inherited

Arguments

$regex

string

Response

$this

正则表达式是否忽略大小写

regexIgnoreCase(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

不满足正则表达式时的提示信息

regexMessage(string $value) : $this
inherited

Arguments

$value

string

Response

$this

需要验证的正则表达式规则（可选项为：email, number, url, postal_code, ip_address, identity_card, alpha, alpha_number, alpha_underline, alpha_number_underline, alpha_lowercase, alpha_uppercase）（对显示文本进行验证）

regexPattern(string $value) : $this
inherited

Arguments

$value

string

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

删除CSS样式

removeStartupCSS( $key)
inherited

Arguments

$key

是否必填项（对显示文本进行验证）

required(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

为空时提示信息

requiredMessage(string $value) : $this
inherited

Arguments

$value

string

Response

$this

setHandler

setHandler(string $handler) : void
inherited

Arguments

$handler

string

是否显示空白的标签

showEmptyLabel(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

是否显示标签

showLabel(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

用来标识必填项的红色星号

showRedStar(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

后缀文本

suffix(string $value) : $this
inherited

Arguments

$value

string

Response

$this

Tab按键的跳转顺序

tabIndex(integer $value) : $this
inherited

Arguments

$value

integer

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

文本

text(string $value) : $this
inherited

Arguments

$value

string

Response

$this

转换options为json

toJson() : mixed|string
inherited

Response

mixed|string

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

triggerAjaxPreRenderEvent()
inherited

对值进行验证（MinLength, MaxLength, Required, Regex, RegexPattern）

validateForValue(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

客户端验证函数（JavaScript函数）

validatorFunction(string $value) : $this
inherited

Arguments

$value

string

Response

$this

宽度

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