API Documentation » \FineUIPHP\UI\Button\Button

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

向页面添加控件无关脚本

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

确认对话框提示图标

confirmIcon(string $value) : $this

Arguments

$value

string

Response

$this

确认对话框弹出位置

confirmTarget(string $value) : $this

Arguments

$value

string

Response

$this

确认对话框内容

confirmText(string $value) : $this

Arguments

$value

string

Response

$this

确认对话框标题

confirmTitle(string $value) : $this

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

回发之前禁用按钮（防止重复提交）

disableControlBeforePostBack(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用

enabled(boolean $value) : $this

inherited

Arguments

$value

boolean

Response

$this

是否默认添加CSS类（ui-corner-all）

enableDefaultCorner(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否默认添加CSS类（ui-state-default）

enableDefaultState(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否启用按下状态

enablePress(boolean $value) : $this

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

getConfirmIcon

getConfirmIcon() : string

Response

string

getConfirmTarget

getConfirmTarget() : string

Response

string

getConfirmText

getConfirmText() : string

Response

string

getConfirmTitle

getConfirmTitle() : string

Response

string

getCssClass

getCssClass() : string

inherited

Response

string

getCssStyle

getCssStyle() : string

inherited

Response

string

getDisableControlBeforePostBack

getDisableControlBeforePostBack() : boolean

Response

boolean

getEnabled

getEnabled() : boolean

inherited

Response

boolean

getEnableDefaultCorner

getEnableDefaultCorner() : boolean

Response

boolean

getEnableDefaultState

getEnableDefaultState() : boolean

Response

boolean

getEnablePress

getEnablePress() : boolean

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

getIcon

getIcon() : string

Response

string

getIconAlign

getIconAlign() : string

Response

string

getIconFont

getIconFont() : string

Response

string

getIconFontClass

getIconFontClass() : string

Response

string

getIconUrl

getIconUrl() : string

Response

string

getId

getId() : mixed

inherited

Response

mixed

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

getMenu

getMenu() : \FineUIPHP\UI\Menu\Menu

Response

\FineUIPHP\UI\Menu\Menu

getMenuID

getMenuID() : string

Response

string

getOnClick

getOnClick() : \FineUIPHP\Event|null

Response

\FineUIPHP\Event|null

getOnClientClick

getOnClientClick() : 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

getPressed

getPressed() : boolean

Response

boolean

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

getShowMenuIcon

getShowMenuIcon() : boolean

Response

boolean

getSize

getSize() : string

Response

string

getTabIndex

getTabIndex() : string

Response

string

getTableColspan

getTableColspan() : integer

inherited

Response

integer

getTableConfigColumns

getTableConfigColumns() : integer

inherited

Response

integer

getTableRowspan

getTableRowspan() : integer

inherited

Response

integer

getText

getText() : string

Response

string

getTooltip

getToolTip() : string

Response

string

getToolTipType

getToolTipType() : string

Response

string

getType

getType() : string

Response

string

getValidateForms

getValidateForms() : array|string|null

Response

array|string|null

getValidateMessageBox

getValidateMessageBox() : boolean

Response

boolean

getValidateMessageBoxPlain

getValidateMessageBoxPlain() : boolean

Response

boolean

getValidateTarget

getValidateTarget() : string

Response

string

getWidth

getWidth() : integer|null

inherited

Response

integer|null

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

高度

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

系统图标

icon(string $value) : \FineUIPHP\UI\Button\Button

Arguments

$value

string

按钮图标

Response

\FineUIPHP\UI\Button\Button

$this

按钮图标的位置（可选项为：left, right, top, bottom）

iconAlign(string $value) : $this

Arguments

$value

string

Response

$this

按钮图标字体

iconFont(string $value) : $this

Arguments

$value

string

Response

$this

自定义图标字体的样式类

iconFontClass(string $value) : $this

Arguments

$value

string

Response

$this

自定义图标

iconUrl(String $iconUrl) : $this

Arguments

$iconUrl

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

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

按钮的上下文菜单

menu(\FineUIPHP\UI\Menu\Menu $menu) : $this

Arguments

$menu

\FineUIPHP\UI\Menu\Menu

Response

$this

按钮的上下文菜单

menuID(string $menuId) : $this

Arguments

$menuId

string

Response

$this

noRenderTo

noRenderTo() : $this

inherited

Response

$this

服务端点击操作（ajax）

onClick() : \FineUIPHP\UI\Button\Button

Response

\FineUIPHP\UI\Button\Button

$this

客户端点击操作

onClientClick(string $value) : $this

Arguments

$value

string

Response

$this

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

onFirstPreRender()

inherited

是否处于按下状态

pressed(boolean $value) : $this

Arguments

$value

boolean

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

获取按钮客户端点击事件的脚本

resolveClientScript(\FineUIPHP\UI\Button\Button $control,  $validateForms, \FineUIPHP\Enums\Target $validateTarget, boolean $validateMessageBox, boolean $validateMessageBoxPlain, \FineUIPHP\Event $onClickEvent, string $confirmText, string $confirmTitle, string $confirmIcon, string $confirmTarget, string $onClientClick, string $disableControlJavascriptID) : string

static

Arguments

$control

\FineUIPHP\UI\Button\Button

$validateForms

$validateTarget

\FineUIPHP\Enums\Target

$validateMessageBox

boolean

$validateMessageBoxPlain

boolean

$onClickEvent

\FineUIPHP\Event

$confirmText

string

$confirmTitle

string

$confirmIcon

string

$confirmTarget

string

$onClientClick

string

$disableControlJavascriptID

string

Response

string

setHandler

setHandler(string $handler) : void

inherited

Arguments

$handler

string

是否显示标识菜单的箭头图标

showMenuIcon(boolean $value) : $this

Arguments

$value

boolean

Response

$this

按钮的大小（可选项为：small, normal, medium, large）

size(string $value) : $this

Arguments

$value

string

Response

$this

Tab键索引

tabIndex(string $value) : \FineUIPHP\UI\Button\Button

Arguments

$value

string

Response

\FineUIPHP\UI\Button\Button

$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

Arguments

$value

string

Response

$this

转换options为json

toJson() : mixed|string

inherited

Response

mixed|string

提示文本

toolTip(string $value) : \FineUIPHP\UI\Button\Button

Arguments

$value

string

Response

\FineUIPHP\UI\Button\Button

$this

提示文本类型

toolTipType(string $value) : \FineUIPHP\UI\Button\Button

Arguments

$value

string

Response

\FineUIPHP\UI\Button\Button

$this

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

triggerAjaxPreRenderEvent()

inherited

按钮类型

type(string $value) : $this

Arguments

$value

string

Response

$this

需要验证的表单标识符数组

validateForms(string|array $param) : $this

Arguments

$param

string|array

Response

$this

验证失败时是否出现提示对话框

validateMessageBox(boolean $value) : $this

Arguments

$value

boolean

Response

$this

是否简单提示对话框

validateMessageBoxPlain(boolean $value) : $this

Arguments

$value

boolean

Response

$this

验证失败时提示对话框的弹出位置（可选项为：_self, _parent, _top）

validateTarget(string $value) : $this

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

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

Button

Methods

构造函数

魔术方法

Arguments

$name

Response

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

Response

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

Arguments

$value

Response

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

Arguments

$value

Response

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

向页面添加控件无关脚本

Arguments

$script

$level

添加CSS样式

Arguments

$key

$cssContent

添加控件相关脚本

Arguments

$scriptContent

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

Arguments

$value

Response

HTML标签属性

Arguments

$key

$value

Response

HTML标签属性（data-tag）

Arguments

$value

Response

块大小，超小屏幕（当本容器的Layout=Block时有效）

Arguments

$value

Response

自定义总块数（当本容器的Layout=Block时有效）

Arguments

$value

Response

块间距（当本容器的Layout=Block时有效

Arguments

$value

Response

块大小，大屏幕（当本容器的Layout=Block时有效）

Arguments

$value

Response

块大小，中等屏幕（当本容器的Layout=Block时有效）

Arguments

$value

Response

块大小，小屏幕（当本容器的Layout=Block时有效）

Arguments

$value

Response

控制子控件的位置（当本容器的Layout=VBox或者HBox时有效）

Arguments

$value

Response

子控件的外边距（当本容器的Layout=VBox或者HBox时有效）

Arguments

$value

Response

内边距（当本容器的Layout=VBox或者HBox时有效）

Arguments

$value

Response

控制子控件的位置（当本容器的Layout=VBox或者HBox时有效）

Arguments

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