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(field, toolbar)

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
Defined in goog.ui.editor.ToolbarController
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
Returns the event handler object for the editor toolbar. Useful for classes that extend goog.ui.editor.ToolbarController.
Returns: 
goog.events.EventHandler
  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 | null)
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 | null)
Editor event to handle.
code »
updateToolbarFromState(state)
Updates the toolbar to reflect a given state.
Arguments:
state :
(Object | null)
Object mapping editor commands to values.
code »
Defined in goog.events.EventTarget
addEventListener(type, handler, opt_capture, opt_handlerScope)
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.
Arguments:
type :
string
The type of the event to listen for.
handler :
(Object | null)
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 | undefined)
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope :
(Object | null | undefined)
Object in whose scope to call the listener.
code »
dispatchEvent(e) ⇒
boolean
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.
Arguments:
e :
(Object | goog.events.Event | null | string)
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.
code »
disposeInternal()
Unattach 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, it should be something like this: 
MyClass.prototype.disposeInternal = function() {
MyClass.superClass_.disposeInternal.call(this);
// Dispose logic for MyClass
};
code »
getParentEventTarget() ⇒
(goog.events.EventTarget | null)
Returns the parent of this event target to use for bubbling.
Returns: 
(goog.events.EventTarget | null)
  The parent EventTarget or null if there is no parent.
code »
removeEventListener(type, handler, opt_capture, opt_handlerScope)
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.
handler :
(Object | null)
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 | undefined)
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope :
(Object | null | undefined)
Object in whose scope to call the listener.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for bubbling.
Arguments:
parent :
(goog.events.EventTarget | null)
Parent EventTarget (null if none).
code »
Defined in goog.Disposable
dispose() ⇒
undefined
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: 
undefined
  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() {
goog.base(this);
// Constructor logic specific to MyClass.
...
};
goog.inherits(mypackage.MyClass, goog.Disposable);

mypackage.MyClass.prototype.disposeInternal = function() {
goog.base(this, 'disposeInternal');
// Dispose logic specific to MyClass.
...
};
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 | null)
that will be disposed when this object is disposed.
code »

Instance Properties

Defined in goog.ui.editor.ToolbarController
field_ :
goog.editor.Field
The field instance controlled by the toolbar.
Code »
handler_ :
goog.events.EventHandler
Event handler to listen for field events and user actions.
Code »
queryCommands_ :
Array
Editing commands whose state is to be queried when updating the toolbar.
Code »
toolbar_ :
goog.ui.Toolbar
The toolbar that controls the field.
Code »
Defined in goog.events.EventTarget
customEvent_ :
boolean
Used to tell if an event is a real event in goog.events.listen() so we don't get listen() calling addEventListener() and vice-versa.
Code »
parentEventTarget_ :
(goog.events.EventTarget | null)
Parent event target, used during event bubbling.
Code »
Defined in goog.Disposable
dependentDisposables_ :
(Array | null)
Disposables that should be disposed when this object is disposed.
Code »
disposed_ :
boolean
Whether the object has been disposed of.
Code »

Package ui.editor

Package Reference