Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

 Class JToolBar

Description

ToolBar handler

Located in /joomla/html/toolbar.php (line 26)

Class JObject   (Subpackage Base)

Class JToolBar   (Subpackage HTML)
Method Summary
Constructor JToolBar __construct ([string $name = 'toolbar'])
Method void addButtonDir (string|array $dir)
Method string appendButton (string 0, string 1)
Method string getIncludePath ()
Method JToolBar &getInstance (string $name)
Method object &loadButtonType (string $type, [ $new = false])
Method string prependButton (string 0, mixed 1)
Method string render (string 0)
Method array renderButton (object A &$node, string 1)
Methods
Constructor __construct (line 67)

Constructor

  • var: The type of setup file
  • access: protected
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.

  • since: 1.5
  • access: public
void addButtonDir (string|array $dir)
  • string|array $dir: directory or directories to search.
appendButton (line 111)

Set a value

  • return: The set value
  • access: public
string appendButton (string 0, string 1)
  • string 0: The name of the param
  • string 1: The value of the parameter
getIncludePath (line 278)

Get the include path

  • since: 1.5
  • access: public
string getIncludePath ()
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 );

  • return: The JToolBar object.
  • access: public
JToolBar &getInstance (string $name)
  • string $name: The name of the toolbar.
loadButtonType (line 198)

Loads a button type

  • since: 1.5
  • access: public
object &loadButtonType (string $type, [ $new = false])
  • string $type: buttonType
  • $new
prependButton (line 127)

Get a value

  • access: public
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

  • return: HTML
  • access: public
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

  • return: Any array of the label, the form element and the tooltip
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