Class \Prado\Web\UI\WebControls\TWizard

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 \Prado\Web\UI\WebControls\getWizardSteps. 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:

Start : the first step in the wizard.
Step : the internal steps in the wizard.
Finish : the last step that allows user interaction.
Complete : the step that shows a summary to user (no interaction is allowed).
Auto : the step type is determined by wizard automatically. At any time, only one step is visible to end-users, which can be obtained by \Prado\Web\UI\WebControls\getActiveStep. Its index in the step collection is given by \Prado\Web\UI\WebControls\getActiveStepIndex.

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,

header: \Prado\Web\UI\WebControls\setHeaderText and \Prado\Web\UI\WebControls\setHeaderTemplate. If both are present, the latter takes precedence.
step: \Prado\Web\UI\WebControls\getWizardSteps.
navigation: \Prado\Web\UI\WebControls\setStartNavigationTemplate, \Prado\Web\UI\WebControls\setStepNavigationTemplate, \Prado\Web\UI\WebControls\setFinishNavigationTemplate. Default templates will be used if above templates are not set.
side bar: \Prado\Web\UI\WebControls\setSideBarTemplate. A default template will be used if this template is not set. Its visibility is toggled by \Prado\Web\UI\WebControls\setShowSideBar.

The style of these wizard layout components can be customized via the following style properties,

header: \Prado\Web\UI\WebControls\getHeaderStyle.
step: \Prado\Web\UI\WebControls\getStepStyle.
navigation: \Prado\Web\UI\WebControls\getNavigationStyle, \Prado\Web\UI\WebControls\getStartNextButtonStyle, \Prado\Web\UI\WebControls\getStepNextButtonStyle, \Prado\Web\UI\WebControls\getStepPreviousButtonStyle, \Prado\Web\UI\WebControls\getFinishPreviousButtonStyle, \Prado\Web\UI\WebControls\getFinishCompleteButtonStyle, \Prado\Web\UI\WebControls\getCancelButtonStyle.
side bar: \Prado\Web\UI\WebControls\getSideBarStyle and \Prado\Web\UI\WebControls\getSideBarButtonStyle.

Class hierarchy

\Prado\Web\UI\WebControls\TWizard implements INamingContainer

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`addedWizardStep(TWizardStep $step) : mixed` 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.
`public`	`addParsedObject(mixed $object) : mixed` Adds {@see \Prado\Web\UI\WebControls\TWizardStep} objects into step collection. This method overrides the parent implementation and is invoked when template is being instantiated.
`public`	`bubbleEvent(mixed $sender, TEventParameter $param) : mixed` Handles bubbled events. This method mainly translate certain command events into wizard-specific events.
`public`	`createChildControls() : mixed` Creates child controls within the wizard
`public`	`dataListItemCommand(mixed $sender, TDataListCommandEventParameter $param) : mixed` 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.
`public`	`dataListItemDataBound(mixed $sender, TDataListItemEventParameter $param) : mixed` Event handler for sidebar datalist's OnItemDataBound event. This method is used internally by wizard. It mainly configures the buttons in the sidebar datalist.
`public`	`getActiveStep() : TWizardStep`
`public`	`getActiveStepIndex() : int`
`public`	`getCancelButtonStyle() : TWizardNavigationButtonStyle`
`public`	`getCancelDestinationUrl() : string`
`public`	`getFinishCompleteButtonStyle() : TWizardNavigationButtonStyle`
`public`	`getFinishDestinationUrl() : string`
`public`	`getFinishNavigation() : TWizardNavigationContainer`
`public`	`getFinishNavigationTemplate() : ITemplate`
`public`	`getFinishPreviousButtonStyle() : TWizardNavigationButtonStyle`
`public`	`getHeader() : TPanel`
`public`	`getHeaderStyle() : TPanelStyle`
`public`	`getHeaderTemplate() : ITemplate`
`public`	`getHeaderText() : string`
`public`	`getMultiView() : TMultiView` Returns the multiview that holds the wizard steps. This method should only be used by control developers.
`public`	`getNavigationButtonStyle() : TStyle`
`public`	`getNavigationStyle() : TPanelStyle`
`public`	`getShowCancelButton() : bool`
`public`	`getShowSideBar() : bool`
`public`	`getSideBar() : TPanel`
`public`	`getSideBarButtonStyle() : TStyle`
`public`	`getSideBarStyle() : TPanelStyle`
`public`	`getSideBarTemplate() : ITemplate`
`public`	`getStartNavigation() : TWizardNavigationContainer`
`public`	`getStartNavigationTemplate() : ITemplate`
`public`	`getStartNextButtonStyle() : TWizardNavigationButtonStyle`
`public`	`getStepContent() : TPanel`
`public`	`getStepNavigation() : TWizardNavigationContainer`
`public`	`getStepNavigationTemplate() : ITemplate`
`public`	`getStepNextButtonStyle() : TWizardNavigationButtonStyle`
`public`	`getStepPreviousButtonStyle() : TWizardNavigationButtonStyle`
`public`	`getStepStyle() : TPanelStyle`
`public`	`getUseDefaultLayout() : bool`
`public`	`getWizardSteps() : TWizardStepCollection`
`public`	`onActiveStepChanged(TEventParameter $param) : mixed` Raises <b>OnActiveStepChanged</b> event. This event is raised when the current visible step is changed in the wizard.
`public`	`onCancelButtonClick(TEventParameter $param) : mixed` Raises <b>OnCancelButtonClick</b> event. This event is raised when a cancel navigation button is clicked in the current active step.
`public`	`onCompleteButtonClick(TWizardNavigationEventParameter $param) : mixed` Raises <b>OnCompleteButtonClick</b> event. This event is raised when a finish navigation button is clicked in the current active step.
`public`	`onInit(TEventParameter $param) : mixed` Creates the child controls of the wizard. This method overrides the parent implementation.
`public`	`onNextButtonClick(TWizardNavigationEventParameter $param) : mixed` Raises <b>OnNextButtonClick</b> event. This event is raised when a next navigation button is clicked in the current active step.
`public`	`onPreviousButtonClick(TWizardNavigationEventParameter $param) : mixed` Raises <b>OnPreviousButtonClick</b> event. This event is raised when a previous navigation button is clicked in the current active step.
`public`	`onSideBarButtonClick(TWizardNavigationEventParameter $param) : mixed` Raises <b>OnSideBarButtonClick</b> event. This event is raised when a link button in the side bar is clicked.
`public`	`removedWizardStep(TWizardStep $step) : mixed` 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.
`public`	`render(THtmlWriter $writer) : mixed` Renders the wizard.
`public`	`saveState() : mixed` Saves the current active step index into history. This method is invoked by the framework when the control state is being saved.
`public`	`setActiveStep(TWizardStep $step) : mixed`
`public`	`setActiveStepIndex(int $value) : mixed`
`public`	`setCancelDestinationUrl(string $value) : mixed`
`public`	`setFinishDestinationUrl(string $value) : mixed`
`public`	`setFinishNavigationTemplate(ITemplate $value) : mixed`
`public`	`setHeaderTemplate(ITemplate $value) : mixed`
`public`	`setHeaderText(string $value) : mixed`
`public`	`setShowCancelButton(bool $value) : mixed`
`public`	`setShowSideBar(bool $value) : mixed`
`public`	`setSideBarTemplate(ITemplate $value) : mixed`
`public`	`setStartNavigationTemplate(ITemplate $value) : mixed`
`public`	`setStepNavigationTemplate(ITemplate $value) : mixed`
`public`	`setUseDefaultLayout(bool $value) : mixed`
`public`	`wizardStepsChanged() : mixed` Updates the sidebar datalist if any. This method is invoked when any wizard step is changed.
`protected`	`allowNavigationToPreviousStep() : bool`
`protected`	`allowNavigationToStep(int $index) : bool`
`protected`	`applyControlProperties() : mixed` Applies various properties to the components of wizard
`protected`	`applyHeaderProperties() : mixed` Applies properties to the wizard header
`protected`	`applyNavigationProperties() : mixed` Apply properties to various navigation panels.
`protected`	`applySideBarProperties() : mixed` Applies properties to the wizard sidebar
`protected`	`applyStepContentProperties() : mixed` Applies properties to the wizard step content
`protected`	`createFinishNavigation() : mixed` Creates finish navigation panel.
`protected`	`createHeader() : mixed` Creates the wizard header.
`protected`	`createNavigation() : mixed` Creates navigation panel.
`protected`	`createSideBar() : mixed` Creates the wizard side bar
`protected`	`createStartNavigation() : mixed` Creates start navigation panel.
`protected`	`createStepContent() : mixed` Creates wizard step content.
`protected`	`createStepNavigation() : mixed` Creates step navigation panel.
`protected`	`getHistory() : TStack`
`protected`	`getPreviousStepIndex(bool $popStack) : mixed` Determines the index of the previous step based on history.
`protected`	`getStepType(TWizardStep $wizardStep) : mixed` Determines the type of the specified wizard step.
`protected`	`getTagName() : string` Returns the tag name used for this control.
`protected`	`requiresControlsRecreation() : mixed` Indicates the wizard needs to recreate all child controls.
`protected`	`reset() : mixed` Clears up everything within the wizard.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getClassHierarchy, getClientID, getControls, getCssClass, getCustomData, getDecorator, getDisplay, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getListeningToGlobalEvents, getNamingContainer, getPage, getParent, getPluginModule, getRegisteredObject, getRequest, getResponse, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getToolTip, getUniqueID, getUser, getViewState, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onInit, onLoad, onPreRender, onUnload, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAttribute, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCssClass, setCustomData, setDisplay, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setToolTip, setViewState, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createStyle, dataBindChildren, dataBindProperties, getCallChain, getChildControlsCreated, getClassFxEvents, getControlStage, getControlState, getTagName, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, preRenderRecursive, raiseBubbleEvent, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, traverseChildControls, unloadRecursive, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID

Constants summary
`public mixed`	`CMD_CANCEL`	`'Cancel'`
`public mixed`	`CMD_COMPLETE`	`'Complete'`
`public mixed`	`CMD_MOVETO`	`'MoveTo'`
`public mixed`	`CMD_NEXT`	`'NextStep'`
`public mixed`	`CMD_PREVIOUS` Navigation commands.	`'PreviousStep'`
`public mixed`	`ID_SIDEBAR_BUTTON` Side bar button ID	`'SideBarButton'`
`public mixed`	`ID_SIDEBAR_LIST` Side bar data list	`'SideBarList'`

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TWizard

Class hierarchy