editor.plugins.LinkDialogPlugin Extends goog.editor.plugins.AbstractDialogPlugin
A plugin that opens the link dialog.

Inheritance

Constructor

goog.editor.plugins.LinkDialogPlugin()

Instance Methods

Public Protected Private
createDialog(dialogDomHelperopt_link) !goog.ui.editor.LinkDialog
Creates a new instance of the dialog and registers for the relevant events.
Arguments:
dialogDomHelper : goog.dom.DomHelper
The dom helper to be used to create the dialog.
opt_link : *=
The target link (should be a goog.editor.Link).
Returns: !goog.ui.editor.LinkDialog  The dialog.
code »
disposeInternal()
No description.
code »
execCommandInternal(commandopt_arg) *
Handles execCommand by opening the dialog.
Arguments:
command : string
The command to execute.
opt_arg : *=
A goog.editor.Link object representing the link being edited.
Returns: *  Always returns true, indicating the dialog was shown.
code »
getCurrentLink() goog.editor.Link
No description.
Returns: goog.editor.Link  The link being edited.
code »
getEventHandler() goog.events.EventHandler.<T>
No description.
Returns: goog.events.EventHandler.<T>  The event handler.
code »
getOpenLinkInNewWindowCheckedState() boolean
Returns whether the"open link in new window" checkbox was checked last time the dialog was closed.
Returns: boolean  Whether the"open link in new window" checkbox was checked last time the dialog was closed.
code »
handleAfterHide(e)
Handles when the dialog closes.
Arguments:
e : goog.events.Event
The AFTER_HIDE event object.
code »
handleBeforeTestLink(e)
Handles the BeforeTestLink event fired when the 'test' link is clicked.
Arguments:
e : goog.ui.editor.LinkDialog.BeforeTestLinkEvent
BeforeTestLink event object.
code »
handleCancel_(e)
Handles the CANCEL event from the dialog by clearing the anchor if needed.
Arguments:
e : goog.events.Event
Event object.
code »
handleOk(e)
Handles the OK event from the dialog by updating the link in the field.
Arguments:
e : goog.ui.editor.LinkDialog.OkEvent
OK event object.
code »
isSafeSchemeToOpen_(url) boolean
Determines whether or not a url has a scheme which is safe to open. Schemes like javascript are unsafe due to the possibility of XSS.
Arguments:
url : string
A url.
Returns: boolean  Whether the url has a safe scheme.
code »
setBlockOpeningUnsafeSchemes(blockOpeningUnsafeSchemes)
Tells the plugin whether to block URLs with schemes not in the whitelist. If blocking is enabled, this plugin will stop the 'Test Link' popup window from being created. Blocking doesn't affect link creation--if the user clicks the 'OK' button with an unsafe URL, the link will still be created as normal.
Arguments:
blockOpeningUnsafeSchemes : boolean
Whether to block non-whitelisted schemes.
code »
setEmailWarning(emailWarning)
Sets the warning message to show to users about including email addresses on public web pages.
Arguments:
emailWarning : string
Warning message to show users about including email addresses on the web.
code »
setSafeToOpenSchemes(schemes)
Sets a whitelist of allowed URL schemes that are safe to open. Schemes should all be in lowercase. If the plugin is set to block opening unsafe schemes, user-entered URLs will be converted to lowercase and checked against this list. The whitelist has no effect if blocking is not enabled.
Arguments:
schemes : Array.<string>
String array of URL schemes to allow (http, https, etc.).
code »
shouldOpenUrl(url) boolean
Checks whether the plugin should open the given url in a new window.
Arguments:
url : string
The url to check.
Returns: boolean  If the plugin should open the given url in a new window.
code »
showOpenLinkInNewWindow(startChecked)
Tells the dialog to show a checkbox where the user can choose to have the link open in a new window.
Arguments:
startChecked : boolean
Whether to check the checkbox the first time the dialog is shown. Subesquent times the checkbox will remember its previous state.
code »
showRelNoFollow()
Tells the dialog to show a checkbox where the user can choose to have 'rel=nofollow' attribute added to the link.
code »
stopReferrerLeaks()
Tells the plugin to stop leaking the page's url via the referrer header when the "test this link" link is clicked. When the user clicks on a link, the browser makes a request for the link url, passing the url of the current page in the request headers. If the user wants the current url to be kept secret (e.g. an unpublished document), the owner of the url that was clicked will see the secret url in the request headers, and it will no longer be a secret. Calling this method will not send a referrer header in the request, just as if the user had opened a blank window and typed the url in themselves.
code »
touchUpAnchorOnOk_(anchore)
Apply the necessary properties to a link upon Ok being clicked in the dialog.
Arguments:
anchor : HTMLAnchorElement
The anchor to set properties on.
e : goog.events.Event
Event object.
code »
createDialog(dialogDomHelperopt_arg) goog.ui.editor.AbstractDialog
Creates a new instance of this plugin's dialog. Must be overridden by subclasses.
Arguments:
dialogDomHelper : !goog.dom.DomHelper
The dom helper to be used to create the dialog.
opt_arg : *=
The dialog specific argument. Concrete subclasses should declare a specific type.
Returns: goog.ui.editor.AbstractDialog  The newly created dialog.
code »
disposeDialog_()
Disposes of the dialog if needed. It is this abstract class' responsibility to dispose of the dialog. The "if needed" refers to the fact this method might be called twice (nested calls, not sequential) in the dispose flow, so if the dialog was already disposed once it should not be disposed again.
code »
disposeInternal()
No description.
code »
disposeOriginalSelection()
Cleans up the structure used to save the original selection before the dialog was opened. Should be used by subclasses that don't restore the original selection via restoreOriginalSelection.
code »
execCommand(commandvar_args) *
Handles execCommand. Dialog plugins don't make any changes when they open a dialog, just when the dialog closes (because only modal dialogs are supported). Hence this method does not dispatch the change events that the superclass method does.
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(commandopt_arg) *
Handles execCommand by opening the dialog. Dispatches goog.editor.plugins.AbstractDialogPlugin.EventType.OPENED after the dialog is shown.
Arguments:
command : string
The command to execute.
opt_arg : *=
The dialog specific argument. Should be the same as createDialog.
Returns: *  Always returns true, indicating the dialog was shown.
code »
Returns the current dialog that was created and opened by this plugin.
Returns: goog.ui.editor.AbstractDialog  The current dialog that was created and opened by this plugin.
code »
handleAfterHide(e)
Cleans up after the dialog has closed, including restoring the selection to what it was before the dialog was opened. If a subclass modifies the editable field's content such that the original selection is no longer valid (usually the case when the user clicks OK, and sometimes also on Cancel), it is that subclass' responsibility to place the selection in the desired place during the OK or Cancel (or other) handler. In that case, this method will leave the selection in place.
Arguments:
e : goog.events.Event
The AFTER_HIDE event object.
code »
isSupportedCommand()
No description.
code »
restoreOriginalSelection()
Restores the selection in the editable field to what it was before the dialog was opened. This is not guaranteed to work if the contents of the field have changed.
code »
setReuseDialog(reuse)
Sets whether this plugin should reuse the same instance of the dialog each time execCommand is called or create a new one. This is intended for use by subclasses only, hence protected.
Arguments:
reuse : boolean
Whether to reuse the dialog.
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

blockOpeningUnsafeSchemes_ :
Whether to block opening links with a non-whitelisted URL scheme.
Code »
constructor :
No description.
Code »
currentLink_ : goog.editor.Link
Link object that the dialog is editing.
Code »
emailWarning_ :
Optional warning to show about email addresses.
Code »
eventHandler_ : goog.events.EventHandler
Event handler for this object.
Code »
isOpenLinkInNewWindowChecked_ :
Whether the "open link in new window" checkbox should be checked when the dialog is shown, and also whether it was checked last time the dialog was closed.
Code »
safeToOpenSchemes_ :
A list of whitelisted URL schemes which are safe to open.
Code »
showOpenLinkInNewWindow_ :
Whether to show a checkbox where the user can choose to have the link open in a new window.
Code »
showRelNoFollow_ :
Weather to show a checkbox where the user can choose to add 'rel=nofollow' attribute added to the link.
Code »
stopReferrerLeaks_ :
Whether to stop referrer leaks. Defaults to false.
Code »
command_ :
The command that this plugin handles.
Code »
constructor :
No description.
Code »
The current dialog that was created and opened by this plugin.
Code »
isDisposingDialog_ :
Mutex to prevent recursive calls to disposeDialog_.
Code »
reuseDialog_ :
Whether this plugin should reuse the same instance of the dialog each time execCommand is called or create a new one.
Code »
savedRange_ : goog.dom.SavedRange
SavedRange representing the selection before the dialog was opened.
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 Properties

goog.editor.plugins.LinkDialogPlugin.superClass_ :
No description.
Code »

Package editor.plugins

Package Reference