Class ImportedTextureWizardController

Extends WizardController.

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	ImportedTextureWizardController(textureName, preferences, viewFactory, contentManager) Creates a controller that edits a new catalog texture with a given `textureName`.

Method Summary
Method Attributes	Method Name and Description
	finish() Changes background image in model and posts an undoable operation.
	getCategory() Returns the category of the imported texture.
	getContentManager() Returns the content manager of this controller.
	getCreator() Returns the creator of the imported piece.
	getHeight() Returns the height.
	getImage() Returns the image content of the imported texture.
	getName() Returns the name of the imported texture.
	getStep() Returns the current step in wizard view.
	getStepState() Returns the current step state.
	getStepsView() Returns the unique wizard view used for all steps.
	getTextureAttributesStepState() Returns the texture attributes step state.
	getTextureImageStepState() Returns the texture image step state.
	getWidth() Returns the width.
	isTextureNameValid() Returns `true` if texture name is valid.
	setCategory(category) Sets the category of the imported texture.
	setCreator(creator) Sets the creator of the imported piece.
	setHeight(height) Sets the size of the imported texture.
	setImage(image) Sets the image content of the imported texture.
	setName(name) Sets the name of the imported texture.
	setStep(step) Switch in the wizard view to the given `step`.
	setWidth(width) Sets the width of the imported texture.

Methods borrowed from class WizardController:: addPropertyChangeListener, displayView, getStepIcon, getStepView, getTitle, getView, goBackToPreviousStep, goToNextStep, isBackStepEnabled, isLastStep, isNextStepEnabled, isResizable, removePropertyChangeListener, setResizable, setStepState, setTitle

Class Detail

ImportedTextureWizardController(textureName, preferences, viewFactory, contentManager)

Creates a controller that edits a new catalog texture with a given textureName.
Author: Emmanuel Puybaret.

Parameters:
{string} textureName
{UserPreferences} preferences
{Object} viewFactory
{Object} contentManager

Method Detail

finish()

Changes background image in model and posts an undoable operation.

{TexturesCategory} getCategory()

Returns the category of the imported texture.

Returns:: {TexturesCategory}

{Object} getContentManager()

Returns the content manager of this controller.

Returns:: {Object}

{string} getCreator()

Returns the creator of the imported piece.

Returns:: {string}

{number} getHeight()

Returns the height.

Returns:: {number}

{Object} getImage()

Returns the image content of the imported texture.

Returns:: {Object}

{string} getName()

Returns the name of the imported texture.

Returns:: {string}

{ImportedTextureWizardController.Step} getStep()

Returns the current step in wizard view.

Returns:: {ImportedTextureWizardController.Step}

{ImportedTextureWizardController.ImportedTextureWizardStepState} getStepState()

Returns the current step state.

Returns:: {ImportedTextureWizardController.ImportedTextureWizardStepState}

{Object} getStepsView()

Returns the unique wizard view used for all steps.

Returns:: {Object}

{ImportedTextureWizardController.ImportedTextureWizardStepState} getTextureAttributesStepState()

Returns the texture attributes step state.

Returns:: {ImportedTextureWizardController.ImportedTextureWizardStepState}

{ImportedTextureWizardController.ImportedTextureWizardStepState} getTextureImageStepState()

Returns the texture image step state.

Returns:: {ImportedTextureWizardController.ImportedTextureWizardStepState}

{number} getWidth()

Returns the width.

Returns:: {number}

{boolean} isTextureNameValid()

Returns true if texture name is valid.

Returns:: {boolean}

setCategory(category)

Sets the category of the imported texture.

Parameters:
{TexturesCategory} category

setCreator(creator)

Sets the creator of the imported piece.

Parameters:
{string} creator

setHeight(height)

Sets the size of the imported texture.

Parameters:
{number} height

setImage(image)

Sets the image content of the imported texture.

Parameters:
{Object} image

setName(name)

Sets the name of the imported texture.

Parameters:
{string} name

setStep(step)

Switch in the wizard view to the given step.

Parameters:
{ImportedTextureWizardController.Step} step

setWidth(width)

Sets the width of the imported texture.

Parameters:
{number} width

	© Copyright 2024 Emmanuel PUYBARET / eTeks Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Thu Apr 04 2024 17:30:26 GMT+0200 (CEST)

Classes

Class ImportedTextureWizardController