Class TActiveMultiView

Description

Implements interfaces:

TActiveMultiView class.

TActiveMultiView is the active counterpart to the original TMultiView control. It re-renders on Callback when ActiveView or ActiveViewIndex is called.

Please refer to the original documentation of the regular counterpart for usage.

Located in /Web/UI/ActiveControls/TActiveMultiView.php (line 30)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TMultiView
            |
            --TActiveMultiView
Method Summary
TActiveMultiView __construct ()
string getContainerID ()
void render (THtmlWriter $writer)
void renderMultiView ($writer $writer)
void setActiveView (TView $value)
void setActiveViewIndex (integer $value)
Methods
Constructor __construct (line 36)

Creates a new callback control, sets the adapter to TActiveControlAdapter.

  • access: public
TActiveMultiView __construct ()

Redefinition of:
TControl::__construct()
Constructor.
getActiveControl (line 45)
  • return: standard active control options.
  • access: public
TBaseActiveControl getActiveControl ()
getContainerID (line 54)

Returns the id of the surrounding container (span).

  • return: container id
  • access: protected
string getContainerID ()
render (line 65)

Renders the TActiveMultiView.

If the MutliView did not pass the prerender phase yet, it will register itself for rendering later. Else it will call the renderMultiView() method which will do the rendering of the MultiView.

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

Redefinition of:
TMultiView::render()
Renders the currently active view.
renderMultiView (line 81)

Renders the TActiveMultiView by writing a span tag with the container id obtained from getContainerID() which will be called by the replacement method of the client script to update it's content.

  • access: protected
void renderMultiView ($writer $writer)
  • $writer $writer: THtmlWriter writer for the rendering purpose
setActiveView (line 105)
  • throws: TInvalidOperationException if the view is not in the view collection
  • access: public
void setActiveView (TView $value)
  • TView $value: the view to be activated

Redefinition of:
TMultiView::setActiveView()
setActiveViewIndex (line 93)
  • throws: TInvalidDataValueException if the view index is invalid
  • access: public
void setActiveViewIndex (integer $value)
  • integer $value: the zero-based index of the current view in the view collection. -1 if no active view.

Redefinition of:
TMultiView::setActiveViewIndex()

Inherited Methods

Inherited From TMultiView

TMultiView::activateView()
TMultiView::addParsedObject()
TMultiView::bubbleEvent()
TMultiView::createControlCollection()
TMultiView::getActiveView()
TMultiView::getActiveViewIndex()
TMultiView::getViews()
TMultiView::ignoreBubbleEvents()
TMultiView::loadState()
TMultiView::onActiveViewChanged()
TMultiView::onInit()
TMultiView::render()
TMultiView::setActiveView()
TMultiView::setActiveViewIndex()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::convertUniqueIdToClientId()
TControl::createChildControls()
TControl::createControlCollection()
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::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
TControl::getID()
TControl::getIsSkinApplied()
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::setCustomData()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::trackViewState()
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::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()
Class Constants

Documentation generated on Mon, 25 Jun 2012 14:37:05 +0200 by phpDocumentor 1.4.3