goog.Disposable | |
goog.events.EventTarget | goog.Disposable |
goog.editor.Plugin | goog.events.EventTarget |
goog.editor.plugins.RemoveFormatting | goog.editor.Plugin |
Move the range so that it doesn't include any partially selected tables.
Arguments:
Returns: !goog.dom.SavedCaretRange
Range to use to restore the
selection after we run our custom remove formatting.
|
code » | ||||
![]()
Gets the html inside the current selection, passes it through the given
conversion function, and puts it back into the selection.
Arguments:
|
code » | ||||
![]()
No description.
|
code » | ||||
Gets the html inside the selection to send off for further processing.
TODO(user): Make this general so that it can be moved into
goog.editor.range. The main reason it can't be moved is becuase we need to
get the range before we do the execCommand and continue to operate on that
same range (reasons are documented above).
Arguments:
Returns: string
The html string to format.
|
code » | ||||
Finds the nearest ancestor of the node that is a table.
|
code » | ||||
![]()
No description.
|
code » | ||||
Handle per node special processing if neccessary. If this function returns
null then standard cleanup is applied. Otherwise this node and all children
are assumed to be cleaned.
NOTE(user): If an alternate RemoveFormatting processor is provided
(setRemoveFormattingFunc()), this will no longer work.
|
code » | ||||
![]()
No description.
|
code » | ||||
![]()
No description.
|
code » | ||||
![]()
Optional function to perform remove formatting in place of the
provided removeFormattingWorker_.
|
code » | ||||
![]()
Replaces the contents of the selection with html. Does its best to maintain
the original selection. Also does its best to result in a valid DOM.
TODO(user): See if there's any way to make this work on Ranges, and then
move it into goog.editor.range. The Firefox implementation uses execCommand
on the document, so must work on the actual selection.
Arguments:
|
code » | ||||
![]()
Remove a caret from the dom and hide it in a safe place, so it can
be restored later via restoreCaretsFromCave.
Arguments:
|
code » | ||||
Does a best-effort attempt at clobbering all formatting that the
browser's execCommand couldn't clobber without being totally inefficient.
Attempts to convert visual line breaks to BRs. Leaves anchors that contain an
href and images.
Adapted from Gmail's MessageUtil's htmlToPlainText. http://go/messageutil.js
|
code » | ||||
![]()
Removes formatting from the current selection. Removes basic formatting
(B/I/U) using the browser's execCommand. Then extracts the html from the
selection to convert, calls either a client's specified removeFormattingFunc
callback or trogedit's general built-in removeFormattingWorker_,
and then replaces the current selection with the converted text.
|
code » | ||||
![]()
Restore carets that were hidden away by adding them back into the dom.
Note: this does not restore to the original dom location, as that
will likely have been modified with remove formatting. The only
guarentees here are that start will still be before end, and that
they will be in the editable region. This should only be used when
you don't actually intend to USE the caret again.
|
code » | ||||
![]()
Sets a function to be used for remove formatting.
Arguments:
|
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 » |
![]()
No description.
|
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 » |
![]()
Appends a new line to a string buffer.
|
code » | |||
![]()
Create a new range delimited by the start point of the first range and
the end point of the second range.
Arguments:
Returns: !goog.dom.AbstractRange
The new range.
|
code » |
![]()
Regular expression that matches a block tag name.
|
Code » | |
![]()
The editor command this plugin in handling.
|
Code » | |
![]()
No description.
|
Code » |