RelatedListView Class Reference

Inheritance diagram for RelatedListView:

Public Member Functions
	__construct ($viewData, $params, $uniqueLayoutId)
	getPortletParams ()
	renderPortletHeadContent ()
	isUniqueToAPage ()
	getTitle ()
	getModelClassName ()
Static Public Member Functions
static	getDefaultTitle ()
static	canUserConfigure ()
static	getDesignerRulesType ()
static	getDisplayDescription ()
static	getPortletRulesType ()
static	getAllowedOnPortletViewClassNames ()
static	allowMultiplePlacement ()
static	getPortletDescription ()
Data Fields
const	GRID_VIEW_TYPE_NORMAL = 1
const	GRID_VIEW_TYPE_STACKED = 2
Protected Member Functions
	getShowTableOnEmpty ()
	getEmptyText ()
	getGridViewWidgetPath ()
	makeSearchAttributeData ()
	makeDataProviderBySearchAttributeData ($searchAttributeData)
	getSortAttributeForDataProvider ()
	resolveSortDescendingForDataProvider ()
	getCreateLinkRouteParameters ()
	getCGridViewPagerParams ()
	getCGridViewAfterAjaxUpdate ()
	resolveControllerId ()
	getActionModuleClassName ()
	getDataProvider ()
	getRelationAttributeName ()
	resolvePaginationParams ()
	resolveConfigForDataProvider ()
Static Protected Member Functions
static	getGridTemplate ()
static	getPagerCssClass ()
Protected Attributes
	$params
	$viewData
	$uniqueLayoutId
	$renderViewToolBarDuringRenderContent = false

Detailed Description

The base View for a module's related list view.

Definition at line 40 of file RelatedListView.php.

Member Function Documentation

isUniqueToAPage ( )

Tells View that it can render the extending class' divs with and id matching their name. Must be overridden to return false in extending classes that can be rendered multiple times within a page to avoid generating a page with non-unique ids which will fail XHtml validation. For those it will render a class attribute with their name.

Reimplemented from View.

Definition at line 162 of file RelatedListView.php.

getCGridViewAfterAjaxUpdate ( ) [protected]

Override to not run global eval, since it causes doubling up of ajax requests on the pager. (non-PHPdoc)

See also:: ListView::getCGridViewAfterAjaxUpdate()

Reimplemented from ListView.

Reimplemented in ProductsRelatedListView, and TasksForRelatedKanbanView.

Definition at line 200 of file RelatedListView.php.

getTitle ( )

TODO

Reimplemented from ConfigurableMetadataView.

Reimplemented in TasksForRelatedKanbanView.

Definition at line 209 of file RelatedListView.php.

static getDesignerRulesType ( ) [static]

Override in each sub-class if you have applicable designer rules for handling the modification of metadata layouts

Returns:: null or a DesignerRules Class;

Reimplemented from ListView.

Reimplemented in TasksForRelatedKanbanView.

Definition at line 234 of file RelatedListView.php.

static getDisplayDescription ( ) [static]

Override to add a display description. An example would be 'Contacts for Account'. This display description can then be used by external classes interfacing with the view in order to display information to the user in the user interface.

Reimplemented in AccountAffiliationsForContactRelatedListView, ContactAffiliationsForAccountRelatedListView, AccountsForAccountRelatedListView, CampaignsForMarketingListRelatedListView, ContactsForAccountRelatedListView, ContactsForOpportunityRelatedListView, GameRewardTransactionsForGameRewardRelatedListView, MarketingListsForContactRelatedListView, UpcomingMeetingsForAccountListView, UpcomingMeetingsForContactListView, UpcomingMeetingsForOpportunityListView, OpportunitiesForAccountRelatedListView, OpportunitiesForContactRelatedListView, ProductsForAccountRelatedListView, ProductsForContactRelatedListView, ProductsForOpportunityRelatedListView, ProjectsForAccountRelatedListView, ProjectsForContactRelatedListView, ProjectsForOpportunityRelatedListView, OpenTasksForAccountRelatedListView, OpenTasksForContactRelatedListView, and OpenTasksForOpportunityRelatedListView.