ui.editor.ToolbarController Extends goog.events.EventTarget
A class for managing the editor toolbar. Acts as a bridge between a goog.editor.Field and a goog.ui.Toolbar. The toolbar argument must be an instance of 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 goog.editor.Commands, 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.

Inheritance

Constructor

goog.ui.editor.ToolbarController(fieldtoolbar)

Parameters

field : !goog.editor.Field
Editable field to be controlled by the toolbar.
toolbar : !goog.ui.Toolbar
Toolbar to control the editable field.

Instance Methods

Public Protected Private
blur()
Programmatically blurs the editor toolbar, un-highlighting the currently highlighted item, and closing the currently open menu (if any).
code »
disposeInternal()
No description.
code »
getCommand(id) string
Returns the goog.editor.Command constant that corresponds to the given Closure component ID. Subclasses may override this method if they want to use a custom mapping scheme from controls to commands.
Arguments:
id : string
Closure component ID of a toolbar control.
Returns: string  Editor command or dialog constant corresponding to the toolbar control, if any.
code »
getComponentId(command) string
Returns the Closure component ID of the control that corresponds to the given goog.editor.Command constant. Subclasses may override this method if they want to use a custom mapping scheme from commands to controls.
Arguments:
command : string
Editor command.
Returns: string  Closure component ID of the corresponding toolbar control, if any.
code »
getField() !goog.editor.Field
Returns the field instance managed by the toolbar. Useful for classes that extend goog.ui.editor.ToolbarController.
Returns: !goog.editor.Field  The field managed by the toolbar.
code »
getHandler() !goog.events.EventHandler.<T>
Returns the event handler object for the editor toolbar. Useful for classes that extend goog.ui.editor.ToolbarController.
Returns: !goog.events.EventHandler.<T>  The event handler object.
code »
getToolbar() !goog.ui.Toolbar
Returns the toolbar UI component that manages the editor. Useful for classes that extend goog.ui.editor.ToolbarController.
Returns: !goog.ui.Toolbar  The toolbar UI component.
code »
handleAction(e)
Handles ACTION events dispatched by toolbar buttons in response to user actions by executing the corresponding field command.
Arguments:
e : goog.events.Event
Action event to handle.
code »
isEnabled() boolean
No description.
Returns: boolean  Whether the toolbar is enabled.
code »
isVisible() boolean
No description.
Returns: boolean  Whether the toolbar is visible.
code »
setEnabled(enabled)
Enables or disables the toolbar.
Arguments:
enabled : boolean
Whether to enable or disable the toolbar.
code »
setVisible(visible)
Shows or hides the toolbar.
Arguments:
visible : boolean
Whether to show or hide the toolbar.
code »
updateToolbar(e)
Updates the toolbar in response to editor events. Specifically, updates button states based on COMMAND_VALUE_CHANGE events, reflecting the effective formatting of the selection.
Arguments:
e : goog.events.Event
Editor event to handle.
code »
updateToolbarFromState(state)
Updates the toolbar to reflect a given state.
Arguments:
state : Object
Object mapping editor commands to values.
code »
addEventListener(typeopt_captureopt_handlerScope)
Use #listen instead, when possible. Otherwise, use goog.events.listen if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
Removes listeners from this object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.
code »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() 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.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
Use #unlisten instead, when possible. Otherwise, use goog.events.unlisten if you are passing Object (instead of Function) as handler. 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.
Arguments:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

constructor :
No description.
Code »
The field instance controlled by the toolbar.
Code »
Event handler to listen for field events and user actions.
Code »
queryCommands_ :
Editing commands whose state is to be queried when updating the toolbar.
Code »
toolbar_ : goog.ui.Toolbar
The toolbar that controls the field.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
Parent event target, used during event bubbling. TODO(user): Change this to goog.events.Listenable. This currently breaks people who expect getParentEventTarget to return goog.events.EventTarget.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Properties

goog.ui.editor.ToolbarController.superClass_ :
No description.
Code »

Package ui.editor

Package Reference