JToolBar
Description
ToolBar handler
Located in /joomla/html/toolbar.php (line 26)
JObject (Subpackage Base) JToolBar (Subpackage HTML)
Method Summary
string
getIncludePath
()
Methods
Constructor __construct (line 67)
Constructor
JToolBar
__construct
([string $name = 'toolbar'])
- string $name: The toolbar name
Redefinition of:
- JObject::__construct()
- Class constructor, overridden in descendant classes.
addButtonDir (line 262)
Add a directory where JToolBar should search for button types
You may either pass a string or an array of directories.
JParameter will be searching for an element type in the same order you added them. If the parameter type cannot be found in the custom folders, it will look in JParameter/types.
void
addButtonDir
(string|array $dir)
- string|array $dir: directory or directories to search.
appendButton (line 111)
Set a value
string
appendButton
(string 0, string 1)
- string 0: The name of the param
- string 1: The value of the parameter
getInstance (line 88)
Returns a reference to a global JToolBar object, only creating it if it doesn't already exist.
This method must be invoked as:
$toolbar = & JToolBar::getInstance( $name );
- string $name: The name of the toolbar.
loadButtonType (line 198)
Loads a button type
object
&loadButtonType
(string $type, [ $new = false])
- string $type: buttonType
- $new
prependButton (line 127)
Get a value
string
prependButton
(string 0, mixed 1)
- string 0: The name of the param
- mixed 1: The default value if not found
render (line 142)
Render
string
render
(string 0)
- string 0: The name of the control, or the default text area if a setup file is not found
renderButton (line 173)
Render a parameter type
array
renderButton
(object A &$node, string 1)
- string 1: The control name
- object A &$node: param tag node
Inherited Methods
Inherited From JObject
JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 21:29:36 +0000 by phpDocumentor 1.3.1