org.xwiki.gwt.user.client.ui.rta.cmd

Class CommandManagerApi

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

org.xwiki.gwt.dom.client.JavaScriptObject

org.xwiki.gwt.user.client.ui.rta.cmd.CommandManagerApi

public final class CommandManagerApi
extends JavaScriptObject

This class exposes a CommandManager to the native JavaScript code.

Version:

$Id: 3e6f6409cddf1148ecb6707d64a20f61d22b4995 $

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CommandManagerApi() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static CommandManagerApi	newInstance(CommandManager cm) We need this static native method because we can't instantiate JavaScript objects directly in Java code.
static void	publish() Publishes the JavaScript API that can be used to play with a CommandManager.

Methods inherited from class org.xwiki.gwt.dom.client.JavaScriptObject

fromJson, get, getKeys, remove, set, typeOf

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandManagerApi

protected CommandManagerApi()

Default constructor. Overlay types always have protected, zero-arguments constructors.

Method Detail

newInstance

public static CommandManagerApi newInstance(CommandManager cm)

We need this static native method because we can't instantiate JavaScript objects directly in Java code.

Parameters:

cm - the command manager to be exposed in JavaScript code

Returns:

a JavaScript object that exposes the given command manager

publish

public static void publish()

Publishes the JavaScript API that can be used to play with a CommandManager.