Class WizardController

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	WizardController(preferences, viewFactory) An abstract MVC for a wizard view.

Method Summary
Method Attributes	Method Name and Description
	addPropertyChangeListener(property, listener) Adds the property change `listener` in parameter to this controller.
	displayView(parentView) Displays the view controlled by this controller.
	getStepIcon() Returns the current step icon.
	getStepView() Returns the current step view.
	getTitle() Returns the wizard title.
	getView() Returns the view associated with this controller.
	goBackToPreviousStep() Requires to the current step to go back to previous step.
	goToNextStep() Requires to the current step to jump to next step.
	isBackStepEnabled() Returns whether back step is enabled or not.
	isLastStep() Returns whether this is the last step or not.
	isNextStepEnabled() Returns whether next step is enabled or not.
	isResizable() Returns whether the wizard is resizable or not.
	removePropertyChangeListener(property, listener) Removes the property change `listener` in parameter from this controller.
	setResizable(resizable) Sets whether the wizard is resizable or not.
	setStepState(stepState) Changes current state of controller.
	setTitle(title) Sets the wizard title.

Class Detail

WizardController(preferences, viewFactory)

An abstract MVC for a wizard view. Subclasses should create a set of wizard steps with subclasses of WizardControllerStepState and and choose the first step with a call to setStepState. The {@link #finish() finish} method will be called if user completes the wizard steps correctly.
Author: Emmanuel Puybaret.

Parameters:
{UserPreferences} preferences
{Object} viewFactory

Method Detail

addPropertyChangeListener(property, listener)

Adds the property change listener in parameter to this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

displayView(parentView)

Displays the view controlled by this controller.

Parameters:
{Object} parentView

{string} getStepIcon()

Returns the current step icon.

Returns:: {string}

{Object} getStepView()

Returns the current step view.

Returns:: {Object}

{string} getTitle()

Returns the wizard title.

Returns:: {string}

{Object} getView()

Returns the view associated with this controller.

Returns:: {Object}

goBackToPreviousStep()

Requires to the current step to go back to previous step.

goToNextStep()

Requires to the current step to jump to next step.

{boolean} isBackStepEnabled()

Returns whether back step is enabled or not.

Returns:: {boolean}

{boolean} isLastStep()

Returns whether this is the last step or not.

Returns:: {boolean}

{boolean} isNextStepEnabled()

Returns whether next step is enabled or not.

Returns:: {boolean}

{boolean} isResizable()

Returns whether the wizard is resizable or not.

Returns:: {boolean}

removePropertyChangeListener(property, listener)

Removes the property change listener in parameter from this controller.

Parameters:
{string} property
{PropertyChangeListener} listener

setResizable(resizable)

Sets whether the wizard is resizable or not.

Parameters:
{boolean} resizable

setStepState(stepState)

Changes current state of controller.

Parameters:
{WizardController.WizardControllerStepState} stepState

setTitle(title)

Sets the wizard title.

Parameters:
{string} title

	© Copyright 2024 Space Mushrooms Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 21 2024 17:43:25 GMT+0200 (CEST)

Classes

Class WizardController