API Documentation
Back to top  

Component

Extends \FineUIPHP\Base\ControlBase\ControlBase

控件基类

package

FineUIPHP\UI

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

控件样式类名

cssClass(string $value) : $this

Arguments

$value

string

Response

$this

控件样式

cssStyle(string $value) : $this

Arguments

$value

string

Response

$this

是否启用

enabled(boolean $value) : $this
inherited

Arguments

$value

boolean

Response

$this

页面加载后立即获得焦点

focusOnPageLoad(boolean $value) : $this

Arguments

$value

boolean

Response

$this

getAttributeDataTag

getAttributeDataTag() : mixed|null
inherited

Response

mixed|null

getCssClass

getCssClass() : string

Response

string

getCssStyle

getCssStyle() : string

Response

string

getEnabled

getEnabled() : boolean
inherited

Response

boolean

getFocusOnPageLoad

getFocusOnPageLoad() : boolean

Response

boolean

getHidden

getHidden() : boolean
inherited

Response

boolean

getHideMode

getHideMode() : string
inherited

Response

string

getId

getId() : mixed
inherited

Response

mixed

getMargin

getMargin() : string

Response

string

getMarginBottom

getMarginBottom() : integer

Response

integer

getMarginLeft

getMarginLeft() : integer

Response

integer

getMarginRight

getMarginRight() : integer

Response

integer

getMarginTop

getMarginTop() : integer

Response

integer

获取组件参数值

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

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

是否隐藏

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

外边距

margin(string $value) : $this

Arguments

$value

string

Response

$this

底部外边距

marginBottom(integer $value) : $this

Arguments

$value

integer

Response

$this

左侧外边距

marginLeft(integer $value) : $this

Arguments

$value

integer

Response

$this

右侧外边距

marginRight(integer $value) : $this

Arguments

$value

integer

Response

$this

顶部外边距

marginTop(integer $value) : $this

Arguments

$value

integer

Response

$this

noRenderTo

noRenderTo() : $this
inherited

Response

$this

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

onFirstPreRender()
inherited

删除CSS样式

removeStartupCSS( $key)
inherited

Arguments

$key

setHandler

setHandler(string $handler) : void
inherited

Arguments

$handler

string

转换options为json

toJson() : mixed|string
inherited

Response

mixed|string

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

triggerAjaxPreRenderEvent()
inherited

是否添加 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