TinyMCE:API/tinymce.Editor/setProgressState

From Moxiecode Documentation Wiki

Contents 1 Method: setProgressState 1.1 Summary 1.2 Syntax 1.3 Parameters 1.4 Returns 1.5 Examples

Method: setProgressState

Summary

Sets the progress state, this will display a throbber/progess for the editor. This is ideal for asycronous operations like an AJAX save call.

Syntax

<bool> setProgressState(<bool> b, <Number> ti, <Object> o)

Parameters

b

Boolean state if the progress should be shown or hidden.

ti

Optional time to wait before the progress gets shown.

o

Optional object to pass to the progress observers.

Returns

Same as the input state.

Examples

// Show progress for the active editor
tinyMCE.activeEditor.setProgressState(true);

// Hide progress for the active editor
tinyMCE.activeEditor.setProgressState(false);

// Show progress after 3 seconds
tinyMCE.activeEditor.setProgressState(true, 3000);