HelpButton
Extends ToolbarButtonRenders a help popup window button
| since |
3.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor
__construct(object parent = null) : mixed
Arguments
- parent
objectThe parent
Response
mixed
_getCommand
Get the JavaScript command for the button
_getCommand(string ref, bool com, string override, string component) : string
| since |
3.0 |
|---|
Arguments
- ref
stringThe name of the help screen (its key reference).- com
boolUse the help file in the component directory.- override
stringUse this URL instead of any other.- component
stringName of component to get Help (null for current component)
Response
stringJavaScript command string
fetchButton
Get the button
fetchButton() : string
Defined in the final button class
| since |
3.0 |
|---|
Response
string
fetchIconClass
Method to get the CSS class name for an icon identifier
fetchIconClass(string identifier) : string
Can be redefined in the final class
| since |
3.0 |
|---|
Arguments
- identifier
stringIcon identification string
Response
stringCSS class name
fetchId
Get the button id
fetchId() : string
Redefined from JButton class
| since |
3.0 |
|---|
Response
stringButton CSS Id
getName
Get the element name
getName() : string
| since |
3.0 |
|---|
Response
stringtype of the parameter
render
Get the HTML to render the button
render(array &definition) : string
| since |
3.0 |
|---|
Arguments
- definition
arrayParameters to be passed
Response
string
Properties
_name
element name
This has to be set in the final renderer classes.
Type(s)
string
_parent
reference to the object that instantiated the element
Type(s)
\JButton