PRADO 3.0.6 : Vue détaillée de TWizard.php

Classe: TWizard - X-Ref

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 ({@link TWizardStep}, which can be accessed via
{@link getWizardSteps WizardSteps}. In template, wizard steps can be added
into a wizard using the following syntax,
<code>
<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>
</code>

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}.

getTagName() X-Ref

return: string tag name for the wizard

addParsedObject($object) X-Ref

Adds {@link TWizardStep} objects into step collection.
This method overrides the parent implementation and is
invoked when template is being instantiated.

param: mixed object instantiated in template

getActiveStep() X-Ref

return: TWizardStep the currently active wizard step

setActiveStep($step) X-Ref

param: TWizardStep step to be activated

getActiveStepIndex() X-Ref

return: integer the zero-based index of the active wizard step

setActiveStepIndex($value) X-Ref

param: integer the zero-based index of the wizard step to be activated

getWizardSteps() X-Ref

return: TWizardStepCollection collection of wizard steps

getShowCancelButton() X-Ref

return: boolean whether to display a cancel button in each wizard step. Defaults to false.

setShowCancelButton($value) X-Ref

param: boolean whether to display a cancel button in each wizard step.

getShowSideBar() X-Ref

return: boolean whether to display a side bar that contains links to wizard steps. Defaults to true.

setShowSideBar($value) X-Ref

param: boolean whether to display a side bar that contains links to wizard steps.

getStartNavigationTemplate() X-Ref

return: ITemplate navigation template for the start step. Defaults to null.

setStartNavigationTemplate($value) X-Ref

param: ITemplate navigation template for the start step.

getStepNavigationTemplate() X-Ref

return: ITemplate navigation template for internal steps. Defaults to null.

setStepNavigationTemplate($value) X-Ref

param: ITemplate navigation template for internal steps.

getFinishNavigationTemplate() X-Ref

return: ITemplate navigation template for the finish step. Defaults to null.

setFinishNavigationTemplate($value) X-Ref

param: ITemplate navigation template for the finish step.

getHeaderTemplate() X-Ref

return: ITemplate template for wizard header. Defaults to null.

setHeaderTemplate($value) X-Ref

param: ITemplate template for wizard header.

getSideBarTemplate() X-Ref

return: ITemplate template for the side bar. Defaults to null.

setSideBarTemplate($value) X-Ref

param: ITemplate template for the side bar.

getHeaderText() X-Ref

return: string header text. Defaults to ''.

setHeaderText($value) X-Ref

param: string header text.

getCancelDestinationUrl() X-Ref

return: string the URL that the browser will be redirected to if the cancel button in the

setCancelDestinationUrl($value) X-Ref

param: string the URL that the browser will be redirected to if the cancel button in the

getFinishDestinationUrl() X-Ref

return: string the URL that the browser will be redirected to if the wizard finishes.

setFinishDestinationUrl($value) X-Ref

param: string the URL that the browser will be redirected to if the wizard finishes.

getSideBarButtonStyle() X-Ref

return: TStyle the style for the buttons displayed in the side bar.

getNavigationButtonStyle() X-Ref

return: TStyle the style common for all navigation buttons.

getStartNextButtonStyle() X-Ref

return: TWizardNavigationButtonStyle the style for the next button in the start wizard step.

getStepNextButtonStyle() X-Ref

return: TWizardNavigationButtonStyle the style for the next button in each internal wizard step.

getStepPreviousButtonStyle() X-Ref

return: TWizardNavigationButtonStyle the style for the previous button in the start wizard step.

getFinishCompleteButtonStyle() X-Ref

return: TWizardNavigationButtonStyle the style for the complete button in the finish wizard step.

getFinishPreviousButtonStyle() X-Ref

return: TWizardNavigationButtonStyle the style for the previous button in the start wizard step.

getCancelButtonStyle() X-Ref

return: TWizardNavigationButtonStyle the style for the cancel button

getSideBarStyle() X-Ref

return: TPanelStyle the style for the side bar.

getHeaderStyle() X-Ref

return: TPanelStyle the style for the header.

getStepStyle() X-Ref

return: TPanelStyle the style for each internal wizard step.

getNavigationStyle() X-Ref

return: TPanelStyle the style for the navigation panel.

getUseDefaultLayout() X-Ref

return: boolean whether to use default layout to arrange side bar and the rest wizard components. Defaults to true.

setUseDefaultLayout($value) X-Ref

param: boolean whether to use default layout to arrange side bar and the rest wizard components.

getHeader() X-Ref

return: TPanel container of the wizard header

getStepContent() X-Ref

return: TPanel container of the wizard step content

getSideBar() X-Ref

return: TPanel container of the wizard side bar

getStartNavigation() X-Ref

return: TWizardNavigationContainer container of the start navigation

getStepNavigation() X-Ref

return: TWizardNavigationContainer container of the step navigation

getFinishNavigation() X-Ref

return: TWizardNavigationContainer container of the finish navigation

onActiveStepChanged($param) X-Ref

Raises OnActiveStepChanged event.
This event is raised when the current visible step is changed in the
wizard.

param: TEventParameter event parameter

onCancelButtonClick($param) X-Ref

Raises OnCancelButtonClick event.
This event is raised when a cancel navigation button is clicked in the
current active step.

param: TEventParameter event parameter

onCompleteButtonClick($param) X-Ref

Raises OnCompleteButtonClick event.
This event is raised when a finish navigation button is clicked in the
current active step.

param: TEventParameter event parameter

onNextButtonClick($param) X-Ref

Raises OnNextButtonClick event.
This event is raised when a next navigation button is clicked in the
current active step.

param: TEventParameter event parameter

onPreviousButtonClick($param) X-Ref

Raises OnPreviousButtonClick event.
This event is raised when a previous navigation button is clicked in the
current active step.

param: TEventParameter event parameter

onSideBarButtonClick($param) X-Ref

Raises OnSideBarButtonClick event.
This event is raised when a link button in the side bar is clicked.

param: TEventParameter event parameter

getMultiView() X-Ref

Returns the multiview that holds the wizard steps.
This method should only be used by control developers.

return: TMultiView the multiview holding wizard steps

addedWizardStep($step) X-Ref

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.

param: TWizardStep wizard step to be added into multiview.

removedWizardStep($step) X-Ref

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.

param: TWizardStep wizard step to be removed from multiview.

onInit($param) X-Ref

Creates the child controls of the wizard.
This method overrides the parent implementation.

param: TEventParameter event parameter

saveState() X-Ref

Saves the current active step index into history.
This method is invoked by the framework when the control state is being saved.

requiresControlsRecreation() X-Ref

Indicates the wizard needs to recreate all child controls.

render($writer) X-Ref

Renders the wizard.

param: THtmlWriter

applyControlProperties() X-Ref

Applies various properties to the components of wizard

applyHeaderProperties() X-Ref

Applies properties to the wizard header

applySideBarProperties() X-Ref

Applies properties to the wizard sidebar

applyStepContentProperties() X-Ref

Applies properties to the wizard step content

applyNavigationProperties() X-Ref

Apply properties to various navigation panels.

getHistory() X-Ref

return: TStack history containing step indexes that were navigated before

getStepType($wizardStep) X-Ref

Determines the type of the specified wizard step.

param: TWizardStep
return: TWizardStepType type of the step

reset() X-Ref

Clears up everything within the wizard.

createChildControls() X-Ref

Creates child controls within the wizard

createHeader() X-Ref

Creates the wizard header.

createSideBar() X-Ref

Creates the wizard side bar

dataListItemCommand($sender,$param) X-Ref

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.

param: mixed sender of the event
param: TDataListCommandEventParameter

dataListItemDataBound($sender,$param) X-Ref

Event handler for sidebar datalist's OnItemDataBound event.
This method is used internally by wizard. It mainly configures
the buttons in the sidebar datalist.

param: mixed sender of the event
param: TDataListItemEventParameter

createStepContent() X-Ref

Creates wizard step content.

createNavigation() X-Ref

Creates navigation panel.

createStartNavigation() X-Ref

Creates start navigation panel.

createStepNavigation() X-Ref

Creates step navigation panel.

createFinishNavigation() X-Ref

Creates finish navigation panel.

wizardStepsChanged() X-Ref

Updates the sidebar datalist if any.
This method is invoked when any wizard step is changed.

getPreviousStepIndex($popStack) X-Ref

Determines the index of the previous step based on history.

param: boolean whether the first item in the history stack should be popped

allowNavigationToPreviousStep() X-Ref

return: boolean whether navigation to the previous step is allowed

allowNavigationToStep($index) X-Ref

param: integer index of the step
return: boolean whether navigation to the specified step is allowed

bubbleEvent($sender,$param) X-Ref

Handles bubbled events.
This method mainly translate certain command events into
wizard-specific events.

param: mixed sender of the original command event
param: TEventParameter event parameter

Classe: TWizardNavigationButtonStyle - X-Ref

TWizardNavigationButtonStyle class.
TWizardNavigationButtonStyle defines the style applied to a wizard navigation button.
The button type can be specified via {@link setButtonType ButtonType}, which
can be 'Button', 'Image' or 'Link'.
If the button is an image button, {@link setImageUrl ImageUrl} will be
used to load the image for the button.
Otherwise, {@link setButtonText ButtonText} will be displayed as the button caption.

reset() X-Ref

Sets the style attributes to default values.
This method overrides the parent implementation by
resetting additional TWizardNavigationButtonStyle specific attributes.

copyFrom($style) X-Ref

Copies the fields in a new style to this style.
If a style field is set in the new style, the corresponding field
in this style will be overwritten.

param: TStyle the new style

mergeWith($style) X-Ref

Merges the style with a new one.
If a style field is not set in this style, it will be overwritten by
the new one.

param: TStyle the new style

getImageUrl() X-Ref

return: string image URL for the image button

setImageUrl($value) X-Ref

param: string image URL for the image button

getButtonText() X-Ref

return: string button caption

setButtonText($value) X-Ref

param: string button caption

getButtonType() X-Ref

return: TWizardNavigationButtonType button type. Default to TWizardNavigationButtonType::Button.

setButtonType($value) X-Ref

param: TWizardNavigationButtonType button type.

apply($button) X-Ref

Applies this style to the specified button

param: mixed button to be applied with this style

Classe: TWizardStep - X-Ref

TWizardStep class.

TWizardStep represents a wizard step. The wizard owning the step
can be obtained by {@link getWizard Wizard}.
To specify the type of the step, set {@link setStepType StepType};
For step title, set {@link setTitle Title}. If a step can be re-visited,
set {@link setAllowReturn AllowReturn} to true.

getWizard() X-Ref

return: TWizard the wizard owning this step

setWizard($wizard) X-Ref

Sets the wizard owning this step.
This method is used internally by {@link TWizard}.

param: TWizard the wizard owning this step

getTitle() X-Ref

return: string the title for this step.

setTitle($value) X-Ref

param: string the title for this step.

getAllowReturn() X-Ref

return: boolean whether this step can be re-visited. Default to true.

setAllowReturn($value) X-Ref

param: boolean whether this step can be re-visited.

getStepType() X-Ref

return: TWizardStepType the wizard step type. Defaults to TWizardStepType::Auto.

setStepType($type) X-Ref

param: TWizardStepType the wizard step type.

Classe: TCompleteWizardStep - X-Ref

TCompleteWizardStep class.

TCompleteWizardStep represents a wizard step of type TWizardStepType::Complete.

getStepType() X-Ref

return: TWizardStepType the wizard step type. Always TWizardStepType::Complete.

setStepType($value) X-Ref

param: string the wizard step type.

Classe: TTemplatedWizardStep - X-Ref

TTemplatedWizardStep class.

TTemplatedWizardStep represents a wizard step whose content and navigation
can be customized using templates. To customize the step content, specify
{@link setContentTemplate ContentTemplate}. To customize navigation specific
to the step, specify {@link setNavigationTemplate NavigationTemplate}. Note,
if the navigation template is not specified, default navigation will be used.

createChildControls() X-Ref

Creates child controls.
This method mainly instantiates the content template, if any.

onInit($param) X-Ref

Ensures child controls are created.

param: mixed event parameter

getContentTemplate() X-Ref

return: ITemplate the template for the content of the wizard step.

setContentTemplate($value) X-Ref

param: ITemplate the template for the content of the wizard step.

getNavigationTemplate() X-Ref

return: ITemplate the template for displaying the navigation UI of a wizard step. Defaults to null.

setNavigationTemplate($value) X-Ref

param: ITemplate the template for displaying the navigation UI of a wizard step.

getNavigationContainer() X-Ref

return: TWizardNavigationContainer the control containing the navigation.

instantiateNavigationTemplate() X-Ref

Instantiates the navigation template if any

Classe: TWizardStepCollection - X-Ref

TWizardStepCollection class.

TWizardStepCollection represents the collection of wizard steps owned
by a {@link TWizard}.

__construct(TWizard $wizard) X-Ref

Constructor.

param: TWizard wizard that owns this collection

insertAt($index,$item) X-Ref

Inserts an item at the specified position.
This method overrides the parent implementation by checking if
the item being added is a {@link TWizardStep}.

param: integer the speicified position.
param: mixed new item

removeAt($index) X-Ref

Removes an item at the specified position.

param: integer the index of the item to be removed.
return: mixed the removed item.

Classe: TWizardNavigationContainer - X-Ref

TWizardNavigationContainer class.

TWizardNavigationContainer represents a control containing
a wizard navigation. The navigation may contain a few buttons, including
{@link getPreviousButton PreviousButton}, {@link getNextButton NextButton},
{@link getCancelButton CancelButton}, {@link getCompleteButton CompleteButton}.

getPreviousButton() X-Ref

return: mixed the previous button

setPreviousButton($value) X-Ref

param: mixed the previous button

getNextButton() X-Ref

return: mixed the next button

setNextButton($value) X-Ref

param: mixed the next button

getCancelButton() X-Ref

return: mixed the cancel button

setCancelButton($value) X-Ref

param: mixed the cancel button

getCompleteButton() X-Ref

return: mixed the complete button

setCompleteButton($value) X-Ref

param: mixed the complete button

Classe: TWizardNavigationEventParameter - X-Ref

TWizardNavigationEventParameter class.

TWizardNavigationEventParameter represents the parameter for
{@link TWizard}'s navigation events.

The index of the currently active step can be obtained from
{@link getCurrentStepIndex CurrentStepIndex}, while the index
of the candidate new step is in {@link getNextStepIndex NextStepIndex}.
By modifying {@link setNextStepIndex NextStepIndex}, the new step
can be changed to another one. If there is anything wrong with
the navigation and it is not wanted, set {@link setCancelNavigation CancelNavigation}
to true.

__construct($currentStep) X-Ref

Constructor.

param: integer current step index

getCurrentStepIndex() X-Ref

return: integer the zero-based index of the currently active step.

getNextStepIndex() X-Ref

return: integer the zero-based index of the next step. Default to {@link getCurrentStepIndex CurrentStepIndex}.

setNextStepIndex($index) X-Ref

param: integer the zero-based index of the next step.

getCancelNavigation() X-Ref

return: boolean whether navigation to the next step should be canceled. Default to false.

setCancelNavigation($value) X-Ref

param: boolean whether navigation to the next step should be canceled.

Classe: TWizardSideBarTemplate - X-Ref

TWizardSideBarTemplate class.
TWizardSideBarTemplate is the default template for wizard sidebar.

instantiateIn($parent) X-Ref

Instantiates the template.
It creates a {@link TDataList} control.

param: TControl parent to hold the content within the template

Classe: TWizardSideBarListItemTemplate - X-Ref

TWizardSideBarListItemTemplate class.
TWizardSideBarListItemTemplate is the default template for each item in the sidebar datalist.

instantiateIn($parent) X-Ref

Instantiates the template.
It creates a {@link TLinkButton}.

param: TControl parent to hold the content within the template

Classe: TWizardNavigationTemplate - X-Ref

TWizardNavigationTemplate class.
TWizardNavigationTemplate is the base class for various navigation templates.

__construct($wizard) X-Ref

Constructor.

param: TWizard the wizard owning this template

getWizard() X-Ref

return: TWizard the wizard owning this template

instantiateIn($parent) X-Ref

Instantiates the template.
Derived classes should override this method.

param: TControl parent to hold the content within the template

createNavigationButton($buttonStyle,$causesValidation,$commandName) X-Ref

Creates a navigation button.
It creates a {@link TButton}, {@link TLinkButton}, or {@link TImageButton},
depending on the given parameters.

param: TWizardNavigationButtonStyle button style
param: boolean whether the button should cause validation
param: string command name for the button's OnCommand event

Classe: TWizardStartNavigationTemplate - X-Ref

TWizardStartNavigationTemplate class.
TWizardStartNavigationTemplate is the template used as default wizard start navigation panel.
It consists of two buttons, Next and Cancel.

instantiateIn($parent) X-Ref

Instantiates the template.

param: TControl parent to hold the content within the template

Classe: TWizardFinishNavigationTemplate - X-Ref

TWizardFinishNavigationTemplate class.
TWizardFinishNavigationTemplate is the template used as default wizard finish navigation panel.
It consists of three buttons, Previous, Complete and Cancel.

instantiateIn($parent) X-Ref

Instantiates the template.

param: TControl parent to hold the content within the template

Classe: TWizardStepNavigationTemplate - X-Ref

TWizardStepNavigationTemplate class.
TWizardStepNavigationTemplate is the template used as default wizard step navigation panel.
It consists of three buttons, Previous, Next and Cancel.

instantiateIn($parent) X-Ref

Instantiates the template.

param: TControl parent to hold the content within the template

Classe: TWizardNavigationButtonType - X-Ref

TWizardNavigationButtonType class.
TWizardNavigationButtonType defines the enumerable type for the possible types of buttons
that can be used in the navigation part of a {@link TWizard}.

The following enumerable values are defined:
- Button: a regular click button
- Image: an image button
- Link: a hyperlink button

Classe: TWizardStepType - X-Ref

TWizardStepType class.
TWizardStepType defines the enumerable type for the possible types of {@link TWizard wizard} steps.

The following enumerable values are defined:
- Auto: the type is automatically determined based on the location of the wizard step in the whole step collection.
- Complete: the step is the last summary step.
- Start: the step is the first step
- Step: the step is between the begin and the end steps.
- Finish: the last step before the Complete step.

Author:	Qiang Xue <qiang.xue@gmail.com>
Copyright:	Copyright © 2005 PradoSoft
License:	http://www.pradosoft.com/license/
Version:	$Id: TWizard.php 1397 2006-09-07 07:55:53Z wei $
Poids:	2271 lignes (65 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Code source de PRADO 3.0.6

/framework/Web/UI/WebControls/ -> TWizard.php (sommaire)

Définit 16 classes