Actions

Difference between revisions of "Creating a toolbar for your component"

From Joomla! Documentation

m (Added categorisation and syntax highlighting.)
Line 4: Line 4:
 
<source lang="php">
 
<source lang="php">
 
       JToolBarHelper::title( ''your_component_view_page_title'', 'generic.png' );
 
       JToolBarHelper::title( ''your_component_view_page_title'', 'generic.png' );
       JToolBarHelper::deleteList();
+
       JToolBarHelper::deleteList(); // Will call the task/function "remove" in your controller
       JToolBarHelper::editListX();
+
       JToolBarHelper::editListX(); // Will call the task/function "edit" in your controller
       JToolBarHelper::addNewX();
+
       JToolBarHelper::addNewX(); // Will call the task/function "add" in your controller
       JToolBarHelper::publishList();
+
       JToolBarHelper::publishList(); // Will call the task/function "publish" in your controller
       JToolBarHelper::unpublishList();
+
       JToolBarHelper::unpublishList(); // Will call the task/function "unpublish" in your controller
 
       JToolBarHelper::preferences('your_component_xml_file', ''height'');
 
       JToolBarHelper::preferences('your_component_xml_file', ''height'');
 
</source>
 
</source>

Revision as of 09:48, 9 August 2009

Note: This applies when using the MVC structure.

By default the Joomla Toolbar uses a Delete, Edit, New, Publish, Unpublish and Parameters buttons. To use them in your component you must write the following code in the view.html.php of your view file (below your display function).

      JToolBarHelper::title( ''your_component_view_page_title'', 'generic.png' );
      JToolBarHelper::deleteList(); // Will call the task/function "remove" in your controller
      JToolBarHelper::editListX(); // Will call the task/function "edit" in your controller
      JToolBarHelper::addNewX(); // Will call the task/function "add" in your controller
      JToolBarHelper::publishList(); // Will call the task/function "publish" in your controller
      JToolBarHelper::unpublishList(); // Will call the task/function "unpublish" in your controller
      JToolBarHelper::preferences('your_component_xml_file', ''height'');

So (i.e.) your code would look like this:

 class HelloViewHellos extends JView
 {
   function display($tpl = null) {
      global $mainframe, $option;
      JToolBarHelper::title( 'Hello Component', 'generic.png' );
      JToolBarHelper::deleteList();
      JToolBarHelper::editListX();
      JToolBarHelper::addNewX();
      JToolBarHelper::publishList();
      JToolBarHelper::unpublishList();
      JToolBarHelper::preferences('com_hello', '500');