PHP Class View_Button, atk4

addMenu() public method

Show menu when clicked. For example, dropdown menu.

public addMenu ( array $options = [], boolean $vertical = false ) : Menu
$options	array	Options to pass to Menu class
$vertical	boolean	Direction of menu (false=horizontal, true=vertical)
return	Menu

addPopover() public method

Because this is based on a dialog (popover), this is a modal action even though it does not add dimming / transparency.

public addPopover ( array $js_options = [], array $class_options = null ) : View_Popover
$js_options	array	Options to pass to popover JS widget
$class_options	array	Options to pass to popover PHP class
return	View_Popover

addSplitButton() public method

Adds another button after this one with an arrow and returns it.

public addSplitButton ( array $options = null ) : Button
$options	array	Options to pass to new Button class
return	Button	New button object (button with triangle)

defaultTemplate() public method

Set template of button element.

public defaultTemplate ( )

getPosition() public method

Return array with position settings for JS.

public getPosition ( boolean $vertical = false ) : array
$vertical	boolean	Direction of menu (false=horizontal, true=vertical)
return	array

isClicked() public method

Add click handler on button and returns true if button was clicked.

public isClicked ( string $message = null ) : boolean
$message	string	Confirmation question to ask
return	boolean

jsButton() public method

public jsButton ( )

link() public method

Set button as HTML link object .

Add click handler on button and executes $callback if button was clicked.

public onClick ( callback $callback, string $confirm_msg = null )
$callback	callback	Callback function to execute
$confirm_msg	string	Confirmation question to ask

onClickConsole() public method

Add click handler on button, that will execute callback. Similar to onClick, however output from callback execution will appear in a dialog window with a console.

public onClickConsole ( callable $callback, string $title = null )
$callback	callable
$title	string

render() public method

Render button.

public render ( )

setIcon() public method

Sets icon for button.

public setIcon ( string $icon )
$icon	string	Icon CSS class

setLabel() public method

Sets label of button.

public setLabel ( string | array $label )
$label	string | array

setNoText() public method

Set button without text and optionally with icon.

public setNoText ( string $icon = null )
$icon	string	Icon CSS class