CalendarView Class Reference

Inheritance diagram for CalendarView:
ModelView PortletViewInterface ConfigurableMetadataView MetadataView View UpcomingMeetingsCalendarView MyUpcomingMeetingsCalendarView UpcomingMeetingsRelatedCalendarView UpcomingMeetingsForAccountCalendarView UpcomingMeetingsForContactCalendarView UpcomingMeetingsForOpportunityCalendarView

Public Member Functions

 __construct ($viewData, $params, $uniqueLayoutId)
 getPortletParams ()
 isUniqueToAPage ()
 getTitle ()
 getModelClassName ()
 renderPortletHeadContent ()

Static Public Member Functions

static getDefaultTitle ()
static canUserConfigure ()
static getDesignerRulesType ()
static getDisplayDescription ()
static getPortletDescription ()
static getPortletRulesType ()

Protected Member Functions

 renderContent ()
 getOnChangeMonthScript ()
 getOnSelectScript ()
 makeDayEvents ()
 getActionModuleClassName ()
 getDataProvider ()
 makeDataProvider ()

Protected Attributes

 $controllerId
 $moduleId
 $params
 $viewData
 $uniqueLayoutId
 $dataProvider
 $renderViewToolBarDuringRenderContent = false

Detailed Description

The base calendar view.

Definition at line 40 of file CalendarView.php.


Member Function Documentation

renderContent (  )  [protected]

Renders content for a calendar.

Returns:
A string containing the element's content.

Reimplemented from View.

Definition at line 82 of file CalendarView.php.

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 130 of file CalendarView.php.

getTitle (  ) 

TODO

Reimplemented from ConfigurableMetadataView.

Definition at line 135 of file CalendarView.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 MetadataView.

Definition at line 160 of file CalendarView.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 UpcomingMeetingsForAccountCalendarView, UpcomingMeetingsForContactCalendarView, and UpcomingMeetingsForOpportunityCalendarView.

Definition at line 169 of file CalendarView.php.

static getPortletDescription (  )  [static]

Override to add a description for the view to be shown when adding a portlet

Implements PortletViewInterface.

Definition at line 177 of file CalendarView.php.

static getPortletRulesType (  )  [static]

What kind of PortletRules this view follows.

Returns:
PortletRulesType as string.

Implements PortletViewInterface.

Reimplemented in UpcomingMeetingsRelatedCalendarView.

Definition at line 191 of file CalendarView.php.

getActionModuleClassName (  )  [protected]

Module class name for models linked from rows in the calendar view.

Definition at line 221 of file CalendarView.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Fri Nov 24 07:10:22 2017