• index
• goog
• ui
• editor
• search: Go

The goog.ui.editor.ToolbarController Class

goog.ui.editor.ToolbarController
> goog.events.EventTarget
> goog.Disposable

goog.ui.editor.ToolbarController(field, toolbar)

A class for managing the editor toolbar. Acts as a bridge between a {@link goog.editor.Field} and a {@link goog.ui.Toolbar}. The {@code toolbar} argument must be an instance of {@link goog.ui.Toolbar} or a subclass. This class doesn't care how the toolbar was created. As long as one or more controls hosted in the toolbar have IDs that match built-in {@link goog.editor.Command}s, they will function as expected. It is the caller's responsibility to ensure that the toolbar is already rendered or that it decorates an existing element.

field {!goog.editor.Field}

Editable field to be controlled by the toolbar.

toolbar {!goog.ui.Toolbar}

Toolbar to control the editable field.

.addEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.addOnDisposeCallback(callback, opt_scope)

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}

The callback function.

opt_scope {Object=}

An optional scope to call the callback in.

.blur()

Programmatically blurs the editor toolbar, un-highlighting the currently highlighted item, and closing the currently open menu (if any).

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

.dispatchEvent(e)

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}

Event object.

returns {boolean}

If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

.dispose()

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}

Nothing.

MyClass.prototype.disposeInternal = function() {
  MyClass.superClass_.disposeInternal.call(this);
  // Dispose logic for MyClass
};

.getParentEventTarget()

Inherited from goog.events.EventTarget .

Returns the parent of this event target to use for bubbling.

returns {goog.events.EventTarget}

The parent EventTarget or null if there is no parent.

.getToolbar()

Returns the toolbar UI component that manages the editor. Useful for classes that extend {@code goog.ui.editor.ToolbarController}.

returns {!goog.ui.Toolbar}

The toolbar UI component.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.isEnabled()

returns {boolean}

Whether the toolbar is enabled.

.isVisible()

returns {boolean}

Whether the toolbar is visible.

.registerDisposable(disposable)

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}

that will be disposed when this object is disposed.

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.setEnabled(enabled)

Enables or disables the toolbar.

enabled {boolean}

Whether to enable or disable the toolbar.

.setParentEventTarget(parent)

Inherited from goog.events.EventTarget .

Sets the parent of this event target to use for bubbling.

parent {goog.events.EventTarget?}

Parent EventTarget (null if none).

.setVisible(visible)

Shows or hides the toolbar.

visible {boolean}

Whether to show or hide the toolbar.

.updateToolbarFromState(state)

Updates the toolbar to reflect a given state.

state {Object}

Object mapping editor commands to values.

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.