1. class
  2. Joomla
  3. CMS
  4. Toolbar
  5. Button
  6. HelpButton

HelpButton

class HelpButton extends ToolbarButton

Renders a help popup window button

Methods

__construct( object $parent = null)

Constructor

from ToolbarButton
string
getName()

Get the element name

from ToolbarButton
string
render( array $definition)

Get the HTML to render the button

from ToolbarButton
string
fetchIconClass( string $identifier)

Method to get the CSS class name for an icon identifier

from ToolbarButton
string
fetchButton( string $type = 'Help', string $ref = '', boolean $com = false, string $override = null, string $component = null)

Fetches the button HTML code.

string
fetchId()

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 = 'Help', string $ref = '', boolean $com = false, string $override = null, string $component = null)

Fetches the button HTML code.

Parameters

string $type Unused string.
string $ref The name of the help screen (its key reference).
boolean $com Use the help file in the component directory.
string $override Use this URL instead of any other.
string $component Name of component to get Help (null for current component)

Return Value

string

string fetchId()

Get the button id

Redefined from JButton class

Return Value

string Button CSS Id