Class TActiveMultiView

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TMultiView
            |
            --TActiveMultiView

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.

Constants Inherited From TMultiView
CMD_NEXTVIEW, CMD_PREVIOUSVIEW, CMD_SWITCHVIEWID, CMD_SWITCHVIEWINDEX,

Constants Inherited From TControl

AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID,

Constructor Summary
public	__construct Creates a new callback control, sets the adapter to TActiveControlAdapter.

Method Summary
TBaseActiveControl	getActiveControl ()
protected string	getContainerID () Returns the id of the surrounding container (span).
void	render ( THtmlWriter $writer) Renders the TActiveMultiView.
protected void	renderMultiView ( $writer $writer) 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.
void	setActiveView ( TView $value)
void	setActiveViewIndex ( integer $value)

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()

Methods Inherited From TControl

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::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()

Methods Inherited From TApplicationComponent
TApplicationComponent::getApplication(), TApplicationComponent::getRequest(), TApplicationComponent::getResponse(), TApplicationComponent::getService(), TApplicationComponent::getSession(), TApplicationComponent::getUser(), TApplicationComponent::publishAsset(), TApplicationComponent::publishFilePath()

Methods 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::__get(), TComponent::__set()

Constant Summary

Constructor Details

__construct

public __construct

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

Method Details

getActiveControl

public TBaseActiveControl getActiveControl

()

Output
TBaseActiveControl	standard active control options.
Exception

getContainerID

protected string getContainerID

()

Returns the id of the surrounding container (span).

Output
string	container id
Exception

render

public void render

(THtmlWriter $writer )

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.

Input
THtmlWriter	$writer	writer for the rendering purpose
Output
Exception

renderMultiView

protected void renderMultiView

($writer $writer )

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.

Input
$writer	$writer	THtmlWriter writer for the rendering purpose
Output
Exception

setActiveView

public void setActiveView

(TView $value )

Input
TView	$value	the view to be activated
Output
Exception
throws	TInvalidOperationException if the view is not in the view collection

setActiveViewIndex

public void setActiveViewIndex

(integer $value )

Input
integer	$value	the zero-based index of the current view in the view collection. -1 if no active view.
Output
Exception
throws	TInvalidDataValueException if the view index is invalid