de.espirit.firstspirit.webedit.client.api

Interface Common

public interface Common

FirstSpirit WebEdit Javascript Common API, accessible via

    WE_API.Common

Examples:

WE_API.Common.showMessage("A big hello from the new FirstSpirit Web Client 5!");   // Hello World!

WE_API.Common.execute(
 "script:myexample",                      // calls the project script "myexample"
 {param1:42, param2:"test"},              // an integer and a string as parameter
 function(result) {                       // callback function after the script execution is finished
   alert("script result: " + result);
 }
);

Since:

5.0.106

Method Summary

Methods

Modifier and Type	Method and Description
Dialog	createDialog() Returns an empty, yet invisible WebEdit style dialog.
void	execute(String identifier, JavaScriptObject params, JavaScriptObject callback) Executes a project script or an executable.
FSID	getPreviewElement() Returns current visible element.
void	jumpTo(FSID fsid) Jumps to the given target fsid.
void	jumpTo(JavaScriptObject fsid) Jumps to the given target, specified by store-type and element id.
void	showMessage(String text) Shows the given text in a simple message box.

Method Detail

createDialog

Dialog createDialog()

Returns an empty, yet invisible WebEdit style dialog.

Returns:

new invisible dialog.

Since:

5.0.106

See Also:

Dialog.show()

getPreviewElement

FSID getPreviewElement()

Returns current visible element.

Returns:

current visible element.

Since:

5.0.106

execute

void execute(@NotNull
           String identifier,
           JavaScriptObject params,
           JavaScriptObject callback)

Executes a project script or an executable.

Parameters:

identifier - script ("sciprt:script_uid") or executable ("class:full.qualified.executable.ClassName").

params - js object with parameters (e.g. {"param1":42, "param2":"text"}).

callback - single-parameter function that is called with the script result.

Since:

5.0.106

jumpTo

void jumpTo(FSID fsid)

Jumps to the given target fsid.

Parameters:

fsid - target element.

Since:

5.0.106

jumpTo

void jumpTo(JavaScriptObject fsid)

Jumps to the given target, specified by store-type and element id.

Parameters:

fsid - map to identify the target (e.g. {"id":42, "store":"MEDIASTORE"}).

Since:

5.0.106

showMessage

void showMessage(String text)

Shows the given text in a simple message box.

Parameters:

text - to show.

Since:

5.0.106