Docs For Class Mage_Adminhtml_Block_Widget

Class Mage_Adminhtml_Block_Widget_Container

Description

Adminhtml container block

author: Magento Core Team <[email protected]>

Located in /Adminhtml/Block/Widget/Container.php (line 34)

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Adminhtml_Block_Template
            |
            --Mage_Adminhtml_Block_Widget_Container

Direct descendents

Class	Description
Mage_Adminhtml_Block_Cms_Wysiwyg_Images_Content	Wysiwyg Images content block
Mage_Adminhtml_Block_Catalog_Product	Catalog manage products block
Mage_Adminhtml_Block_Urlrewrite_Edit	Block for Urlrewrites edit form and selectors container
Mage_Adminhtml_Block_Sales_Transactions_Detail	Adminhtml transaction detail
Mage_Adminhtml_Block_System_Convert_Gui_Edit_Tab_Wizard	Convert profile edit tab
Mage_Adminhtml_Block_Widget_Form_Container	Adminhtml form container block
Mage_Adminhtml_Block_Widget_View_Container	Adminhtml view container block
Mage_Adminhtml_Block_Widget_Grid_Container	Adminhtml grid container block
Mage_Sales_Block_Adminhtml_Recurring_Profile_View	Recurring profile view page

Variable Summary

array $_buttons

string $_controller

string $_headerText

Method Summary

Mage_Adminhtml_Block_Widget_Container addButton (string $id, array $data, [integer $level = 0], [integer $sortOrder = 100], [ $area = 'header'], string|null $placement)

string getButtonsHtml ([string $area = null])

string getHeaderCssClass ()

string getHeaderHtml ()

string getHeaderText ()

boolean hasFooterButtons ()

Mage_Adminhtml_Block_Widget_Container removeButton (string $id)

Mage_Adminhtml_Block_Widget_Container updateButton (string $id, [string|null $key = null], mixed $data)

Mage_Adminhtml_Block_Widget_Container _addButton (string $id, array $data, [integer $level = 0], [integer $sortOrder = 100], [ $area = 'header'], string|null $placement)

Mage_Adminhtml_Block_Widget_Button _addButtonChildBlock (string $childId)

string _prepareButtonBlockId (string $id)

Mage_Core_Block_Abstract _prepareLayout ()

Mage_Adminhtml_Block_Widget_Container _removeButton (string $id)

string _toHtml ()

Mage_Adminhtml_Block_Widget_Container _updateButton (string $id, [string|null $key = null], mixed $data)

Variables

array $_buttons = array(
-1 => array(),0=>array(),1=>array(),) (line 50)

Array of buttons

access: protected

string $_controller = 'empty' (line 42)

So called "container controller" to specify group of blocks participating in some action

access: protected

Redefined in descendants as:

Mage_Adminhtml_Block_Urlrewrite_Edit::$_controller : Part for building some blocks names
Mage_Adminhtml_Block_Urlrewrite::$_controller : Part for generating apropriate grid block name
Mage_Sales_Block_Adminhtml_Recurring_Profile::$_controller

string $_headerText = 'Container Widget Header' (line 61)

Header text

access: protected

Inherited Variables

Inherited from Mage_Core_Block_Template

Mage_Core_Block_Template::$_baseUrl
Mage_Core_Block_Template::$_jsUrl
Mage_Core_Block_Template::$_showTemplateHints
Mage_Core_Block_Template::$_showTemplateHintsBlocks
Mage_Core_Block_Template::$_template
Mage_Core_Block_Template::$_viewDir
Mage_Core_Block_Template::$_viewVars

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::$_alias
Mage_Core_Block_Abstract::$_anonSuffix
Mage_Core_Block_Abstract::$_childGroups
Mage_Core_Block_Abstract::$_children
Mage_Core_Block_Abstract::$_childrenHtmlCache
Mage_Core_Block_Abstract::$_frameCloseTag
Mage_Core_Block_Abstract::$_frameOpenTag
Mage_Core_Block_Abstract::$_isAnonymous
Mage_Core_Block_Abstract::$_layout
Mage_Core_Block_Abstract::$_messagesBlock
Mage_Core_Block_Abstract::$_nameInLayout
Mage_Core_Block_Abstract::$_parent
Mage_Core_Block_Abstract::$_parentBlock
Mage_Core_Block_Abstract::$_request
Mage_Core_Block_Abstract::$_sortedChildren
Mage_Core_Block_Abstract::$_urlModel

Methods

addButton (line 93)

Public wrapper for protected _addButton method

access: public

Mage_Adminhtml_Block_Widget_Container addButton (string $id, array $data, [integer $level = 0], [integer $sortOrder = 100], [ $area = 'header'], string|null $placement)

string $id
array $data
integer $level
integer $sortOrder
string|null $placement: area, that button should be displayed in ('header', 'footer', null)
$area

getButtonsHtml (line 215)

Produce buttons HTML

access: public

string getButtonsHtml ([string $area = null])

string $area

Redefined in descendants as:

Mage_Adminhtml_Block_Urlrewrite_Edit::getButtonsHtml() : Get container buttons HTML

getHeaderCssClass (line 255)

Get header CSS class

access: public

string getHeaderCssClass ()

Redefined in descendants as:

getHeaderHtml (line 265)

Get header HTML

access: public

string getHeaderHtml ()

Redefined in descendants as:

Mage_Adminhtml_Block_Widget_Form_Container::getHeaderHtml()
Mage_Adminhtml_Block_Sales_Order_Create::getHeaderHtml() : Prepare header html

getHeaderText (line 245)

Get header text

access: public

string getHeaderText ()

Redefined in descendants as:

Mage_Adminhtml_Block_Sales_Transactions_Detail::getHeaderText() : Retrieve header text
Mage_Adminhtml_Block_Permissions_User_Edit::getHeaderText()
Mage_Adminhtml_Block_Cms_Block_Edit::getHeaderText() : Get edit form container header text
Mage_Adminhtml_Block_Cms_Page_Edit::getHeaderText() : Retrieve text for header element depending on loaded page
Mage_Adminhtml_Block_Catalog_Search_Edit::getHeaderText()
Mage_Adminhtml_Block_Catalog_Product_Attribute_Edit::getHeaderText()
Mage_Adminhtml_Block_Api_User_Edit::getHeaderText()
Mage_Adminhtml_Block_Customer_Group_Edit::getHeaderText()
Mage_Adminhtml_Block_Customer_Edit::getHeaderText()
Mage_Adminhtml_Block_Tag_Tag_Edit::getHeaderText()
Mage_Adminhtml_Block_Tag_Edit::getHeaderText() : Retrieve Header text
Mage_Adminhtml_Block_Sales_Order_Invoice_Create::getHeaderText() : Retrieve text for header
Mage_Adminhtml_Block_Sales_Order_Invoice_View::getHeaderText()
Mage_Adminhtml_Block_Sales_Order_Creditmemo_Create::getHeaderText()
Mage_Adminhtml_Block_Sales_Order_Creditmemo_View::getHeaderText() : Retrieve text for header
Mage_Adminhtml_Block_Sales_Order_Status_New::getHeaderText() : Retrieve text for header element depending on loaded page
Mage_Adminhtml_Block_Sales_Order_Status_Edit::getHeaderText() : Retrieve text for header element depending on loaded page
Mage_Adminhtml_Block_Sales_Order_Status_Assign::getHeaderText() : Retrieve text for header element depending on loaded page
Mage_Adminhtml_Block_Sales_Order_Shipment_Create::getHeaderText()
Mage_Adminhtml_Block_Sales_Order_Shipment_View::getHeaderText()
Mage_Adminhtml_Block_Sales_Order_Address::getHeaderText() : Retrieve text for header element depending on loaded page
Mage_Adminhtml_Block_Sales_Order_View::getHeaderText()
Mage_Adminhtml_Block_Promo_Catalog_Edit::getHeaderText()
Mage_Adminhtml_Block_Promo_Quote_Edit::getHeaderText()
Mage_Adminhtml_Block_Checkout_Agreement_Edit::getHeaderText() : Get Header text
Mage_Adminhtml_Block_Poll_Answer_Edit::getHeaderText()
Mage_Adminhtml_Block_Poll_Edit::getHeaderText()
Mage_Adminhtml_Block_Review_Add::getHeaderText()
Mage_Adminhtml_Block_Review_Edit::getHeaderText()
Mage_Adminhtml_Block_System_Variable_Edit::getHeaderText() : Return translated header text depending on creating/editing action
Mage_Adminhtml_Block_System_Store_Delete::getHeaderText() : Get edit form container header text
Mage_Adminhtml_Block_System_Store_Edit::getHeaderText() : Get Header text
Mage_Adminhtml_Block_System_Convert_Profile_Edit::getHeaderText()
Mage_Adminhtml_Block_System_Convert_Gui_Edit::getHeaderText()
Mage_Adminhtml_Block_System_Account_Edit::getHeaderText()
Mage_Adminhtml_Block_Rating_Edit::getHeaderText()
Mage_Adminhtml_Block_Tax_Class_Edit::getHeaderText()
Mage_Adminhtml_Block_Tax_Rule_Edit::getHeaderText() : Get Header text
Mage_Adminhtml_Block_Sitemap_Edit::getHeaderText() : Get edit form container header text
Mage_Connect_Block_Adminhtml_Extension_Custom_Edit::getHeaderText() : Get header of page
Mage_ImportExport_Block_Adminhtml_Export_Edit::getHeaderText() : Get header text
Mage_ImportExport_Block_Adminhtml_Import_Edit::getHeaderText() : Get header text
Mage_Sales_Block_Adminhtml_Billing_Agreement_View::getHeaderText() : Retrieve header text
Mage_Index_Block_Adminhtml_Process_Edit::getHeaderText() : Retrieve text for header element depending on loaded page
Mage_XmlConnect_Block_Adminhtml_Queue_Edit::getHeaderText() : Get header text
Mage_XmlConnect_Block_Adminhtml_Mobile_Submission::getHeaderText() : Get form header title
Mage_XmlConnect_Block_Adminhtml_Mobile_Edit::getHeaderText() : Get form header title
Mage_XmlConnect_Block_Adminhtml_Template_Edit::getHeaderText() : Get text for header
Mage_GoogleBase_Block_Adminhtml_Types_Edit::getHeaderText()
Mage_Widget_Block_Adminhtml_Widget_Instance_Edit::getHeaderText() : Return translated header text depending on creating/editing action

hasFooterButtons (line 275)

Check if there's anything to display in footer

access: public

boolean hasFooterButtons ()

removeButton (line 120)

Public wrapper for the _removeButton() method

access: public

Mage_Adminhtml_Block_Widget_Container removeButton (string $id)

string $id

updateButton (line 164)

Public wrapper for protected _updateButton method

access: public

Mage_Adminhtml_Block_Widget_Container updateButton (string $id, [string|null $key = null], mixed $data)

string $id
string|null $key
mixed $data

_addButton (line 73)

Add a button

access: protected

Mage_Adminhtml_Block_Widget_Container _addButton (string $id, array $data, [integer $level = 0], [integer $sortOrder = 100], [ $area = 'header'], string|null $placement)

string $id
array $data
integer $level
integer $sortOrder
string|null $placement: area, that button should be displayed in ('header', 'footer', null)
$area

_addButtonChildBlock (line 202)

Adding child block with specified child's id.

access: protected

Mage_Adminhtml_Block_Widget_Button _addButtonChildBlock (string $childId)

string $childId

_prepareButtonBlockId (line 191)

Prepare block id for button's id

access: protected

string _prepareButtonBlockId (string $id)

string $id

_prepareLayout (line 174)

Preparing child blocks for each added button

access: protected

Mage_Core_Block_Abstract _prepareLayout ()

Redefinition of:

Mage_Core_Block_Abstract::_prepareLayout(): Preparing global layout

Redefined in descendants as:

Mage_Adminhtml_Block_Catalog_Product::_prepareLayout() : Prepare button and grid
Mage_Adminhtml_Block_Urlrewrite_Edit::_prepareLayout() : Prepare page layout, basing on different registry and request variables
Mage_Adminhtml_Block_System_Convert_Gui_Edit_Tab_Wizard::_prepareLayout()
Mage_Adminhtml_Block_Widget_Form_Container::_prepareLayout()
Mage_Paypal_Block_Adminhtml_Settlement_Details::_prepareLayout() : Initialize form
Mage_Adminhtml_Block_Cms_Page_Edit::_prepareLayout()
Mage_Adminhtml_Block_Catalog_Category_Edit::_prepareLayout()
Mage_Adminhtml_Block_Customer_Edit::_prepareLayout()
Mage_Adminhtml_Block_Tag_Tag_Edit::_prepareLayout() : Add to layout accordion block
Mage_Adminhtml_Block_Tag_Edit::_prepareLayout() : Add child HTML to layout
Mage_XmlConnect_Block_Adminhtml_Mobile_Edit::_prepareLayout() : Adding JS scripts to block
Mage_Adminhtml_Block_Widget_View_Container::_prepareLayout()
Mage_Adminhtml_Block_Widget_Grid_Container::_prepareLayout()
Mage_Adminhtml_Block_Report_Tag_Popular::_prepareLayout()
Mage_Adminhtml_Block_Report_Product_Downloads::_prepareLayout()
Mage_Adminhtml_Block_Report_Product_Lowstock::_prepareLayout()
Mage_Adminhtml_Block_Report_Shopcart_Abandoned::_prepareLayout()
Mage_Adminhtml_Block_System_Store_Store::_prepareLayout()
Mage_Adminhtml_Block_Notification_Inbox::_prepareLayout()
Mage_XmlConnect_Block_Adminhtml_Template::_prepareLayout() : Prepare layout Add new button
Mage_GoogleBase_Block_Adminhtml_Items::_prepareLayout()
Mage_Sales_Block_Adminhtml_Recurring_Profile_View::_prepareLayout() : Create buttons

_removeButton (line 104)

Remove existing button

access: protected

Mage_Adminhtml_Block_Widget_Container _removeButton (string $id)

string $id

_toHtml (line 292)

Prepare html output

access: protected

string _toHtml ()

Redefinition of:

Mage_Adminhtml_Block_Template::_toHtml(): Prepare html output

Redefined in descendants as:

Mage_Adminhtml_Block_Sales_Transactions_Detail::_toHtml()

_updateButton (line 133)

Update specified button property

access: protected

Mage_Adminhtml_Block_Widget_Container _updateButton (string $id, [string|null $key = null], mixed $data)

string $id
string|null $key
mixed $data

Inherited Methods

Inherited From Mage_Adminhtml_Block_Template

Mage_Adminhtml_Block_Template::getFormKey()
Mage_Adminhtml_Block_Template::isOutputEnabled()
Mage_Adminhtml_Block_Template::_getUrlModelClass()
Mage_Adminhtml_Block_Template::_toHtml()

Inherited From Mage_Core_Block_Template

Mage_Core_Block_Template::assign()
Mage_Core_Block_Template::fetchView()
Mage_Core_Block_Template::getArea()
Mage_Core_Block_Template::getBaseUrl()
Mage_Core_Block_Template::getCacheKeyInfo()
Mage_Core_Block_Template::getDirectOutput()
Mage_Core_Block_Template::getJsUrl()
Mage_Core_Block_Template::getObjectData()
Mage_Core_Block_Template::getShowTemplateHints()
Mage_Core_Block_Template::getTemplate()
Mage_Core_Block_Template::getTemplateFile()
Mage_Core_Block_Template::renderView()
Mage_Core_Block_Template::setScriptPath()
Mage_Core_Block_Template::setTemplate()
Mage_Core_Block_Template::_construct()
Mage_Core_Block_Template::_toHtml()

Inherited From Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::addToChildGroup()
Mage_Core_Block_Abstract::addToParentGroup()
Mage_Core_Block_Abstract::append()
Mage_Core_Block_Abstract::countChildren()
Mage_Core_Block_Abstract::escapeHtml()
Mage_Core_Block_Abstract::escapeUrl()
Mage_Core_Block_Abstract::formatDate()
Mage_Core_Block_Abstract::formatTime()
Mage_Core_Block_Abstract::getAction()
Mage_Core_Block_Abstract::getAnonSuffix()
Mage_Core_Block_Abstract::getBlockAlias()
Mage_Core_Block_Abstract::getBlockHtml()
Mage_Core_Block_Abstract::getCacheKey()
Mage_Core_Block_Abstract::getCacheKeyInfo()
Mage_Core_Block_Abstract::getCacheLifetime()
Mage_Core_Block_Abstract::getCacheTags()
Mage_Core_Block_Abstract::getChild()
Mage_Core_Block_Abstract::getChildChildHtml()
Mage_Core_Block_Abstract::getChildData()
Mage_Core_Block_Abstract::getChildGroup()
Mage_Core_Block_Abstract::getChildHtml()
Mage_Core_Block_Abstract::getHelper()
Mage_Core_Block_Abstract::getIsAnonymous()
Mage_Core_Block_Abstract::getLayout()
Mage_Core_Block_Abstract::getMessagesBlock()
Mage_Core_Block_Abstract::getModuleName()
Mage_Core_Block_Abstract::getNameInLayout()
Mage_Core_Block_Abstract::getParentBlock()
Mage_Core_Block_Abstract::getRequest()
Mage_Core_Block_Abstract::getSkinUrl()
Mage_Core_Block_Abstract::getSortedChildBlocks()
Mage_Core_Block_Abstract::getSortedChildren()
Mage_Core_Block_Abstract::getUrl()
Mage_Core_Block_Abstract::getUrlBase64()
Mage_Core_Block_Abstract::getUrlEncoded()
Mage_Core_Block_Abstract::helper()
Mage_Core_Block_Abstract::htmlEscape()
Mage_Core_Block_Abstract::insert()
Mage_Core_Block_Abstract::jsQuoteEscape()
Mage_Core_Block_Abstract::setAnonSuffix()
Mage_Core_Block_Abstract::setAttribute()
Mage_Core_Block_Abstract::setBlockAlias()
Mage_Core_Block_Abstract::setChild()
Mage_Core_Block_Abstract::setFrameTags()
Mage_Core_Block_Abstract::setIsAnonymous()
Mage_Core_Block_Abstract::setLayout()
Mage_Core_Block_Abstract::setMessagesBlock()
Mage_Core_Block_Abstract::setNameInLayout()
Mage_Core_Block_Abstract::setParentBlock()
Mage_Core_Block_Abstract::stripTags()
Mage_Core_Block_Abstract::toHtml()
Mage_Core_Block_Abstract::unsetCallChild()
Mage_Core_Block_Abstract::unsetChild()
Mage_Core_Block_Abstract::unsetChildren()
Mage_Core_Block_Abstract::urlEscape()
Mage_Core_Block_Abstract::_afterCacheUrl()
Mage_Core_Block_Abstract::_afterToHtml()
Mage_Core_Block_Abstract::_beforeCacheUrl()
Mage_Core_Block_Abstract::_beforeChildToHtml()
Mage_Core_Block_Abstract::_beforeToHtml()
Mage_Core_Block_Abstract::_construct()
Mage_Core_Block_Abstract::_getChildHtml()
Mage_Core_Block_Abstract::_getUrlModel()
Mage_Core_Block_Abstract::_getUrlModelClass()
Mage_Core_Block_Abstract::_loadCache()
Mage_Core_Block_Abstract::_prepareLayout()
Mage_Core_Block_Abstract::_saveCache()
Mage_Core_Block_Abstract::_toHtml()
Mage_Core_Block_Abstract::__()

Class Constants

Inherited Constants

Inherited from Mage_Core_Block_Abstract

Mage_Core_Block_Abstract::CACHE_GROUP

Documentation generated on Fri, 11 Feb 2011 16:59:34 +0200 by phpDocumentor 1.4.3