• index
• goog
• ui
• search: Go

The goog.ui.OfflineInstallDialogScreen Class

goog.ui.OfflineInstallDialogScreen
> goog.Disposable

goog.ui.OfflineInstallDialogScreen(dialog, type)

Represents a screen on the dialog. You can create new screens and add them to the offline install dialog by calling registerScreenType and setCurrentScreenType.

dialog {goog.ui.OfflineInstallDialog}

The dialog this screen should work with.

type {string}

The screen type name.

.activate()

Called when the screen is shown. At this point the dialog is in the document.

.addOnDisposeCallback(callback, opt_scope)

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}

The callback function.

opt_scope {Object=}

An optional scope to call the callback in.

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

.deactivate()

Called when the screen is hidden. At this point the dialog is in the document.

.dispose()

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}

Nothing.

   mypackage.MyClass = function() {
     goog.base(this);
     // Constructor logic specific to MyClass.
     ...
   };
   goog.inherits(mypackage.MyClass, goog.Disposable);

   mypackage.MyClass.prototype.disposeInternal = function() {
     goog.base(this, 'disposeInternal');
     // Dispose logic specific to MyClass.
     ...
   };
 

.getButtonSet()

returns {goog.ui.Dialog.ButtonSet}

The button set to use with this screen.

.getContent()

returns {string}

The HTML content to used for this screen.

.getCustomClassName()

returns {string}

A custom class name that should be added to the dialog when this screen is active.

.getDialog()

returns {goog.ui.OfflineInstallDialog}

The dialog the screen will be displayed in.

.getTitle()

returns {string}

The text title to used for the dialog when this screen is shown.

.getType()

Returns the type of the screen. This is used to identify the screen type this reflects.

returns {string}

The type of the screen.

.handleSelect(e)

Called when the user clicks any of the buttons for this dialog screen.

e {goog.ui.Dialog.Event}

The dialog event.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.registerDisposable(disposable)

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}

that will be disposed when this object is disposed.

.setButtonSet(bs)

Sets the button set to use with this screen.

bs {goog.ui.Dialog.ButtonSet}

The button set to use.

.setContent(html)

Sets the HTML content to use for this screen.

html {string}

The HTML text to use as content for the screen.

.setCustomClassName(customClassName)

Sets the custom class name that should be added to the dialog when this screen is active.

customClassName {string}

The custom class name.

.setTitle(title)

Sets the plain text title to use for this screen.

title {string}

The plain text to use as a title on the dialog.

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.