ui.editor.LinkDialog Extends goog.ui.editor.AbstractDialog
A type of goog.ui.editor.AbstractDialog for editing/creating a link.

Inheritance

Constructor

goog.ui.editor.LinkDialog(domHelperlink)

Parameters

domHelper : goog.dom.DomHelper
DomHelper to be used to create the dialog's dom structure.
link : goog.editor.Link
The target link.

Instance Methods

Public Protected Private
buildOpenInNewWindowDiv_() !Element
Builds and returns the "checkbox to open the link in a new window" section of the edit link dialog.
Returns: !Element  A div element to be appended into the dialog div.
code »
buildRelNoFollowDiv_() !Element
Creates a DIV with a checkbox for rel=nofollow option.
Returns: !Element  Newly created DIV element.
code »
buildTabEmailAddress_() !Element
Builds and returns the div containing the tab "Email address".
Returns: !Element  the div element containing the tab.
code »
buildTabOnTheWeb_() !Element
Builds and returns the div containing the tab "On the web".
Returns: !Element  The div element containing the tab.
code »
buildTextToDisplayDiv_() !Element
Builds and returns the text to display section of the edit link dialog.
Returns: !Element  A div element to be appended into the dialog div.
code »
createDialogContent_() !Element
Creates contents of this dialog.
Returns: !Element  Contents of the dialog as a DOM element.
code »
createDialogControl()
No description.
code »
createOkEvent() !goog.ui.editor.LinkDialog.OkEvent
Creates and returns the event object to be used when dispatching the OK event to listeners based on which tab is currently selected and the contents of the input fields of that tab.
Returns: !goog.ui.editor.LinkDialog.OkEvent  The event object to be used when dispatching the OK event to listeners.
code »
createOkEventFromEmailTab_(opt_inputId) !goog.ui.editor.LinkDialog.OkEvent
The function called when hitting OK with the "email address" tab current.
Arguments:
opt_inputId : string=
Id of an alternate input to check.
Returns: !goog.ui.editor.LinkDialog.OkEvent  The event object to be used when dispatching the OK event to listeners.
code »
createOkEventFromUrl_(url) !goog.ui.editor.LinkDialog.OkEvent
Creates an OK event from the text to display input and the specified link. If text to display input is empty, then generate the auto value for it.
Arguments:
url : string
Url the target element should point to.
Returns: !goog.ui.editor.LinkDialog.OkEvent  The event object to be used when dispatching the OK event to listeners.
code »
createOkEventFromWebTab_() !goog.ui.editor.LinkDialog.OkEvent
The function called when hitting OK with the "On the web" tab current.
Returns: !goog.ui.editor.LinkDialog.OkEvent  The event object to be used when dispatching the OK event to listeners.
code »
disableAutogenFlag_(autogen)
Disables autogen so that onUrlOrEmailInputChange_ doesn't act in cases that are undesirable.
Arguments:
autogen : boolean
Boolean value to set disableAutogen to.
code »
disposeInternal()
No description.
code »
getTargetUrl_() string
Returns the url that the target points to.
Returns: string  The url that the target points to.
code »
guessUrlAndSelectTab_(text)
Select a url/tab based on the link's text. This function is simply the isNewLink_() == true case of selectAppropriateTab_().
Arguments:
text : string
The inner text of the link.
code »
hide()
No description.
code »
isNewLink_() boolean
No description.
Returns: boolean  Whether the link is new.
code »
onChangeTab_(e)
Called when the currently selected tab changes.
Arguments:
e : goog.events.Event
The tab change event.
code »
onTextToDisplayEdit_()
Changes the autogenerateTextToDisplay flag so that text to display stops autogenerating.
code »
onUrlOrEmailInputChange_()
Called whenever the url or email input is edited. If the text to display matches the text to display, turn on auto. Otherwise if auto is on, update the text to display based on the url.
code »
onWebTestLink_()
Function to test a link from the on the web tab.
code »
selectAppropriateTab_(texturl)
Selects the correct tab based on the URL, and fills in its inputs. For new links, it suggests a url based on the link text.
Arguments:
text : string
The inner text of the link.
url : string
The href for the link.
code »
setAutogenFeatureEnabled(enable)
Tells the dialog whether the autogeneration of text to display is to be enabled.
Arguments:
enable : boolean
Whether to enable the feature.
code »
setAutogenFlagFromCurInput_()
If an email or url is being edited, set autogenerate to on if the text to display matches the url.
code »
setAutogenFlag_(val)
Turn on the autogenerate text to display flag, and set some sort of indicator that autogen is on.
Arguments:
val : boolean
Boolean value to set autogenerate to.
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 »
setStopReferrerLeaks(stop)
Tells the plugin whether to stop leaking the page's url via the referrer header when the "test this link" link is clicked.
Arguments:
stop : boolean
Whether to stop leaking the referrer.
code »
setTextToDisplayFromAuto_()
If autogen is turned on, set the value of text to display based on the current selection or url.
code »
setTextToDisplayVisible(visible)
Tells the dialog whether to show the 'text to display' div. When the target element of the dialog is an image, there is no link text to modify. This function can be used for this kind of situations.
Arguments:
visible : boolean
Whether to make 'text to display' div visible.
code »
show()
No description.
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 add 'rel=nofollow' attribute to the link.
code »
syncOkButton_()
Called on a change to the url or email input. If either one of those tabs is active, sets the OK button to enabled/disabled accordingly.
code »
toggleInvalidEmailWarning_(on)
Show/hide the Invalid Email Address warning.
Arguments:
on : boolean
Whether to show the warning.
code »
createDialogControl() !goog.ui.Dialog
Creates and returns the goog.ui.Dialog control that is being wrapped by this object.
Returns: !goog.ui.Dialog  Created Dialog control.
code »
createOkEvent(e) goog.events.Event
Creates and returns the event object to be used when dispatching the OK event to listeners, or returns null to prevent the dialog from closing. Subclasses should override this to return their own subclass of goog.events.Event that includes all data a plugin would need from the dialog.
Arguments:
e : goog.events.Event
The event object dispatched by the wrapped dialog.
Returns: goog.events.Event  The event object to be used when dispatching the OK event to listeners.
code »
disposeInternal()
Disposes of the dialog. If the dialog is open, it will be hidden and AFTER_HIDE will be dispatched.
code »
getButtonElement(buttonId) Element
Returns the HTML Button element for the button added to this dialog with the given button id.
Arguments:
buttonId : string
The id of the button to get.
Returns: Element  The button element if found, else null.
code »
getCancelButtonElement() Element
Returns the HTML Button element for the Cancel button in this dialog.
Returns: Element  The button element if found, else null.
code »
getOkButtonElement() Element
Returns the HTML Button element for the OK button in this dialog.
Returns: Element  The button element if found, else null.
code »
handleAfterHide_()
Cleans up after the dialog is hidden and fires the AFTER_HIDE event. Should be a listener for the wrapped dialog's AFTER_HIDE event.
code »
handleCancel() boolean
Handles the event dispatched by the wrapped dialog control when the user clicks the Cancel button. Simply dispatches a CANCEL event.
Returns: boolean  Returns false if any of the handlers called prefentDefault on the event or returned false themselves.
code »
handleOk(e) boolean
Handles the event dispatched by the wrapped dialog control when the user clicks the OK button. Attempts to create the OK event object and dispatches it if successful.
Arguments:
e : goog.ui.Dialog.Event
wrapped dialog OK event object.
Returns: boolean  Whether the default action (closing the dialog) should still be executed. This will be false if the OK event could not be created to be dispatched, or if any listener to that event returs false or calls preventDefault.
code »
hide()
Hides the dialog, causing AFTER_HIDE to fire.
code »
isOpen() boolean
No description.
Returns: boolean  Whether the dialog is open.
code »
processOkAndClose()
Runs the handler registered on the OK button event and closes the dialog if that handler succeeds. This is useful in cases such as double-clicking an item in the dialog is equivalent to selecting it and clicking the default button.
code »
show()
Causes the dialog box to appear, centered on the screen. Lazily creates the dialog if needed.
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

autogenFeatureEnabled_ :
Whether or not the feature of automatically generating the display text is enabled.
Code »
autogenerateTextToDisplay_ :
Whether or not we should automatically generate the display text.
Code »
constructor :
No description.
Code »
disableAutogen_ :
Whether or not automatic generation of the display text is disabled.
Code »
emailInputHandler_ : goog.events.InputHandler
InputHandler object to listen for changes in the email input field.
Code »
emailWarning_ :
Optional warning to show about email addresses.
Code »
eventHandler_ : goog.events.EventHandler
EventHandler object that keeps track of all handlers set by this dialog.
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 »
openInNewWindowCheckbox_ :
The input element (checkbox) to indicate that the link should open in a new window.
Code »
relNoFollowCheckbox_ :
The input element (checkbox) to indicate that the link should have 'rel=nofollow' attribute.
Code »
showOpenLinkInNewWindow_ :
Whether to show a checkbox where the user can choose to have the link open in a new window.
Code »
showRelNoFollow_ :
Whether to show a checkbox where the user can choose to have 'rel=nofollow' attribute added to the link.
Code »
stopReferrerLeaks_ :
Whether to stop leaking the page's url via the referrer header when the "test this link" link is clicked.
Code »
The tab bar where the url and email tabs are.
Code »
targetLink_ : goog.editor.Link
The link being modified by this dialog.
Code »
textToDisplayDiv_ :
The div element holding the link's display text input.
Code »
textToDisplayInput_ :
The input element holding the link's display text.
Code »
urlInputHandler_ : goog.events.InputHandler
InputHandler object to listen for changes in the url input field.
Code »
constructor :
No description.
Code »
dialogInternal_ : goog.ui.Dialog
The wrapped dialog widget.
Code »
The DOM helper for the parent document.
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.ui.editor.LinkDialog.hasNoFollow(str) boolean
Checks if str contains "nofollow" as a separate word.
Arguments:
str : string
String to be tested. This is usually rel attribute of an HTMLAnchorElement object.
Returns: boolean  true if str contains nofollow.
code »
goog.ui.editor.LinkDialog.removeNoFollow(rel) string
Removes "nofollow" from rel if it's present as a separate word.
Arguments:
rel : string
Input string. This is usually rel attribute of an HTMLAnchorElement object.
Returns: string  rel with any "nofollow" removed.
code »

Static Properties

goog.ui.editor.LinkDialog.BUTTON_GROUP_ :
Base name for the radio buttons group.
Code »
goog.ui.editor.LinkDialog.EMAIL_WARNING_CLASSNAME_ :
Class name for the email address warning element.
Code »
goog.ui.editor.LinkDialog.EXPLANATION_TEXT_CLASSNAME_ :
Class name for the explanation text elements.
Code »
goog.ui.editor.LinkDialog.NO_FOLLOW_REGEX_ :
Regular expression that matches nofollow value in an * HTMLAnchorElement's rel element.
Code »
goog.ui.editor.LinkDialog.TARGET_INPUT_CLASSNAME_ :
Class name for the url and email input elements.
Code »
goog.ui.editor.LinkDialog.superClass_ :
No description.
Code »

Enumerations

goog.ui.editor.LinkDialog.EventType :
Events specific to the link dialog.
Constants:
BEFORE_TEST_LINK
No description.
Code »
goog.ui.editor.LinkDialog.Id_ :
IDs for relevant DOM elements.
Constants:
EMAIL_ADDRESS_INPUT
No description.
EMAIL_ADDRESS_TAB
No description.
EMAIL_WARNING
No description.
ON_WEB_INPUT
No description.
ON_WEB_TAB
No description.
TAB_INPUT_SUFFIX
No description.
TEXT_TO_DISPLAY
No description.
Code »

Package ui.editor

Package Reference