Public Member Functions | |
| isUniqueToAPage () | |
| render () | |
| setCssClasses (array $classes) | |
| getCssClasses () | |
| getTitle () | |
| getPostTruncatedTitleContent () | |
Protected Member Functions | |
| resolveDefaultClasses () | |
| renderContainerWrapperId () | |
| getContainerWrapperTag () | |
| getId () | |
| renderContent () | |
| getViewStyle () | |
| renderTitleContent () | |
| resolveCustomViewTemplateFileName ($theme, $view) | |
Protected Attributes | |
| $cssClasses = array() | |
| $title | |
| $makeDefaultClassesFromClassHeirarchy = true | |
Base class for all views. A view is something that knows how to render itself for display within an XHtml page. Views are arranged in a hierarchy of views within views and when the top level view is asked to render itself it renders the entire hierarchy.
Definition at line 43 of file View.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 in ActionBarAndListView, ActionBarSearchAndListView, AjaxPageView, CalendarView, ConfigurationView, FlashMessageView, GridView, InlineEditView, ModalConfigEditView, ModalContainerView, MyListView, NullView, RelatedListView, TitleBarView, AccountDetailsAndRelationsView, LatestActivitiesListView, AutorespondersListView, CampaignDetailsAndRelationsView, CommentsForRelatedModelView, ConfigureModulesView, AnyContactSelectForEmailMatchingView, ContactDetailsAndRelationsView, ContactInlineCreateForArchivedEmailCreateView, ActionBarAndAttributeEditView, ActionBarAndModuleEditableMetadataCollectionView, ActionBarAndModuleEditView, ActionBarForDesignerModuleView, AttributeEditView, AttributesCollectionView, DesignerPageMenuView, MetadataViewEditView, ModuleEditableMetadataCollectionView, ModuleEditView, StandardAndCustomAttributesListView, TitleBarAndDesignerPageMenuView, ArchivedEmailMatchingView, EmailConfigurationListView, EmailTemplateWizardTypesGridView, MergeTagsView, GameRewardDetailsAndRelationsView, GameCoinContainerView, LeaderboardActionBarAndListView, LeaderboardListView, ModalGameNotificationContainerView, TitleBarAndLeaderboardView, UserGameDashboardView, HomeDashboardView, IframePortletView, ImportWizardView, JobsCollectionView, AttributesRedirectToContactsView, LeadConvertOpportunityView, LeadConvertView, LeadDetailsAndRelationsView, LeadsModuleAttributesListView, AddressMapModalView, MapPortletAddressView, MarketingDashboardView, MarketingListDetailsAndRelationsView, MarketingListMembersListView, MarketingListsManageSubscriptionsListView, DaysMeetingsFromCalendarModalListView, MissionsPortletListView, OpportunityDetailsAndRelationsView, ProductCategoriesActionBarAndTreeListView, ProjectDetailsAndRelationsView, ProjectsDashboardView, DashboardReportChartForPortletView, ReportDetailsAndResultsView, ReportWizardTypesGridView, SummationDrillDownReportResultsGridView, RssReaderView, SocialItemsListView, TaskCheckListItemsForTaskView, ActionBarForUserEditAndDetailsView, UserDetailsAndRelationsView, UserGroupMembershipView, WorkflowWizardTypesGridView, ActionBarAndZeroModelsYetView, AuthenticationConfigurationListView, BreadCrumbView, ChartView, ComponentForWizardModelView, CurrenciesCollectionView, DevelopmentListView, LanguagesCollectionView, ModalSearchAndListView, ModelRelationsSecuredPortletFrameView, PluginsConfigurationListView, SearchAndListView, ActionBarForGroupEditAndDetailsView, GroupsActionBarAndTreeListView, GroupUserMembershipEditView, ModulePermissionsEditAndDetailsView, PoliciesEditAndDetailsView, RightsEditAndDetailsView, RolesActionBarAndTreeListView, RolesTitleBarAndTreeView, StepsAndProgressBarForWizardView, TitleBarAndListView, WizardModelRelationsAndAttributesTreeView, and WizardView.
| render | ( | ) |
Renders a div element with a id or class attribute set to the type of the view, (depending on the value returned by isUniqueToAPage()), and containing the content of any matching template found in the themes/<themename>/ directory if it exists, marked by begin/end comments, and the content of the view rendered by renderContent(). All are correctly indented by indent().
If the template does not exist in the active theme folder, it will attempt to locate the file in the themes/default/templates folder and include it if it exists.
Reimplemented in AjaxPageView, ModalView, PageView, PortletRefreshView, ImportMappingRuleAjaxPageView, ImportWizardMappingExtraColumnView, ActionRowForWorkflowComponentView, EmailMessageRecipientRowForWorkflowComponentView, EmailMessageRowForWorkflowComponentView, AttributeRowForWizardModelComponentView, GlobalSearchView, DynamicSearchRowView, AccessFailureAjaxView, ShortcutsCreateMenuView, and ZurmoExternalDefaultPageView.
| getId | ( | ) | [protected] |
Reimplemented in CommentsForRelatedModelView, CommentsForRelatedTaskModelView, DashboardReportChartForPortletView, TaskCheckListItemsForTaskView, and MobileHeaderView.
| renderContent | ( | ) | [abstract, protected] |
Renders the view content.
Reimplemented in TestCompleteSequentialProcessView, ActionBarForSearchAndListView, AjaxPageView, CalendarView, ConfigurationView, ContainedViewCompleteSequentialProcessView, DetailsPortletSelectionView, DetailsView, EditAndDetailsView, EditView, FlashMessageView, GridView, InlineEditView, ListView, MassActionView, ModalConfigEditView, ModalContainerView, ModalView, NoPortletsToPlaceView, NullView, PageView, PortletFrameView, PortletRefreshView, ProgressView, SearchView, SequentialProcessContainerView, SequentialProcessView, TitleBarView, AccountDetailsAndRelationsView, AccountOrgChartModalView, AccountSelectView, LatestActivitiesForPortletView, LatestActivitiesListView, AutorespondersListView, CalendarItemsListView, CalendarListView, CombinedCalendarView, FullCalendarForCombinedView, SavedCalendarFiltersForReportWizardView, CampaignDetailsOverlayView, CampaignDetailsView, CampaignEditView, CampaignItemsRelatedListView, CampaignOverallMetricsView, CommentsForRelatedModelView, CommentsMarkdownGuideView, CommentsForRelatedModelPortletView, ConfigureModulesMenuView, ConfigureModulesView, DiagnosticCheckServicesView, AnyContactSelectForEmailMatchingView, ContactDetailsAndRelationsView, ContactEditAndDetailsView, ConversationDetailsView, ActionBarForDesignerModuleView, AttributesCollectionView, DesignerPageMenuView, MetadataViewEditView, ModuleEditableMetadataCollectionView, ArchivedEmailMatchingView, NoGlobalEmailConfigurationYetView, NoUserEmailConfigurationYetView, MergeTagGuideView, MergeTagsView, GameCoinContainerView, ModalGameNotificationContainerView, UserBadgesForPortletView, UserGameDashboardView, UserGamificationStatisticsForPortletView, UserLeaderboardRankingForPortletView, DashboardView, HomeDashboardPortletSelectionView, HomeView, IframePortletView, WelcomeView, ImportSequentialProcessContainerView, ImportTempTableListView, ImportWizardMappingExtraColumnView, CheckServicesView, InstallAccessFailureView, InstallAdditionalCheckServicesView, InstallCompleteView, InstallDemoDataView, InstallPageView, InstallSettingsView, InstallView, InstallWelcomeView, UpgradeStartCompleteView, UpgradeStepOneCompleteView, UpgradeStepTwoCompleteView, JobsCollectionView, QueueJobView, RunJobView, AttributesRedirectToContactsView, LeadConvertAccountSkipView, LeadConvertOpportunitySkipView, LeadConvertOpportunityView, LeadConvertView, AddressMapModalView, MapPortletAddressView, GlobalMarketingFooterConfigurationPreviewView, MarketingDashboardView, MarketingMetricsView, MarketingOverallMetricsView, MarketingListDetailsOverlayView, MarketingListDetailsView, MarketingListMembersListView, MarketingListMembersPortletView, MarketingListOverallMetricsView, MarketingListsManageSubscriptionsListView, MashableInboxActionBarForViews, DaysMeetingsFromCalendarModalListView, NoMeetingsYetView, MissionsPortletListView, MyMissionsForPortletView, OpportunitiesBySourceChartView, OpportunitiesByStageChartView, OpportunityDetailsAndRelationsView, ProductsRelatedListView, ProductCategoriesModalTreeListView, ProductCategoriesTreeListView, ActiveProjectsListView, ProjectsActivityFeedPortletView, ProjectsDashboardView, ProjectsFeedListView, ZeroTasksForRelatedModelYetView, DashboardReportChartForPortletView, ReportChartForPortletView, ReportChartView, ReportDetailsView, ReportResultsGridForPortletView, ReportResultsGridView, ReportResultsSQLView, ReportSQLForPortletView, RuntimeFiltersForPortletView, RssReaderView, NoGlobalSendGridEmailConfigurationYetView, SocialItemsForPortletView, SocialItemsListView, AccountDetailsOverlayView, ContactDetailsOverlayView, OpportunityDetailsOverlayView, ProjectDetailsOverlayView, TaskCheckListItemsForTaskView, TaskRelatedDetailsOverlayView, TasksForRelatedKanbanView, TaskModalDetailsView, TasksKanbanView, TasksListView, TasksMyListView, ZeroTasksYetView, ActionBarForUserEditAndDetailsView, NoPrimaryEmailAddressForLoggedUserYetView, UserGroupMembershipView, ActionRowForWorkflowComponentView, EmailMessageRecipientRowForWorkflowComponentView, EmailMessageRowForWorkflowComponentView, WorkflowManageOrderListView, WorkflowManageOrderView, AboutView, AttributeRowForWizardModelComponentView, BreadCrumbView, ComponentForWizardModelView, ConfigurableDetailsAndRelationsView, CurrenciesCollectionView, MenuUserInterfaceDemoView, StandardUserInterfaceDemoView, DetailsAndRelationsView, ErrorView, FooterView, GlobalSearchView, HeaderLinksView, HeaderView, ImageEditView, ImageFilesImportFromUrlView, ImageFilesUploadView, ImageModalSearchAndListAndUploadView, ImagePreviewView, InlineEditForPortletView, IntroView, LanguagesCollectionView, LoginView, MenuView, ModalMessageView, ModelNotFoundView, ModelRelationsSecuredPortletFrameView, ModelsToMergeListAndChartView, RecentlyViewedView, DynamicSearchRowView, MixedModelsSearchAndListView, MixedModelsSearchView, AccessFailureAjaxView, AccessFailureView, ActionBarForGroupEditAndDetailsView, ActionBarForSecurityTreeListView, GroupsModalTreeListView, GroupsTreeListView, RolesModalTreeListView, RolesTreeListView, ShortcutsCreateMenuView, SplashView, StepsAndProgressBarForWizardView, StickyDetailsAndRelationsBreadCrumbView, UnsupportedBrowserView, UserInterfaceChooserView, ViewIsMissingRequiredAttributesView, WizardModelRelationsAndAttributesTreeView, WizardTypeView, WizardView, ZeroModelsYetView, ZurmoDefaultView, and ZurmoExternalDefaultView.
| resolveCustomViewTemplateFileName | ( | $ | theme, | |
| $ | view | |||
| ) | [protected] |
