Class TMultiView

Description

TMultiView class

TMultiView serves as a container for a group of TView controls. The view collection can be retrieved by Views. Each view contains child controls. TMultiView determines which view and its child controls are visible. At any time, at most one view is visible (called active). To make a view active, set ActiveView or ActiveViewIndex.

TMultiView also responds to specific command events raised from button controls contained in current active view. A command event with name 'NextView' will cause TMultiView to make the next available view active. Other command names recognized by TMultiView include

  • PreviousView : switch to previous view
  • SwitchViewID : switch to a view by its ID path
  • SwitchViewIndex : switch to a view by its index in the Views collection.
TMultiView raises OnActiveViewChanged event when its active view is changed during a postback.

Located in /Web/UI/WebControls/TMultiView.php (line 39)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TMultiView
Class Constant Summary
 CMD_NEXTVIEW = 'NextView'
 CMD_PREVIOUSVIEW = 'PreviousView'
 CMD_SWITCHVIEWID = 'SwitchViewID'
 CMD_SWITCHVIEWINDEX = 'SwitchViewIndex'
Method Summary
void activateView (TView $view, [boolean $triggerViewChangedEvent = true])
void addParsedObject (string|TComponent $object)
boolean bubbleEvent (TControl $sender, mixed $param)
integer getActiveViewIndex ()
void loadState ()
void onInit (TEventParameter $param)
void render (THtmlWriter $writer)
void setActiveView (TView $view)
void setActiveViewIndex (integer $value)
Methods
activateView (line 143)

Activates the specified view.

If there is any view currently active, it will be deactivated.

  • access: protected
void activateView (TView $view, [boolean $triggerViewChangedEvent = true])
  • TView $view: the view to be activated
  • boolean $triggerViewChangedEvent: whether to trigger OnActiveViewChanged event.
addParsedObject (line 56)

Processes an object that is created during parsing template.

This method overrides the parent implementation by adding only TView controls as children.

void addParsedObject (string|TComponent $object)
  • string|TComponent $object: text string or component parsed and instantiated in template

Redefinition of:
TControl::addParsedObject()
Processes an object that is created during parsing template.
bubbleEvent (line 216)

Processes the events bubbled from child controls.

The method handles view-related command events.

  • return: whether this event is handled
  • access: public
boolean bubbleEvent (TControl $sender, mixed $param)
  • TControl $sender: sender of the event
  • mixed $param: event parameter

Redefinition of:
TControl::bubbleEvent()
This method responds to a bubbled event.
createControlCollection (line 68)

Creates a control collection object that is to be used to hold child controls

  • return: control collection
  • access: protected
TViewCollection createControlCollection ()

Redefinition of:
TControl::createControlCollection()
Creates a control collection object that is to be used to hold child controls
getActiveView (line 111)
  • return: the currently active view, null if no active view
  • access: public
  • throws: TInvalidDataValueException if the current active view index is invalid
TView getActiveView ()
getActiveViewIndex (line 76)
  • return: the zero-based index of the current view in the view collection. -1 if no active view. Default is -1.
  • access: public
integer getActiveViewIndex ()
getViews (line 172)
  • return: the view collection
  • access: public
TViewCollection getViews ()
ignoreBubbleEvents (line 182)

Makes the multiview ignore all bubbled events.

This is method is used internally by framework and control developers.

  • access: public
void ignoreBubbleEvents ()
loadState (line 254)

Loads state into the wizard.

This method is invoked by the framework when the control state is being saved.

  • access: public
void loadState ()

Redefinition of:
TControl::loadState()
This method is invoked right after the control has loaded its state.
onActiveViewChanged (line 204)

Raises OnActiveViewChanged event.

The event is raised when the currently active view is changed to a new one

  • access: public
void onActiveViewChanged (TEventParameter $param)
onInit (line 192)

Initializes the active view if any.

This method overrides the parent implementation.

  • access: public
void onInit (TEventParameter $param)

Redefinition of:
TControl::onInit()
This method is invoked when the control enters 'OnInit' stage.
render (line 264)

Renders the currently active view.

  • access: public
void render (THtmlWriter $writer)
  • THtmlWriter $writer: the writer for the rendering purpose.

Redefinition of:
TControl::render()
Renders the control.
setActiveView (line 129)
  • access: public
  • throws: TInvalidOperationException if the view is not in the view collection
void setActiveView (TView $view)
  • TView $view: the view to be activated
setActiveViewIndex (line 88)
  • access: public
  • throws: TInvalidDataValueException if the view index is invalid
void setActiveViewIndex (integer $value)
  • integer $value: the zero-based index of the current view in the view collection. -1 if no active view.

Inherited Methods

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::broadcastEventInternal()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::createChildControls()
TControl::createControlCollection()
TControl::createdOnTemplate()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasControls()
TControl::getID()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()
Class Constants
CMD_NEXTVIEW = 'NextView' (line 41)
CMD_PREVIOUSVIEW = 'PreviousView' (line 42)
CMD_SWITCHVIEWID = 'SwitchViewID' (line 43)
CMD_SWITCHVIEWINDEX = 'SwitchViewIndex' (line 44)

Inherited Constants

Inherited from TControl

Documentation generated on Sun, 04 Jun 2006 18:59:55 -0400 by phpDocumentor 1.3.0RC4