View Class Reference

Inheritance diagram for View:
AboutView AccessFailureAjaxView AccessFailureView AddressMapModalView AjaxPageView AttributesRedirectToContactsView BreadCrumbView CommentsForRelatedModelView ConfigurationView DynamicSearchRowView ErrorView FlashMessageView FlashMessageView FooterView GlobalSearchAndShortcutsCreateMenuView GlobalSearchView GridView HeaderLinksView HeaderView HomeDashboardPortletSelectionView HomeView ImportWizardMappingExtraColumnView InstallAccessFailureView InstallAdditionalCheckServicesView InstallCheckServicesView InstallCompleteView InstallDemoDataView InstallView InstallWelcomeView LoginView MenuView MetadataView MetadataViewEditView MixedModelsSearchAndListView MixedModelsSearchView ModalContainerView ModalGameNotificationContainerView ModalView ModelNotFoundView NoGlobalEmailConfigurationYetView NoUserEmailConfigurationYetView NullView PageView PortletRefreshView ProcessView ProgressView RecentlyViewedView ShortcutsCreateMenuView TestEmailMessageView TestImapConnectionMessageView TitleBarView UnsupportedBrowserView UpgradeStartCompleteView UpgradeStepOneCompleteView UpgradeStepTwoCompleteView ViewIsMissingRequiredAttributesView WelcomeView ZeroModelsYetView ZurmoDefaultView

Public Member Functions

 isUniqueToAPage ()
 render ()
 setCssClasses (array $classes)
 getCssClasses ()
 getTitle ()

Protected Member Functions

 getId ()
 renderContent ()
 getViewStyle ()
 renderTitleContent ()

Protected Attributes

 $cssClasses = array()
 $title

Detailed Description

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 33 of file View.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 in ActionBarAndListView, ActionBarForSearchAndListView, ActionBarSearchAndListView, AjaxPageView, CalendarView, ConfigurationView, FlashMessageView, GridView, InlineEditView, ModalConfigEditView, MyListView, NullView, RelatedListView, TitleBarView, AccountDetailsAndRelationsView, LatestActivitiesListView, CommentsForRelatedModelView, ConfigureModulesView, AnyContactSelectForEmailMatchingView, ContactDetailsAndRelationsView, ContactInlineCreateForArchivedEmailCreateView, ActionBarAndAttributeEditView, ActionBarAndModuleEditableMetadataCollectionView, ActionBarAndModuleEditView, ActionBarForDesignerModuleView, AttributeEditView, AttributesCollectionView, DesignerPageMenuView, MetadataViewEditView, ModuleEditableMetadataCollectionView, ModuleEditView, StandardAndCustomAttributesListView, TitleBarAndDesignerPageMenuView, ArchivedEmailMatchingView, EmailConfigurationListView, LeaderboardView, ModalGameNotificationContainerView, TitleBarAndLeaderboardView, HomeDashboardView, ImportWizardView, JobsCollectionView, AttributesRedirectToContactsView, LeadConvertView, LeadDetailsAndRelationsView, LeadsModuleAttributesListView, AddressMapModalView, DaysMeetingsFromCalendarModalListView, MissionsPortletListView, OpportunityDetailsAndRelationsView, RssReaderView, SocialItemsListView, ActionBarForUserEditAndDetailsView, UserDetailsAndRelationsView, UserGroupMembershipView, BreadCrumbView, ChartView, CurrenciesCollectionView, DevelopmentListView, FlashMessageView, LanguagesCollectionView, ModalContainerView, ModalSearchAndListView, ModelRelationsSecuredPortletFrameView, SearchAndListView, ActionBarForGroupEditAndDetailsView, ActionBarForSecurityTreeListView, GroupsActionBarAndTreeListView, GroupUserMembershipEditView, ModulePermissionsEditAndDetailsView, PoliciesEditAndDetailsView, RightsEditAndDetailsView, RolesActionBarAndTreeListView, RolesTitleBarAndTreeView, and TitleBarAndListView.

Definition at line 51 of file View.php.

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, GlobalSearchView, DynamicSearchRowView, AccessFailureAjaxView, and ShortcutsCreateMenuView.

Definition at line 68 of file View.php.

getId (  )  [protected]
Returns:
id of view if UniqueToAPage is false. Override if you want to pass an id in.

Reimplemented in CommentsForRelatedModelView.

Definition at line 123 of file View.php.

renderContent (  )  [abstract, protected]

Renders the view content.

Reimplemented in TestCompleteSequentialProcessView, ActionBarForSearchAndListView, AjaxPageView, CalendarView, ConfigurationView, ContainedViewCompleteSequentialProcessView, DetailsView, EditAndDetailsView, EditView, FlashMessageView, GridView, InlineEditView, ListView, MassDeleteProgressView, MassDeleteView, MassEditView, ModalConfigEditView, ModalView, NullView, PageView, PortletFrameView, PortletRefreshView, ProgressView, SearchView, SequentialProcessContainerView, SequentialProcessView, TitleBarView, AccountSelectView, LatestActivitiesListView, LatestActivtiesForPortletView, CommentsForRelatedModelView, ConfigureModulesMenuView, AnyContactSelectForEmailMatchingView, ActionBarForDesignerModuleView, AttributesCollectionView, DesignerPageMenuView, MetadataViewEditView, ModuleEditableMetadataCollectionView, ArchivedEmailMatchingView, NoGlobalEmailConfigurationYetView, NoUserEmailConfigurationYetView, TestEmailMessageView, TestImapConnectionMessageView, LeaderboardView, ModalGameNotificationContainerView, UserBadgesForPortletView, UserGamificationStatisticsForPortletView, UserLeaderboardRankingForPortletView, DashboardView, HomeDashboardPortletSelectionView, HomeView, WelcomeView, ImportSequentialProcessContainerView, ImportWizardMappingExtraColumnView, InstallAccessFailureView, InstallAdditionalCheckServicesView, InstallCheckServicesView, InstallCompleteView, InstallDemoDataView, InstallPageView, InstallSettingsView, InstallView, InstallWelcomeView, UpgradeStartCompleteView, UpgradeStepOneCompleteView, UpgradeStepTwoCompleteView, JobsCollectionView, AttributesRedirectToContactsView, LeadConvertAccountSkipView, LeadConvertView, AddressMapModalView, MissionsPortletListView, MyMissionsForPortletView, OpportunitiesBySourceChartView, OpportunitiesByStageChartView, RssReaderView, SocialItemsForPortletView, SocialItemsListView, ActionBarForUserEditAndDetailsView, UserGroupMembershipView, AboutView, BreadCrumbView, CurrenciesCollectionView, DetailsAndRelationsView, DetailsForPortletView, ErrorView, FlashMessageView, FooterView, GlobalSearchAndShortcutsCreateMenuView, GlobalSearchView, HeaderLinksView, HeaderView, InlineEditForPortletView, LanguagesCollectionView, LoginView, MenuView, ModalContainerView, ModelNotFoundView, ModelRelationsSecuredPortletFrameView, RecentlyViewedView, DynamicSearchRowView, MixedModelsSearchAndListView, MixedModelsSearchView, AccessFailureAjaxView, AccessFailureView, ActionBarForGroupEditAndDetailsView, ActionBarForSecurityTreeListView, GroupsModalTreeListView, GroupsTreeListView, RolesModalTreeListView, RolesTreeListView, ShortcutsCreateMenuView, StickyDetailsAndRelationsBreadCrumbView, UnsupportedBrowserView, ViewIsMissingRequiredAttributesView, ZeroModelsYetView, and ZurmoDefaultView.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sat May 25 01:25:14 2013