Docs For Class Mage_Adminhtml_Block_Widget_Grid_Massaction

Description

Grid widget massaction block

author: Magento Core Team <[email protected]>
abstract:

Located in /Adminhtml/Block/Widget/Grid/Massaction/Abstract.php (line 34)

Varien_Object
   |
   --Mage_Core_Block_Abstract
      |
      --Mage_Core_Block_Template
         |
         --Mage_Adminhtml_Block_Template
            |
            --Mage_Adminhtml_Block_Widget
               |
               --Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract

Direct descendents

Class	Description
Mage_Adminhtml_Block_Widget_Grid_Massaction	Grid widget massaction default block

Variable Summary

array $_items

Method Summary

Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract __construct ()

Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract addItem (string $itemId, $item)

string getApplyButtonHtml ()

integer getCount ()

string getFormFieldName ()

string getFormFieldNameInternal ()

void getGridIdsJson ()

string getGridJsObjectName ()

void getHtmlId ()

Mage_Adminhtml_Block_Widget_Grid_Massaction_Item getItem (string $itemId)

array getItems ()

string getItemsJson ()

void getJavaScript ()

string getJsObjectName ()

array getSelected ()

string getSelectedJson ()

boolean getUseSelectAll ()

boolean isAvailable ()

Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract removeItem (string $itemId)

Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract setUseSelectAll (boolean $flag)

Variables

array $_items = array() (line 41)

Massaction items

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

Constructor __construct (line 43)

access: public

Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract __construct ()

addItem (line 65)

Add new massaction item

$item = array( 'label' => string, 'complete' => string, // Only for ajax enabled grid (optional) 'url' => string, 'confirm' => string, // text of confirmation of this action (optional) 'additional' => string|array|Mage_Core_Block_Abstract // (optional) );

access: public

Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract addItem (string $itemId, $item)

string $itemId
array $item

getApplyButtonHtml (line 217)

Retrieve apply button html

access: public

string getApplyButtonHtml ()

getCount (line 125)

Retrieve massaction items count

access: public

integer getCount ()

getFormFieldName (line 145)

Retrieve global form field name for all massaction items

access: public

string getFormFieldName ()

getFormFieldNameInternal (line 155)

Retrieve form field name for internal use. Based on $this->getFormFieldName()

access: public

string getFormFieldNameInternal ()

getGridIdsJson (line 233)

access: public

void getGridIdsJson ()

getGridJsObjectName (line 175)

Retrieve grid block js object name

access: public

string getGridJsObjectName ()

getHtmlId (line 249)

access: public

void getHtmlId ()

Redefinition of:

Mage_Adminhtml_Block_Widget::getHtmlId()

getItem (line 86)

Retrieve massaction item with id $itemId

access: public

Mage_Adminhtml_Block_Widget_Grid_Massaction_Item getItem (string $itemId)

string $itemId

getItems (line 100)

Retrieve massaction items

access: public

array getItems ()

getItemsJson (line 110)

Retrieve massaction items JSON

access: public

string getItemsJson ()

getJavaScript (line 222)

access: public

void getJavaScript ()

getJsObjectName (line 165)

Retrieve massaction block js object name

access: public

string getJsObjectName ()

getSelected (line 202)

Retrieve array of selected checkboxes

access: public

array getSelected ()

getSelectedJson (line 185)

Retrieve JSON string of selected checkboxes

access: public

string getSelectedJson ()

getUseSelectAll (line 274)

Retrieve select all functionality flag check

access: public

boolean getUseSelectAll ()

isAvailable (line 135)

Checks are massactions available

access: public

boolean isAvailable ()

removeItem (line 260)

Remove existing massaction item by its id

access: public

Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract removeItem (string $itemId)

string $itemId

setUseSelectAll (line 285)

Retrieve select all functionality flag check

access: public

Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract setUseSelectAll (boolean $flag)

boolean $flag

Inherited Methods

Inherited From Mage_Adminhtml_Block_Widget

Mage_Adminhtml_Block_Widget::getButtonHtml()
Mage_Adminhtml_Block_Widget::getCurrentUrl()
Mage_Adminhtml_Block_Widget::getGlobalIcon()
Mage_Adminhtml_Block_Widget::getHtmlId()
Mage_Adminhtml_Block_Widget::getId()
Mage_Adminhtml_Block_Widget::_addBreadcrumb()

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

Class Mage_Adminhtml_Block_Widget_Grid_Massaction_Abstract

Inherited Variables

Inherited Methods

Inherited Constants