goog.Disposable | |
goog.events.EventTarget | goog.Disposable |
goog.editor.Plugin | goog.events.EventTarget |
goog.editor.plugins.AbstractBubblePlugin | goog.editor.Plugin |
goog.editor.plugins.equation.EquationBubble | goog.editor.plugins.AbstractBubblePlugin |
goog.editor.plugins.LinkBubble | goog.editor.plugins.AbstractBubblePlugin |
![]()
Instance factory function that creates a bubble UI component. If set to a
non-null value, this function will be used to create a bubble instead of
the global factory function. It takes as parameters the bubble parent
element and the z index to draw the bubble at.
|
code » | |||||
![]()
Called when the bubble is closed or hidden. The default implementation does
nothing.
|
code » | |||||
![]()
Closes the bubble.
|
code » | |||||
![]()
Creates and shows the property bubble.
Arguments:
|
code » | |||||
![]()
Should be overriden by subclasses to add the type specific contents to the
bubble.
Arguments:
|
code » | |||||
Helper method that creates a link with text set to linkText and optionaly
wires up a listener for the CLICK event or the link.
Arguments:
Returns: Element
The link element.
|
code » | |||||
Helper method to create a link to insert into the bubble.
Arguments:
Returns: Element
The link element.
|
code » | |||||
Helper method that creates option links (such as edit, test, remove)
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
Sets whether the bubble should support tabbing through the link elements.
Arguments:
|
code » | |||||
No description.
Returns: goog.dom.DomHelper
The dom helper for the bubble window.
|
code » | |||||
Returns the bubble map. Subclasses may override to use a separate map.
|
code » | |||||
Should be overriden by subclasses to return the bubble target element or
null if an element of their required type isn't found.
|
code » | |||||
No description.
Returns: string
The title for bubble shown by this plugin. Defaults to no
title. Should be overridden by subclasses.
|
code » | |||||
No description.
Returns: string
The type of bubble shown by this plugin. Usually the tag
name of the element this bubble targets.
|
code » | |||||
No description.
Returns: !goog.ui.editor.Bubble
The shared bubble object for the field this
plugin is registered on. Creates it if necessary.
|
code » | |||||
Returns the element whose properties the bubble manipulates.
Returns: Element
The target element.
|
code » | |||||
![]()
In case the keyboard navigation is enabled, this will focus to the first link
element in the bubble when TAB is clicked. The user could still go through
the rest of tabbable UI elements using shift + TAB.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
Handles when the bubble panel is closed. Invoked when the entire bubble is
hidden and also directly when the panel is closed manually.
|
code » | |||||
![]()
Pops up a property bubble for the given selection if appropriate and closes
open property bubbles if no longer needed. This should not be overridden.
|
code » | |||||
Pops up a property bubble for the given selection if appropriate and closes
open property bubbles if no longer needed.
|
code » | |||||
No description.
Returns: boolean
Whether the bubble is visible.
|
code » | |||||
![]()
Handles a key event on the bubble. This ensures that the focus loops through
the link elements found in the bubble and then the focus is got by the field
element.
Arguments:
|
code » | |||||
![]()
Called after the bubble is shown. The default implementation does nothing.
Override it to provide your own one.
|
code » | |||||
![]()
Register the handler for the target's CLICK and ENTER key events.
|
code » | |||||
![]()
Use goog.editor.plugins.AbstractBubblePlugin.
registerActionHandler to register click and enter events.
Register the handler for the target's CLICK event.
|
code » | |||||
![]()
Reposition the property bubble.
|
code » | |||||
![]()
Sets the instance bubble factory function. If set to a non-null value, this
function will be used to create a bubble instead of the global factory
function.
Arguments:
|
code » | |||||
![]()
Sets the bubble parent.
Arguments:
|
code » | |||||
![]()
Inserts a link in the given container if it is specified or removes
the old link with this id and replaces it with the new link
|
code » | |||||
No description.
Returns: boolean
Whether the bubble should prefer placement above the
target element.
|
code » |
No description.
Returns: boolean
If true, field will not disable the command
when the field becomes uneditable.
|
code » | ||||
![]()
Cleans the contents of the node passed to it. The node contents are modified
directly, and the modifications will subsequently be used, for operations
such as saving the innerHTML of the editor etc. Since the plugins act on
the DOM directly, this method can be very expensive.
This op is invoked even on disabled plugins.
Arguments:
|
code » | ||||
Cleans the html contents of Trogedit. Both cleanContentsDom and
and cleanContentsHtml will be called on contents extracted from Trogedit.
The inverse of prepareContentsHtml.
This op is invoked even on disabled plugins.
|
code » | ||||
![]()
Disables this plugin for the specified, registered field object.
Arguments:
|
code » | ||||
![]()
No description.
|
code » | ||||
![]()
Enables this plugin for the specified, registered field object. A field
object should only be enabled when it is loaded.
Arguments:
|
code » | ||||
![]()
Handles execCommand. This default implementation handles dispatching
BEFORECHANGE, CHANGE, and SELECTIONCHANGE events, and calls
execCommandInternal to perform the actual command. Plugins that want to
do their own event dispatching should override execCommand, otherwise
it is preferred to only override execCommandInternal.
This version of execCommand will only work for single field plugins.
Multi-field plugins must override execCommand.
Arguments:
Returns: *
The result of the execCommand, if any.
|
code » | ||||
![]()
Handles execCommand. This default implementation does nothing, and is
called by execCommand, which handles event dispatching. This method should
be overriden by plugins that don't need to do their own event dispatching.
If custom event dispatching is needed, execCommand shoul be overriden
instead.
Arguments:
Returns: *
The result of the execCommand, if any.
|
code » | ||||
No description.
Returns: ?goog.dom.DomHelper
The dom helper object associated with the
currently active field.
|
code » | ||||
Sets the field object for use with this plugin.
Returns: goog.editor.Field
The editable field object.
|
code » | ||||
No description.
Returns: string
The ID unique to this plugin class. Note that different
instances off the plugin share the same classId.
|
code » | ||||
Handles keydown. It is run before handleKeyboardShortcut and if it returns
true handleKeyboardShortcut will not be called.
Arguments:
Returns: boolean
Whether the event was handled and thus should *not* be
propagated to other plugins or handleKeyboardShortcut.
|
code » | ||||
Handles keypress. It is run before handleKeyboardShortcut and if it returns
true handleKeyboardShortcut will not be called.
Arguments:
Returns: boolean
Whether the event was handled and thus should *not* be
propagated to other plugins or handleKeyboardShortcut.
|
code » | ||||
Handles keyup.
Arguments:
Returns: boolean
Whether the event was handled and thus should *not* be
propagated to other plugins.
|
code » | ||||
Handles keyboard shortcuts. Preferred to using handleKey* as it will use
the proper event based on browser and will be more performant. If
handleKeyPress/handleKeyDown returns true, this will not be called. If the
plugin handles the shortcut, it is responsible for dispatching appropriate
events (change, selection change at the time of this comment). If the plugin
calls execCommand on the editable field, then execCommand already takes care
of dispatching events.
NOTE: For performance reasons this is only called when any key is pressed
in conjunction with ctrl/meta keys OR when a small subset of keys (defined
in goog.editor.Field.POTENTIAL_SHORTCUT_KEYCODES_) are pressed without
ctrl/meta keys. We specifically don't invoke it when altKey is pressed since
alt key is used in many i8n UIs to enter certain characters.
Arguments:
Returns: boolean
Whether the event was handled and thus should *not* be
propagated to other plugins. We also call preventDefault on the event if
the return value is true.
|
code » | ||||
Handles selection change.
Arguments:
Returns: boolean
Whether the event was handled and thus should *not* be
propagated to other plugins.
|
code » | ||||
No description.
Returns: boolean
Whether or not this plugin should automatically be disposed
when it's registered field is disposed.
|
code » | ||||
Returns whether this plugin is enabled for the field object.
Arguments:
Returns: boolean
Whether this plugin is enabled for the field object.
|
code » | ||||
No description.
|
code » | ||||
Whether the string corresponds to a command this plugin handles.
|
code » | ||||
Prepares the given HTML for editing. Strips out content that should not
appear in an editor, and normalizes content as appropriate. The inverse
of cleanContentsHtml.
This op is invoked even on disabled plugins.
|
code » | ||||
![]()
Gets the state of this command if this plugin serves that command.
Arguments:
Returns: *
The value of the command.
|
code » | ||||
![]()
Registers the field object for use with this plugin.
Arguments:
|
code » | ||||
![]()
Set if this plugin should automatically be disposed when the registered
field is disposed.
Arguments:
|
code » | ||||
![]()
Sets the field object for use with this plugin.
Arguments:
|
code » | ||||
![]()
Unregisters and disables this plugin for the current field object.
Arguments:
|
code » |
![]()
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:
|
code » | |||||
![]()
Asserts that the event target instance is initialized properly.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
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 » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
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 » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
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:
|
code » | |||||
![]()
Sets the parent of this event target to use for capture/bubble
mechanism.
Arguments:
|
code » | |||||
![]()
Sets the target to be used for
event.target when firing
event. Mainly used for testing. For example, see
goog.testing.events.mixinListenable .
Arguments:
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » |
![]()
Invokes a callback function when this object is disposed. Callbacks are
invoked in the order in which they were added.
Arguments:
|
code » | |||
![]()
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 » | |||
![]()
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 » | |||
Use
#isDisposed instead.
No description.
Returns: boolean
Whether the object has been disposed of.
|
code » | |||
No description.
Returns: boolean
Whether the object has been disposed of.
|
code » | |||
![]()
Associates a disposable object with this object so that they will be disposed
together.
Arguments:
|
code » |
![]()
The optional parent of the bubble. If null or not set, we will use the
application document. This is useful when you have an editor embedded in
a scrolling DIV.
|
Code » | |
![]()
No description.
|
Code » | |
Place to register events the plugin listens to.
|
Code » | |
![]()
Whether this bubble should support tabbing through the link elements. False
by default.
|
Code » | |
![]()
The id of the panel this plugin added to the shared bubble. Null when
this plugin doesn't currently have a panel in a bubble.
|
Code » |
![]()
Indicates if this plugin should be automatically disposed when the
registered field is disposed. This should be changed to false for
plugins used as multi-field plugins.
|
Code » | |
![]()
No description.
|
Code » | |
![]()
Whether this plugin is enabled for the registered field object.
|
Code » | |
The field object this plugin is attached to.
|
Code » | |
The logger for this plugin.
|
Code » |
The object to use for event.target. Useful when mixing in an
EventTarget to another object.
|
Code » | |
![]()
No description.
|
Code » | |
Maps of event type to an array of listeners.
|
Code » | |
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 » |
![]()
Default factory function for creating a bubble UI component.
Arguments:
Returns: !goog.ui.editor.Bubble
The new bubble component.
|
code » | |||
![]()
Global factory function that creates a bubble UI component. It takes as
parameters the bubble parent element and the z index to draw the bubble at.
|
code » | |||
![]()
Sets the global bubble factory function.
Arguments:
|
code » |
![]()
The constant string used to separate option links.
|
Code » | |
![]()
The css class name of link elements.
|
Code » | |
![]()
The css class name of option link elements.
|
Code » | |
![]()
Map from field id to shared bubble object.
|
Code » | |
![]()
No description.
|
Code » |