editor.plugins.RemoveFormatting Extends goog.editor.Plugin
A plugin to handle removing formatting from selected text.

Inheritance

Constructor

goog.editor.plugins.RemoveFormatting()

Instance Methods

Public Protected Private
adjustRangeForTables_(rangestartInTableendInTable) !goog.dom.SavedCaretRange
Move the range so that it doesn't include any partially selected tables.
Arguments:
range : goog.dom.AbstractRange
The range to adjust.
startInTable : Node
Table node that the range starts in.
endInTable : Node
Table node that the range ends in.
Returns: !goog.dom.SavedCaretRange  Range to use to restore the selection after we run our custom remove formatting.
code »
convertSelectedHtmlText_(convertFunc)
Gets the html inside the current selection, passes it through the given conversion function, and puts it back into the selection.
Arguments:
convertFunc : function(string): string
A conversion function that transforms an html string to new html string.
code »
execCommandInternal()
No description.
code »
getHtmlText_(range) string
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:
range : goog.dom.AbstractRange
The selection.
Returns: string  The html string to format.
code »
getTableAncestor_(nodeToCheck) Node
Finds the nearest ancestor of the node that is a table.
Arguments:
nodeToCheck : Node
Node to search from.
Returns: Node  The table, or null if one was not found.
code »
getTrogClassId()
No description.
code »
getValueForNode(node) ?string
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.
Arguments:
node : Element
The node to clean.
Returns: ?string  The HTML strig representation of the cleaned data.
code »
handleKeyboardShortcut()
No description.
code »
isSupportedCommand()
No description.
code »
optRemoveFormattingFunc_()
Optional function to perform remove formatting in place of the provided removeFormattingWorker_.
code »
pasteHtml_(html)
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:
html : string
The html string to insert into the range.
code »
putCaretInCave_(caretRangeisStart)
Remove a caret from the dom and hide it in a safe place, so it can be restored later via restoreCaretsFromCave.
Arguments:
caretRange : goog.dom.SavedCaretRange
The caret range to get the carets from.
isStart : boolean
Whether this is the start or end caret.
code »
removeFormattingWorker_(html) string
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
Arguments:
html : string
The original html of the message.
Returns: string  The unformatted html, which is just text, br's, anchors and images.
code »
removeFormatting_()
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 »
restoreCaretsFromCave_()
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 »
setRemoveFormattingFunc(removeFormattingFunc)
Sets a function to be used for remove formatting.
Arguments:
removeFormattingFunc : function(string): string
- A function that takes a string of html and returns a string of html that does any other formatting changes desired. Use this only if trogedit's behavior doesn't meet your needs.
code »
activeOnUneditableFields() boolean
No description.
Returns: boolean  If true, field will not disable the command when the field becomes uneditable.
code »
cleanContentsDom(fieldCopy)
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:
fieldCopy : !Element
The copy of the editable field which needs to be cleaned up.
code »
cleanContentsHtml(originalHtml) string
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.
Arguments:
originalHtml : string
The trogedit HTML.
Returns: string  Cleaned-up HTML.
code »
disable(fieldObject)
Disables this plugin for the specified, registered field object.
Arguments:
fieldObject : goog.editor.Field
The field object.
code »
disposeInternal()
No description.
code »
enable(fieldObject)
Enables this plugin for the specified, registered field object. A field object should only be enabled when it is loaded.
Arguments:
fieldObject : goog.editor.Field
The field object.
code »
execCommand(commandvar_args) *
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:
command : string
The command to execute.
var_args : ...*
Any additional parameters needed to execute the command.
Returns: *  The result of the execCommand, if any.
code »
execCommandInternal(commandvar_args) *
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:
command : string
The command to execute.
var_args : ...*
Any additional parameters needed to execute the command.
Returns: *  The result of the execCommand, if any.
code »
getFieldDomHelper() ?goog.dom.DomHelper
No description.
Returns: ?goog.dom.DomHelper  The dom helper object associated with the currently active field.
code »
getFieldObject() goog.editor.Field
Sets the field object for use with this plugin.
Returns: goog.editor.Field  The editable field object.
code »
getTrogClassId() string
No description.
Returns: string  The ID unique to this plugin class. Note that different instances off the plugin share the same classId.
code »
handleKeyDown(e) boolean
Handles keydown. It is run before handleKeyboardShortcut and if it returns true handleKeyboardShortcut will not be called.
Arguments:
e : !goog.events.BrowserEvent
The browser event.
Returns: boolean  Whether the event was handled and thus should *not* be propagated to other plugins or handleKeyboardShortcut.
code »
handleKeyPress(e) boolean
Handles keypress. It is run before handleKeyboardShortcut and if it returns true handleKeyboardShortcut will not be called.
Arguments:
e : !goog.events.BrowserEvent
The browser event.
Returns: boolean  Whether the event was handled and thus should *not* be propagated to other plugins or handleKeyboardShortcut.
code »
handleKeyUp(e) boolean
Handles keyup.
Arguments:
e : !goog.events.BrowserEvent
The browser event.
Returns: boolean  Whether the event was handled and thus should *not* be propagated to other plugins.
code »
handleKeyboardShortcut(ekeyisModifierPressed) boolean
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:
e : !goog.events.BrowserEvent
The browser event.
key : string
The key pressed.
isModifierPressed : boolean
Whether the ctrl/meta key was pressed or not.
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 »
handleSelectionChange(opt_eopt_target) boolean
Handles selection change.
Arguments:
opt_e : !goog.events.BrowserEvent=
The browser event.
opt_target : !Node=
The node the selection changed to.
Returns: boolean  Whether the event was handled and thus should *not* be propagated to other plugins.
code »
isAutoDispose() boolean
No description.
Returns: boolean  Whether or not this plugin should automatically be disposed when it's registered field is disposed.
code »
isEnabled(fieldObject) boolean
Returns whether this plugin is enabled for the field object.
Arguments:
fieldObject : goog.editor.Field
The field object.
Returns: boolean  Whether this plugin is enabled for the field object.
code »
isSilentCommand(command) boolean
No description.
Arguments:
command : string
The command to check.
Returns: boolean  If true, field will not dispatch change events for commands of this type. This is useful for "seamless" plugins like dialogs and lorem ipsum.
code »
isSupportedCommand(command) boolean
Whether the string corresponds to a command this plugin handles.
Arguments:
command : string
Command string to check.
Returns: boolean  Whether the plugin handles this type of command.
code »
prepareContentsHtml(originalHtmlstyles) string
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.
Arguments:
originalHtml : string
The original HTML.
styles : Object
A map of strings. If the plugin wants to add any styles to the field element, it should add them as key-value pairs to this object.
Returns: string  New HTML that's ok for editing.
code »
queryCommandValue(command) *
Gets the state of this command if this plugin serves that command.
Arguments:
command : string
The command to check.
Returns: *  The value of the command.
code »
registerFieldObject(fieldObject)
Registers the field object for use with this plugin.
Arguments:
fieldObject : goog.editor.Field
The editable field object.
code »
setAutoDispose(autoDispose)
Set if this plugin should automatically be disposed when the registered field is disposed.
Arguments:
autoDispose : boolean
Whether to autoDispose.
code »
setFieldObject(fieldObject)
Sets the field object for use with this plugin.
Arguments:
fieldObject : goog.editor.Field
The editable field object.
code »
unregisterFieldObject(fieldObj)
Unregisters and disables this plugin for the current field object.
Arguments:
fieldObj : goog.editor.Field
The field object. For single-field plugins, this parameter is ignored.
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 »
autoDispose_ :
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 »
constructor :
No description.
Code »
enabled_ :
Whether this plugin is enabled for the registered field object.
Code »
fieldObject : goog.editor.Field
The field object this plugin is attached to.
Code »
The logger for this plugin.
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 Methods

goog.editor.plugins.RemoveFormatting.appendNewline_(sb)
Appends a new line to a string buffer.
Arguments:
sb : Array.<string>
The string buffer to add to.
code »
goog.editor.plugins.RemoveFormatting.createRangeDelimitedByRanges_(startRangeendRange) !goog.dom.AbstractRange
Create a new range delimited by the start point of the first range and the end point of the second range.
Arguments:
startRange : goog.dom.AbstractRange
Use the start point of this range as the beginning of the new range.
endRange : goog.dom.AbstractRange
Use the end point of this range as the end of the new range.
Returns: !goog.dom.AbstractRange  The new range.
code »

Static Properties

goog.editor.plugins.RemoveFormatting.BLOCK_RE_ :
Regular expression that matches a block tag name.
Code »
goog.editor.plugins.RemoveFormatting.REMOVE_FORMATTING_COMMAND :
The editor command this plugin in handling.
Code »
goog.editor.plugins.RemoveFormatting.superClass_ :
No description.
Code »

Package editor.plugins

Package Reference