Class X2Widget

Base widget class for all of X2Engine's widgets

CComponent

Extended by

CBaseController

Extended by

CWidget

Extended by

X2Widget

Direct known subclasses

ActionMenu, ActiveDateRangeInput, InlineActionForm, InlineEmailForm, InlineQuotes, MediaBox, MediaSelector, MenuList, MessageBox, MobileLayoutRenderer, MultiTypeAutocomplete, NoteBox, Attachments, OnlineUsers, Panel, Publisher, PublisherTab, QuickContact, RecordAliasesWidget, RecordView, RecordViewLayoutManager, Reminders, SmallCalendar, ChatBox, SocialForm, SortableWidget, SortableWidgetManager, TagCloud, TimeZone, TopSites, TwitterFeed, WebFormDesigner, X2ConditionList, X2ModelConversionWidget, ContactMapInlineTags, X2PillBox, X2ProgressBar, X2WidgetList, CronForm, DocViewer, EmailProgressControl, FileUploader, History

Indirect known subclasses

AccountsGridViewProfileWidget, ActionsGridViewProfileWidget, EmailsWidget, EventsChartProfileWidget, EventsWidget, FormView, GridViewWidget, IframeWidget, InlineRelationshipsWidget, InlineTagsWidget, LoggedTimeWidget, MarketingGridViewProfileWidget, ActionsWidget, MobileFormLayoutRenderer, MobileViewLayoutRenderer, ModelFileUploader, NewWebLeadsGridViewProfileWidget, OpportunitiesGridViewProfileWidget, ProfileGridViewWidget, ProfilesGridViewProfileWidget, PublisherActionTab, PublisherCalendarEventTab, PublisherCallTab, CallsWidget, PublisherCommentTab, PublisherEventTab, PublisherSmallCalendarEventTab, PublisherTimeTab, PublisherWidget, QuotesGridViewProfileWidget, QuotesWidget, RecordViewWidgetManager, ServicesGridViewProfileWidget, ServiceWebFormDesigner, ChartWidget, TemplatesGridViewProfileWidget, TransactionalViewWidget, TwitterFeedWidget, TwoColumnSortableWidgetManager, UsersChartProfileWidget, WebActivityWidget, WebLeadFormDesigner, WorkflowStageDetailsWidget, X2LeadsGridViewProfileWidget, CommentsWidget, ContactsGridViewProfileWidget, DetailView, DocsGridViewProfileWidget, DocViewerProfileWidget

Abstract
Package: application\components
Located at x2engine/protected/components/X2Widget.php

Methods summary
`public`	# `__construct( CBaseController $owner = null )` Constructor. Constructor. Parameters `$owner` `CBaseController` $owner owner/creator of this widget. It could be either a widget or a controller. Overrides `CWidget::__construct()`
`public`	# `behaviors( )`
`public string`	# `renderFile( string $viewFile, array $data = null, boolean $return = false )` Renders a view file. Overrides CBaseController::renderFile to check if the requested view has a version in /custom, and uses that if it exists. Renders a view file. Overrides CBaseController::renderFile to check if the requested view has a version in /custom, and uses that if it exists. Parameters `$viewFile` `string` $viewFile view file path `$data` `array` $data data to be extracted and made available to the view `$return` `boolean` $return whether the rendering result should be returned instead of being echoed Returns `string` the rendering result. Null if the rendering result is not required. Throws `CException` if the view file does not exist Overrides `CBaseController::renderFile()`
`public static`	# `ajaxRender( function $function, mixed $return = false )` Runs an arbitrary function inside a partial view. All scripts registered get processed. Allows scripts associated with a widget to be returned in AJAX response. Runs an arbitrary function inside a partial view. All scripts registered get processed. Allows scripts associated with a widget to be returned in AJAX response. Parameters `$function` `function` $function `$return`
`public type`	# `getModule( )` Getter for module. Getter for module. Can automatically recognize when a component is a member of a module's collection of components. Returns `type`
`public`	# `setModule( mixed $moduleName )`
`public`	# `init( )` Initializes the widget. This method is called by CBaseController::createWidget and CBaseController::beginWidget after the widget's properties have been initialized. Initializes the widget. This method is called by CBaseController::createWidget and CBaseController::beginWidget after the widget's properties have been initialized. Overrides `CWidget::init()`

Methods inherited from CWidget
`actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), run(), 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()`

Properties summary
`protected mixed`	`$_module`		#

Properties inherited from CWidget
`$actionPrefix, $skin`

Magic properties summary
`public X2WebModule`	`$module`	#

Magic properties inherited from CWidget
`$controller, $id, $owner, $viewPath`