Skip to content

CodeCoupler UI Stageable

Danger

This is the old 2.x Version! A new version was never completed!

The Stageable class is the base class of some CodeCoupler components. All the following functionalities and rules affetc all stagable components.

Instance Getter

stages

Access an object of all stages with the id of the stage as property name.

currentStageElement

Get DOM element of the current stage as jQuery Object.

currentStageInstance

Get the instance of the current stage. If no stages defined the component itself will be returned.

currenStageIsRoot

return true if currentStageElement is the root stage.

Instance Methods

blockStage([type], message)

Blocks the current stage.

unblockStage()

Unblocks the current stage.

stage(stageStart)

Stage factory method to initialize a new stage.

► Read more about stages

$defineRootStage()

Used internally.

app(appStart)

Start an application in the current stage.

forceApp(appStart)

The base method app() will wait for the system initialization. If you do not need this you can use this method. Otherwise it will work like the app method.

rootApp(appStart)

The Application will be started in the root stage of the component.