Class TemplatesGridViewProfileWidget

Grid summary widget for custom modules

CComponent

Extended by

CBaseController

Extended by

CWidget

Extended by

X2Widget

Extended by

SortableWidget

Extended by

GridViewWidget

Extended by

ProfileGridViewWidget

Extended by

TemplatesGridViewProfileWidget

Package: application\components
Located at x2engine/protected/components/sortableWidget/profileWidgets/TemplatesGridViewProfileWidget.php

Methods summary
`protected object`	# `getModel( )` Returns `object` the model to be associated with the grid view widget
`public static`	# `getJSONPropertiesStructure( )` overrides parent method overrides parent method Overrides `ProfileGridViewWidget::getJSONPropertiesStructure()`
`public`	# `renderWidgetContents( )` Override parent method to prevent widget content from rendering if custom module has been deleted Override parent method to prevent widget content from rendering if custom module has been deleted Overrides `SortableWidget::renderWidgetContents()`
`public object`	# `getDataProvider( )` Returns `object` Data provider object to be used for the grid view Overrides `ProfileGridViewWidget::getDataProvider()`
`public array`	# `getGridViewConfig( )` Returns `array` the config array passed to widget () Overrides `ProfileGridViewWidget::getGridViewConfig()`
`public`	# `init( mixed $skipGridViewInit = false )` Initializes the widget. This method is called by CBaseController::createWidget and CBaseController::beginWidget after the widget's properties have been initialized. Initializes the widget. This method is called by CBaseController::createWidget and CBaseController::beginWidget after the widget's properties have been initialized. Overrides `GridViewWidget::init()`

Methods inherited from ProfileGridViewWidget
`afterGetModel(), getCss(), getSettingsMenuContentDialogs(), getSettingsMenuContentEntries(), getTemplate()`

Methods inherited from GridViewWidget
`getAjaxUpdateRouteAndParams(), getJSSortableWidgetParams(), getPackages(), getTranslations(), getViewFileParams()`

Methods inherited from SortableWidget
addError(), addPackage(), createSortableWidget(), deleteSortableWidget(), getCreatableWidgetOptions(), getJSInstanceName(), getJSONProperties(), getJSONProperty(), getMinimized(), getParentType(), getPathAlias(), getSettingsMenuContent(), getSetupScript(), getSharedCss(), getSharedCssFileNames(), getSharedViewFile(), getWidgetContents(), getWidgetKey(), getWidgetLabel(), getWidgetProperties(), getWidgetProperty(), getWidgetSubtypeOptions(), getWidgetSubtypes(), hasError(), instantiateWidget(), parseWidgetLayoutKey(), registerCss(), registerSharedCss(), renderCloseButton(), renderErrors(), renderMinimizeButton(), renderSettingsMenu(), renderWidget(), renderWidgetLabel(), run(), setJSONProperties(), setMinimized(), setPackages(), setSharedViewFile(), setSortOrder(), setWidgetProperties(), setWidgetProperty(), subtypeIsValid()

Methods inherited from X2Widget
`__construct(), ajaxRender(), behaviors(), getModule(), renderFile(), setModule()`

Methods inherited from CWidget
`actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), setId()`

Methods inherited from CBaseController
`beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderInternal(), widget()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Constants inherited from SortableWidget
`PROFILE_WIDGET_PATH_ALIAS, RECORD_VIEW_WIDGET_PATH_ALIAS`

Properties summary
`public boolean`	`$canBeDeleted`	`true`	# If true, the widget can be deleted by the user from the widget settings menu If true, the widget can be deleted by the user from the widget settings menu
`public string`	`$defaultTitle`	`'{Templates} Summary'`	#
`public boolean`	`$relabelingEnabled`	`true`	# If true, the widget can be relabeled by the user from the widget settings menu If true, the widget can be relabeled by the user from the widget settings menu
`public string`	`$template`	`'<div class="submenu-title-bar widget-title-bar">{widgetLabel}{closeButton}{minimizeButton}{settingsMenu}</div>{widgetContents}'`	# A mixture of html and attributes inside curly braces. This gets used by renderWidget to render widget elements specified in child classes. As with X2GridView, each attribute inside curly braces should have a corresponding method called render<attribute_name>. A mixture of html and attributes inside curly braces. This gets used by renderWidget to render widget elements specified in child classes. As with X2GridView, each attribute inside curly braces should have a corresponding method called render<attribute_name>.
`protected array`	`$_viewFileParams`		# Parameters to be passed to the specified view file referred to by the property $viewFile Parameters to be passed to the specified view file referred to by the property $viewFile

Properties inherited from ProfileGridViewWidget
`$_dataProvider, $_model, $viewFile`

Properties inherited from GridViewWidget
`$compactResultsPerPage, $sortableWidgetJSClass`

Properties inherited from SortableWidget
`$_JSSortableWidgetParams, $_css, $_packages, $_settingsFormFields, $_setupScript, $_sharedCss, $_sharedCssFileNames, $_sharedViewFile, $_translations, $canBeCreated, $containerClass, $createByDefault, $info, $isAjaxRequest, $profile, $widgetManager, $widgetType, $widgetUID`

Properties inherited from X2Widget
`$_module`

Properties inherited from CWidget
`$actionPrefix, $skin`

Magic properties inherited from X2Widget
`$module`

Magic properties inherited from CWidget
`$controller, $id, $owner, $viewPath`