ui.editor.AbstractDialog Extends goog.events.EventTarget
Creates an object that represents a dialog box.

Inheritance

Constructor

goog.ui.editor.AbstractDialog(domHelper)

Parameters

domHelper : goog.dom.DomHelper
DomHelper to be used to create the dialog's dom structure.

Instance Methods

Public Protected Private
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

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 Properties

goog.ui.editor.AbstractDialog.superClass_ :
No description.
Code »

Enumerations

goog.ui.editor.AbstractDialog.EventType :
Event type constants for events the dialog fires.
Constants:
AFTER_HIDE
No description.
CANCEL
No description.
OK
No description.
Code »

Package ui.editor

Package Reference