Class TransactionalViewWidget

CComponent

Extended by

CBaseController

Extended by

CWidget

Extended by

X2Widget

Extended by

SortableWidget

Extended by

GridViewWidget

Extended by

TransactionalViewWidget

Direct known subclasses

ActionsWidget, CallsWidget, CommentsWidget, EmailsWidget, EventsWidget, LoggedTimeWidget, QuotesWidget, WebActivityWidget

Abstract
Package: application\components\sortableWidget
Located at x2engine/protected/components/sortableWidget/recordViewWidgets/TransactionalViewWidget.php

Methods summary
`protected`	# `getSearchModel( )`
`public static`	# `getJSONPropertiesStructure( )` Returns array the property _JSONPropertiesStructure Overrides `GridViewWidget::getJSONPropertiesStructure()`
`public`	# `getPackages( )` Magic getter. Returns this widget's packages. Magic getter. Returns this widget's packages. Overrides `GridViewWidget::getPackages()`
`public`	# `getSharedCssFileNames( )` Overrides `SortableWidget::getSharedCssFileNames()`
`public`	# `getIcon( )`
`public`	# `renderWidgetLabel( )` Renders the widget label saved in the profile JSON widget settings property This gets called if {widgetLabel} is contained in the template string. Renders the widget label saved in the profile JSON widget settings property This gets called if {widgetLabel} is contained in the template string. Overrides `SortableWidget::renderWidgetLabel()`
`public`	# `getCreateButtonTitle( )`
`public`	# `getCreateButtonText( )`
`public`	# `renderCreateButton( )`
`public object`	# `getDataProvider( )` Returns `object` Data provider object to be used for the grid view
`protected`	# `getActionDescriptionHeader( )`
`public`	# `getAjaxUpdateRouteAndParams( )` Overrides `GridViewWidget::getAjaxUpdateRouteAndParams()`
`public array`	# `getColumnWidths( array $collapse = array () )` Parameters `$collapse` `array` $collapse each entry should be an array of integers, corresponding to the indexes of columns whose widths will be combined Precondition: Columns cannot be combined if their widths are of different types (percent vs. integer) Returns `array` width of column sizes
`public`	# `buildDefaultGvSettings( mixed $attributes, array $combine = array () )` Build defaultGvSettings property for X2GridView Build defaultGvSettings property for X2GridView
`public array`	# `getGridViewConfig( )` Returns `array` the config array passed to widget () Overrides `GridViewWidget::getGridViewConfig()`
`public`	# `run( )` Render the widget container view Render the widget container view Overrides `SortableWidget::run()`
`protected`	# `getJSSortableWidgetParams( )` Overrides `GridViewWidget::getJSSortableWidgetParams()`
`protected array`	# `getTranslations( )` Returns `array` translations to pass to JS objects Overrides `GridViewWidget::getTranslations()`
`protected string`	# `getSettingsMenuContentEntries( )` Returns `string` HTML string containing settings menu options Overrides `GridViewWidget::getSettingsMenuContentEntries()`

Methods inherited from GridViewWidget
`getViewFileParams(), init()`

Methods inherited from SortableWidget
addError(), addPackage(), createSortableWidget(), deleteSortableWidget(), getCreatableWidgetOptions(), getCss(), getJSInstanceName(), getJSONProperties(), getJSONProperty(), getMinimized(), getParentType(), getPathAlias(), getSettingsMenuContent(), getSettingsMenuContentDialogs(), getSetupScript(), getSharedCss(), getSharedViewFile(), getWidgetContents(), getWidgetKey(), getWidgetLabel(), getWidgetProperties(), getWidgetProperty(), getWidgetSubtypeOptions(), getWidgetSubtypes(), hasError(), instantiateWidget(), parseWidgetLayoutKey(), registerCss(), registerSharedCss(), renderCloseButton(), renderErrors(), renderMinimizeButton(), renderSettingsMenu(), renderWidget(), renderWidgetContents(), 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 CActiveRecord`	`$model`		#
`public TwoColumnSortableWidgetManager`	`$widgetManager`		# $widgetManager $widgetManager
`public string`	`$viewFile`	`'_transactionalViewWidget'`	# The name of the view file containing the widget contents The name of the view file containing the widget contents
`public string`	`$template`	`'<div class="submenu-title-bar widget-title-bar">{widgetLabel}{createButton}{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>.
`public string`	`$sortableWidgetJSClass`	`'x2.TransactionalViewWidget'`	# JS class which is used to manage the front-end behavior of this widget. This is the class which gets instantiated by the setup script. JS class which is used to manage the front-end behavior of this widget. This is the class which gets instantiated by the setup script.
`protected boolean`	`$compactResultsPerPage`	`true`	#
`protected string`	`$createButtonLabel`	`''`	#
`protected string`	`$labelIconClass`	`''`	#
`protected mixed`	`$historyType`		#
`protected object`	`$_dataProvider`		#
`protected array`	`$_gridViewConfig`		# the config array passed to widget () the config array passed to widget ()
`protected mixed`	`$_searchModel`		#
`protected string`	`$containerClass`	`'sortable-widget-container x2-layout-island transactional-view-widget'`	# CSS class to be added to the container element CSS class to be added to the container element

Properties inherited from SortableWidget
`$_JSSortableWidgetParams, $_css, $_packages, $_settingsFormFields, $_setupScript, $_sharedCss, $_sharedCssFileNames, $_sharedViewFile, $_translations, $_viewFileParams, $canBeCreated, $canBeDeleted, $createByDefault, $defaultTitle, $info, $isAjaxRequest, $profile, $relabelingEnabled, $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`