content in step 1, may contain other controls
content in step 2, may contain other controls
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 {@link getActiveStep ActiveStep}. Its index in the step collection is given by
{@link getActiveStepIndex ActiveStepIndex}.
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: {@link setHeaderText HeaderText} and {@link setHeaderTemplate HeaderTemplate}.
If both are present, the latter takes precedence.
- step: {@link getWizardSteps WizardSteps}.
- navigation: {@link setStartNavigationTemplate StartNavigationTemplate},
{@link setStepNavigationTemplate StepNavigationTemplate},
{@link setFinishNavigationTemplate FinishNavigationTemplate}.
Default templates will be used if above templates are not set.
- side bar: {@link setSideBarTemplate SideBarTemplate}.
A default template will be used if this template is not set.
Its visibility is toggled by {@link setShowSideBar ShowSideBar}.
The style of these wizard layout components can be customized via the following style properties,
- header: {@link getHeaderStyle HeaderStyle}.
- step: {@link getStepStyle StepStyle}.
- navigation: {@link getNavigationStyle NavigationStyle},
{@link getStartNextButtonStyle StartNextButtonStyle},
{@link getStepNextButtonStyle StepNextButtonStyle},
{@link getStepPreviousButtonStyle StepPreviousButtonStyle},
{@link getFinishPreviousButtonStyle FinishPreviousButtonStyle},
{@link getFinishCompleteButtonStyle FinishCompleteButtonStyle},
{@link getCancelButtonStyle CancelButtonStyle}.
- side bar: {@link getSideBarStyle SideBarStyle} and {@link getSideBarButtonStyle SideBarButtonStyle}.
Datei anzeigen
Open project: pradosoft/prado
Class Usage Examples
| Method | Description | |
|---|---|---|
| addParsedObject ( $object ) | Adds {@link TWizardStep} objects into step collection. | |
| addedWizardStep ( $step ) | Adds a wizard step to the multiview. | |
| bubbleEvent ( $sender, $param ) | Handles bubbled events. | |
| createChildControls ( ) | Creates child controls within the wizard | |
| dataListItemCommand ( $sender, $param ) | Event handler for sidebar datalist's OnItemCommand event. | |
| dataListItemDataBound ( $sender, $param ) | Event handler for sidebar datalist's OnItemDataBound event. | |
|
getActiveStep ( ) : |
||
| getActiveStepIndex ( ) : integer | ||
|
getCancelButtonStyle ( ) : |
||
| getCancelDestinationUrl ( ) : string | ||
|
getFinishCompleteButtonStyle ( ) : |
||
| getFinishDestinationUrl ( ) : string | ||
|
getFinishNavigation ( ) : |
||
| getFinishNavigationTemplate ( ) : ITemplate | ||
|
getFinishPreviousButtonStyle ( ) : |
||
|
getHeader ( ) : |
||
|
getHeaderStyle ( ) : |
||
| getHeaderTemplate ( ) : ITemplate | ||
| getHeaderText ( ) : string | ||
|
getMultiView ( ) : |
Returns the multiview that holds the wizard steps. | |
|
getNavigationButtonStyle ( ) : |
||
|
getNavigationStyle ( ) : |
||
| getShowCancelButton ( ) : boolean | ||
| getShowSideBar ( ) : boolean | ||
|
getSideBar ( ) : |
||
|
getSideBarButtonStyle ( ) : |
||
|
getSideBarStyle ( ) : |
||
| getSideBarTemplate ( ) : ITemplate | ||
|
getStartNavigation ( ) : |
||
| getStartNavigationTemplate ( ) : ITemplate | ||
|
getStartNextButtonStyle ( ) : |
||
|
getStepContent ( ) : |
||
|
getStepNavigation ( ) : |
||
| getStepNavigationTemplate ( ) : ITemplate | ||
|
getStepNextButtonStyle ( ) : |
||
|
getStepPreviousButtonStyle ( ) : |
||
|
getStepStyle ( ) : |
||
| getUseDefaultLayout ( ) : boolean | ||
|
getWizardSteps ( ) : |
||
| onActiveStepChanged ( $param ) | Raises OnActiveStepChanged event. | |
| onCancelButtonClick ( $param ) | Raises OnCancelButtonClick event. | |
| onCompleteButtonClick ( $param ) | Raises OnCompleteButtonClick event. | |
| onInit ( $param ) | Creates the child controls of the wizard. | |
| onNextButtonClick ( $param ) | Raises OnNextButtonClick event. | |
| onPreviousButtonClick ( $param ) | Raises OnPreviousButtonClick event. | |
| onSideBarButtonClick ( $param ) | Raises OnSideBarButtonClick event. | |
| removedWizardStep ( $step ) | Removes a wizard step from the multiview. | |
| render ( $writer ) | Renders the wizard. | |
| saveState ( ) | Saves the current active step index into history. | |
| setActiveStep ( $step ) | ||
| setActiveStepIndex ( $value ) | ||
| setCancelDestinationUrl ( $value ) | ||
| setFinishDestinationUrl ( $value ) | ||
| setFinishNavigationTemplate ( $value ) | ||
| setHeaderTemplate ( $value ) | ||
| setHeaderText ( $value ) | ||
| setShowCancelButton ( $value ) | ||
| setShowSideBar ( $value ) | ||
| setSideBarTemplate ( $value ) | ||
| setStartNavigationTemplate ( $value ) | ||
| setStepNavigationTemplate ( $value ) | ||
| setUseDefaultLayout ( $value ) | ||
| wizardStepsChanged ( ) | Updates the sidebar datalist if any. |
| Method | Description | |
|---|---|---|
| allowNavigationToPreviousStep ( ) : boolean | ||
| allowNavigationToStep ( $index ) : boolean | ||
| applyControlProperties ( ) | Applies various properties to the components of wizard | |
| applyHeaderProperties ( ) | Applies properties to the wizard header | |
| applyNavigationProperties ( ) | Apply properties to various navigation panels. | |
| applySideBarProperties ( ) | Applies properties to the wizard sidebar | |
| applyStepContentProperties ( ) | Applies properties to the wizard step content | |
| createFinishNavigation ( ) | Creates finish navigation panel. | |
| createHeader ( ) | Creates the wizard header. | |
| createNavigation ( ) | Creates navigation panel. | |
| createSideBar ( ) | Creates the wizard side bar | |
| createStartNavigation ( ) | Creates start navigation panel. | |
| createStepContent ( ) | Creates wizard step content. | |
| createStepNavigation ( ) | Creates step navigation panel. | |
|
getHistory ( ) : |
||
| getPreviousStepIndex ( $popStack ) | Determines the index of the previous step based on history. | |
|
getStepType ( $wizardStep ) : |
Determines the type of the specified wizard step. | |
| getTagName ( ) : string | ||
| requiresControlsRecreation ( ) | Indicates the wizard needs to recreate all child controls. | |
| reset ( ) | Clears up everything within the wizard. |
| public addParsedObject ( $object ) |
| public addedWizardStep ( $step ) |
| protected applyControlProperties ( ) |
| protected applyHeaderProperties ( ) |
| protected applySideBarProperties ( ) |
| protected applyStepContentProperties ( ) |
| public bubbleEvent ( $sender, $param ) |
| public createChildControls ( ) |
| public dataListItemCommand ( $sender, $param ) |
| public dataListItemDataBound ( $sender, $param ) |
|
public getActiveStep ( ) : |
||
| return | the currently active wizard step | |
| public getActiveStepIndex ( ) : integer | ||
| return | integer | the zero-based index of the active wizard step |
|
public getCancelButtonStyle ( ) : |
||
| return | the style for the cancel button | |
| public getCancelDestinationUrl ( ) : string | ||
| return | string | the URL that the browser will be redirected to if the cancel button in the wizard is clicked. Defaults to ''. |
|
public getFinishCompleteButtonStyle ( ) : |
||
| return | the style for the complete button in the finish wizard step. | |
| public getFinishDestinationUrl ( ) : string | ||
| return | string | the URL that the browser will be redirected to if the wizard finishes. Defaults to ''. |
|
public getFinishPreviousButtonStyle ( ) : |
||
| return | the style for the previous button in the start wizard step. | |
|
public getHeader ( ) : |
||
| return | container of the wizard header | |
|
public getHeaderStyle ( ) : |
||
| return | the style for the header. | |
| public getHeaderTemplate ( ) : ITemplate | ||
| return | ITemplate | template for wizard header. Defaults to null. |
| public getHeaderText ( ) : string | ||
| return | string | header text. Defaults to ''. |
|
protected getHistory ( ) : |
||
| return | history containing step indexes that were navigated before | |
|
public getMultiView ( ) : |
||
| return | the multiview holding wizard steps | |
| protected getPreviousStepIndex ( $popStack ) |
| public getShowCancelButton ( ) : boolean | ||
| return | boolean | whether to display a cancel button in each wizard step. Defaults to false. |
| public getShowSideBar ( ) : boolean | ||
| return | boolean | whether to display a side bar that contains links to wizard steps. Defaults to true. |
|
public getSideBar ( ) : |
||
| return | container of the wizard side bar | |
|
public getSideBarButtonStyle ( ) : |
||
| return | the style for the buttons displayed in the side bar. | |
|
public getSideBarStyle ( ) : |
||
| return | the style for the side bar. | |
| public getSideBarTemplate ( ) : ITemplate | ||
| return | ITemplate | template for the side bar. Defaults to null. |
|
public getStartNextButtonStyle ( ) : |
||
| return | the style for the next button in the start wizard step. | |
|
public getStepContent ( ) : |
||
| return | container of the wizard step content | |
|
public getStepNextButtonStyle ( ) : |
||
| return | the style for the next button in each internal wizard step. | |
|
public getStepPreviousButtonStyle ( ) : |
||
| return | the style for the previous button in the start wizard step. | |
|
public getStepStyle ( ) : |
||
| return | the style for each internal wizard step. | |
|
protected getStepType ( $wizardStep ) : |
||
| return | type of the step | |
| protected getTagName ( ) : string | ||
| return | string | tag name for the wizard |
| public getUseDefaultLayout ( ) : boolean | ||
| return | boolean | whether to use default layout to arrange side bar and the rest wizard components. Defaults to true. |
|
public getWizardSteps ( ) : |
||
| return | collection of wizard steps | |
| public onActiveStepChanged ( $param ) |
| public onCancelButtonClick ( $param ) |
| public onCompleteButtonClick ( $param ) |
| public onNextButtonClick ( $param ) |
| public onPreviousButtonClick ( $param ) |
| public onSideBarButtonClick ( $param ) |
| public removedWizardStep ( $step ) |
| protected requiresControlsRecreation ( ) |
| public saveState ( ) |
| public wizardStepsChanged ( ) |
