class PopupButton extends ToolbarButton

Renders a modal window button

Methods

__construct( object $parent = null)

Constructor

string
getName()

Get the element name

string
render( array $definition)

Get the HTML to render the button

string
fetchIconClass( string $identifier)

Method to get the CSS class name for an icon identifier

string
fetchButton( string $type = 'Modal', string $name = '', string $text = '', string $url = '', integer $width = 640, integer $height = 480, integer $top, integer $left, string $onClose = '', string $title = '', string $footer = null)

Fetch the HTML for the button

string
fetchId( string $type, string $name)

Get the button id

Details

__construct( object $parent = null)

Constructor

Parameters

object $parent The parent

string getName()

Get the element name

Return Value

string type of the parameter

string render( array $definition)

Get the HTML to render the button

Parameters

array $definition &$definition Parameters to be passed

Return Value

string

string fetchIconClass( string $identifier)

Method to get the CSS class name for an icon identifier

Can be redefined in the final class

Parameters

string $identifier Icon identification string

Return Value

string CSS class name

string fetchButton( string $type = 'Modal', string $name = '', string $text = '', string $url = '', integer $width = 640, integer $height = 480, integer $top, integer $left, string $onClose = '', string $title = '', string $footer = null)

Fetch the HTML for the button

Parameters

string $type Unused string, formerly button type.
string $name Modal name, used to generate element ID
string $text The link text
string $url URL for popup
integer $width Width of popup
integer $height Height of popup
integer $top Top attribute. [@deprecated Unused, will be removed in 4.0]
integer $left Left attribute. [@deprecated Unused, will be removed in 4.0]
string $onClose JavaScript for the onClose event.
string $title The title text
string $footer The footer html

Return Value

string

string fetchId( string $type, string $name)

Get the button id

Parameters

string $type Button type
string $name Button name

Return Value

string Button CSS Id