Implements interfaces:
Class TWizard.
TWizard splits a large form and presents the user with a series of smaller forms to complete. TWizard is analogous to the installation wizard commonly used to install software in Windows.
The smaller forms are called wizard steps (TWizardStep, which can be accessed via WizardSteps. In template, wizard steps can be added into a wizard using the following syntax,
- <com:TWizard>
- <com:TWizardStep Title="step 1">
- content in step 1, may contain other controls
- </com:TWizardStep>
- <com:TWizardStep Title="step 2">
- content in step 2, may contain other controls
- </com:TWizardStep>
- </com:TWizard>
Each wizard step can be one of the following types:
Wizard content can be customized in many ways.
The layout of a wizard consists of four parts: header, step content, navigation and side bar. Their content are affected by the following properties, respectively,
Located in /Web/UI/WebControls/TWizard.php (line 84)
TComponent | --TApplicationComponent | --TControl | --TWebControl | --TWizard
Adds a wizard step to the multiview.
This method should only be used by control developers. It is invoked when a step is added into the step collection of the wizard.
Adds TWizardStep objects into step collection.
This method overrides the parent implementation and is invoked when template is being instantiated.
Applies various properties to the components of wizard
Applies properties to the wizard header
Apply properties to various navigation panels.
Applies properties to the wizard sidebar
Applies properties to the wizard step content
Handles bubbled events.
This method mainly translate certain command events into wizard-specific events.
Creates child controls within the wizard
Creates finish navigation panel.
Creates the wizard header.
Creates navigation panel.
Creates the wizard side bar
Creates start navigation panel.
Creates wizard step content.
Creates step navigation panel.
Event handler for sidebar datalist's OnItemCommand event.
This method is used internally by wizard. It mainly sets the active step index according to the button clicked in the sidebar.
Event handler for sidebar datalist's OnItemDataBound event.
This method is used internally by wizard. It mainly configures the buttons in the sidebar datalist.
Determines the index of the previous step based on history.
Raises OnActiveStepChanged event.
This event is raised when the current visible step is changed in the wizard.
Raises OnCancelButtonClick event.
This event is raised when a cancel navigation button is clicked in the current active step.
Raises OnCompleteButtonClick event.
This event is raised when a finish navigation button is clicked in the current active step.
Creates the child controls of the wizard.
This method overrides the parent implementation.
Raises OnNextButtonClick event.
This event is raised when a next navigation button is clicked in the current active step.
Raises OnPreviousButtonClick event.
This event is raised when a previous navigation button is clicked in the current active step.
Raises OnSideBarButtonClick event.
This event is raised when a link button in the side bar is clicked.
Removes a wizard step from the multiview.
This method should only be used by control developers. It is invoked when a step is removed from the step collection of the wizard.
Renders the wizard.
Indicates the wizard needs to recreate all child controls.
Clears up everything within the wizard.
Saves the current active step index into history.
This method is invoked by the framework when the control state is being saved.
Updates the sidebar datalist if any.
This method is invoked when any wizard step is changed.
Inherited From TWebControl
TWebControl::addAttributesToRender()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()
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()
CMD_CANCEL
= 'Cancel'
(line 99)
CMD_COMPLETE
= 'Complete'
(line 100)
CMD_MOVETO
= 'MoveTo'
(line 101)
CMD_NEXT
= 'NextStep'
(line 98)
CMD_PREVIOUS
= 'PreviousStep'
(line 97)
Navigation commands.
ID_SIDEBAR_BUTTON
= 'SideBarButton'
(line 105)
Side bar button ID
ID_SIDEBAR_LIST
= 'SideBarList'
(line 109)
Side bar data list
ST_AUTO
= 'Auto'
(line 89)
Wizard step types.
ST_COMPLETE
= 'Complete'
(line 93)
ST_FINISH
= 'Finish'
(line 92)
ST_START
= 'Start'
(line 90)
ST_STEP
= 'Step'
(line 91)
Inherited from TControl
Documentation generated on Sun, 04 Jun 2006 19:00:42 -0400 by phpDocumentor 1.3.0RC4