Mage_Adminhtml_Block_Widget_Grid_Container Class Reference

Inheritance diagram for Mage_Adminhtml_Block_Widget_Grid_Container:

Mage_Adminhtml_Block_Widget_Container Mage_Adminhtml_Block_Template Mage_Core_Block_Template Mage_Core_Block_Abstract Varien_Object Mage_Adminhtml_Block_Api_Role Mage_Adminhtml_Block_Api_User Mage_Adminhtml_Block_Catalog_Product_Attribute Mage_Adminhtml_Block_Catalog_Search Mage_Adminhtml_Block_Checkout_Agreement Mage_Adminhtml_Block_Cms_Block Mage_Adminhtml_Block_Cms_Page Mage_Adminhtml_Block_Customer Mage_Adminhtml_Block_Extensions_Local Mage_Adminhtml_Block_Extensions_Remote Mage_Adminhtml_Block_Notification_Inbox Mage_Adminhtml_Block_Permissions_Role Mage_Adminhtml_Block_Permissions_User Mage_Adminhtml_Block_Poll_Poll Mage_Adminhtml_Block_Promo_Catalog Mage_Adminhtml_Block_Promo_Quote Mage_Adminhtml_Block_Rating_Rating Mage_Adminhtml_Block_Report_Customer_Accounts Mage_Adminhtml_Block_Report_Customer_Orders Mage_Adminhtml_Block_Report_Customer_Totals Mage_Adminhtml_Block_Report_Product Mage_Adminhtml_Block_Report_Product_Downloads Mage_Adminhtml_Block_Report_Product_Lowstock Mage_Adminhtml_Block_Report_Product_Ordered Mage_Adminhtml_Block_Report_Product_Sold Mage_Adminhtml_Block_Report_Product_Viewed Mage_Adminhtml_Block_Report_Review_Customer Mage_Adminhtml_Block_Report_Review_Detail Mage_Adminhtml_Block_Report_Review_Product Mage_Adminhtml_Block_Report_Sales_Coupons Mage_Adminhtml_Block_Report_Sales_Invoiced Mage_Adminhtml_Block_Report_Sales_Refunded Mage_Adminhtml_Block_Report_Sales_Sales Mage_Adminhtml_Block_Report_Sales_Shipping Mage_Adminhtml_Block_Report_Sales_Tax Mage_Adminhtml_Block_Report_Search Mage_Adminhtml_Block_Report_Shopcart_Abandoned Mage_Adminhtml_Block_Report_Shopcart_Customer Mage_Adminhtml_Block_Report_Shopcart_Product Mage_Adminhtml_Block_Report_Tag_Customer Mage_Adminhtml_Block_Report_Tag_Customer_Detail Mage_Adminhtml_Block_Report_Tag_Popular Mage_Adminhtml_Block_Report_Tag_Popular_Detail Mage_Adminhtml_Block_Report_Tag_Product Mage_Adminhtml_Block_Report_Tag_Product_Detail Mage_Adminhtml_Block_Review_Main Mage_Adminhtml_Block_Sales_Creditmemo Mage_Adminhtml_Block_Sales_Invoice Mage_Adminhtml_Block_Sales_Order Mage_Adminhtml_Block_Sales_Shipment Mage_Adminhtml_Block_Sitemap Mage_Adminhtml_Block_System_Convert_Gui Mage_Adminhtml_Block_System_Convert_Profile Mage_Adminhtml_Block_System_Store_Store Mage_Adminhtml_Block_Tag_Customer Mage_Adminhtml_Block_Tag_Product Mage_Adminhtml_Block_Tag_Tag Mage_Adminhtml_Block_Tax_Class Mage_Adminhtml_Block_Tax_Rule Mage_Adminhtml_Block_Urlrewrite Mage_GoogleBase_Block_Adminhtml_Items Mage_GoogleBase_Block_Adminhtml_Types

List of all members.

Public Member Functions

 __construct ()
 getCreateUrl ()
 getGridHtml ()
 getHeaderCssClass ()
 getHeaderWidth ()

Protected Member Functions

 _prepareLayout ()
 getAddButtonLabel ()
 getBackButtonLabel ()
 _addBackButton ()

Protected Attributes

 $_addButtonLabel = 'Add New'
 $_backButtonLabel = 'Back'
 $_blockGroup = 'adminhtml'


Detailed Description

Definition at line 35 of file Container.php.


Constructor & Destructor Documentation

__construct (  ) 

Constructor

By default is looking for first argument as array and assignes it as object attributes This behaviour may change in child classes

Reimplemented from Varien_Object.

Reimplemented in Mage_Adminhtml_Block_Api_Role, Mage_Adminhtml_Block_Api_User, Mage_Adminhtml_Block_Catalog_Product_Attribute, Mage_Adminhtml_Block_Catalog_Search, Mage_Adminhtml_Block_Checkout_Agreement, Mage_Adminhtml_Block_Cms_Block, Mage_Adminhtml_Block_Cms_Page, Mage_Adminhtml_Block_Customer, Mage_Adminhtml_Block_Extensions_Local, Mage_Adminhtml_Block_Extensions_Remote, Mage_Adminhtml_Block_Notification_Inbox, Mage_Adminhtml_Block_Permissions_Role, Mage_Adminhtml_Block_Permissions_User, Mage_Adminhtml_Block_Poll_Poll, Mage_Adminhtml_Block_Promo_Catalog, Mage_Adminhtml_Block_Promo_Quote, Mage_Adminhtml_Block_Rating_Rating, Mage_Adminhtml_Block_Report_Customer_Accounts, Mage_Adminhtml_Block_Report_Customer_Orders, Mage_Adminhtml_Block_Report_Customer_Totals, Mage_Adminhtml_Block_Report_Product_Downloads, Mage_Adminhtml_Block_Report_Product_Lowstock, Mage_Adminhtml_Block_Report_Product_Ordered, Mage_Adminhtml_Block_Report_Product_Sold, Mage_Adminhtml_Block_Report_Product_Viewed, Mage_Adminhtml_Block_Report_Product, Mage_Adminhtml_Block_Report_Review_Customer, Mage_Adminhtml_Block_Report_Review_Detail, Mage_Adminhtml_Block_Report_Review_Product, Mage_Adminhtml_Block_Report_Sales_Coupons, Mage_Adminhtml_Block_Report_Sales_Invoiced, Mage_Adminhtml_Block_Report_Sales_Refunded, Mage_Adminhtml_Block_Report_Sales_Sales, Mage_Adminhtml_Block_Report_Sales_Shipping, Mage_Adminhtml_Block_Report_Sales_Tax, Mage_Adminhtml_Block_Report_Search, Mage_Adminhtml_Block_Report_Shopcart_Abandoned, Mage_Adminhtml_Block_Report_Shopcart_Customer, Mage_Adminhtml_Block_Report_Shopcart_Product, Mage_Adminhtml_Block_Report_Tag_Customer_Detail, Mage_Adminhtml_Block_Report_Tag_Customer, Mage_Adminhtml_Block_Report_Tag_Popular_Detail, Mage_Adminhtml_Block_Report_Tag_Popular, Mage_Adminhtml_Block_Report_Tag_Product_Detail, Mage_Adminhtml_Block_Report_Tag_Product, Mage_Adminhtml_Block_Review_Main, Mage_Adminhtml_Block_Sales_Creditmemo, Mage_Adminhtml_Block_Sales_Invoice, Mage_Adminhtml_Block_Sales_Order, Mage_Adminhtml_Block_Sales_Shipment, Mage_Adminhtml_Block_Sitemap, Mage_Adminhtml_Block_System_Convert_Gui, Mage_Adminhtml_Block_System_Convert_Profile, Mage_Adminhtml_Block_System_Store_Store, Mage_Adminhtml_Block_Tag_Customer, Mage_Adminhtml_Block_Tag_Product, Mage_Adminhtml_Block_Tag_Tag, Mage_Adminhtml_Block_Tax_Class, Mage_Adminhtml_Block_Tax_Rule, Mage_Adminhtml_Block_Urlrewrite, Mage_GoogleBase_Block_Adminhtml_Items, and Mage_GoogleBase_Block_Adminhtml_Types.

Definition at line 42 of file Container.php.

00043     {
00044         parent::__construct();
00045 
00046         $this->setTemplate('widget/grid/container.phtml');
00047 
00048         $this->_addButton('add', array(
00049             'label'     => $this->getAddButtonLabel(),
00050             'onclick'   => 'setLocation(\'' . $this->getCreateUrl() .'\')',
00051             'class'     => 'add',
00052         ));
00053     }


Member Function Documentation

_addBackButton (  )  [protected]

Definition at line 83 of file Container.php.

00084     {
00085         $this->_addButton('back', array(
00086             'label'     => $this->getBackButtonLabel(),
00087             'onclick'   => 'setLocation(\'' . $this->getBackUrl() .'\')',
00088             'class'     => 'back',
00089         ));
00090     }

_prepareLayout (  )  [protected]

Preparing global layout

You can redefine this method in child classes for changin layout

Returns:
Mage_Core_Block_Abstract

Reimplemented from Mage_Adminhtml_Block_Widget_Container.

Reimplemented in Mage_Adminhtml_Block_Notification_Inbox, Mage_Adminhtml_Block_Report_Product_Downloads, Mage_Adminhtml_Block_Report_Product_Lowstock, Mage_Adminhtml_Block_Report_Shopcart_Abandoned, Mage_Adminhtml_Block_Report_Tag_Popular, Mage_Adminhtml_Block_System_Store_Store, and Mage_GoogleBase_Block_Adminhtml_Items.

Definition at line 55 of file Container.php.

00056     {
00057         $this->setChild( 'grid',
00058             $this->getLayout()->createBlock( $this->_blockGroup.'/' . $this->_controller . '_grid',
00059             $this->_controller . '.grid')->setSaveParametersInSession(true) );
00060         return parent::_prepareLayout();
00061     }

getAddButtonLabel (  )  [protected]

Definition at line 73 of file Container.php.

00074     {
00075         return $this->_addButtonLabel;
00076     }

getBackButtonLabel (  )  [protected]

Definition at line 78 of file Container.php.

00079     {
00080         return $this->_backButtonLabel;
00081     }

getCreateUrl (  ) 

Reimplemented in Mage_Adminhtml_Block_Sales_Order, and Mage_Adminhtml_Block_Urlrewrite.

Definition at line 63 of file Container.php.

00064     {
00065         return $this->getUrl('*/*/new');
00066     }

getGridHtml (  ) 

getHeaderCssClass (  ) 

Get header CSS class

Returns:
string

Reimplemented from Mage_Adminhtml_Block_Widget_Container.

Reimplemented in Mage_Adminhtml_Block_Tag_Tag.

Definition at line 92 of file Container.php.

00093     {
00094         return 'icon-head ' . parent::getHeaderCssClass();
00095     }

getHeaderWidth (  ) 

Definition at line 97 of file Container.php.

00098     {
00099         return 'width:50%;';
00100     }


Member Data Documentation

$_addButtonLabel = 'Add New' [protected]

Definition at line 38 of file Container.php.

$_backButtonLabel = 'Back' [protected]

Definition at line 39 of file Container.php.

$_blockGroup = 'adminhtml' [protected]

Definition at line 40 of file Container.php.


The documentation for this class was generated from the following file:

Generated on Sat Jul 4 17:23:09 2009 for Magento by  doxygen 1.5.8