ui.Prompt Extends goog.ui.Dialog
Creates an object that represents a prompt (used in place of javascript's prompt). The html structure of the prompt is the same as the layout for dialog.js except for the addition of a text box which is placed inside the "Content area" and has the default class-name 'modal-dialog-userInput'

Inheritance

Constructor

goog.ui.Prompt(promptTitlepromptHtmlcallbackopt_defaultValueopt_classopt_useIframeForIEopt_domHelper)

Parameters

promptTitle : string
The title of the prompt.
promptHtml : string | !goog.html.SafeHtml
The HTML body of the prompt. The variable is trusted and it should be already properly escaped.
callback : Function
The function to call when the user selects Ok or Cancel. The function should expect a single argument which represents what the user entered into the prompt. If the user presses cancel, the value of the argument will be null.
opt_defaultValue : string=
Optional default value that should be in the text box when the prompt appears.
opt_class : string=
Optional prefix for the classes.
opt_useIframeForIE : boolean=
For IE, workaround windowed controls z-index issue by using a an iframe instead of a div for bg element.
opt_domHelper : goog.dom.DomHelper=
Optional DOM helper; see goog.ui.Component for semantics.

Instance Methods

Public Protected Private
Defined in goog.ui.Prompt
createDom()
Create the initial DOM representation for the prompt.
code »
disposeInternal()
No description.
code »
enterDocument()
No description.
code »
focus()
Overrides setFocus to put focus on the input element.
code »
getCols() number
No description.
Returns: number  The number of cols in the user input element.
code »
getInputElement() HTMLInputElement
No description.
Returns: HTMLInputElement  The user input element. May be null if the Prompt has not been rendered.
code »
getRows() number
No description.
Returns: number  The number of rows in the user input element.
code »
handleInputChanged_()
Handles input change events on the input field. Disables the OK button if validation fails on the new input value.
code »
inputDecoratorFn_()
The input decorator function.
code »
onPromptExit_(e)
Handles the closing of the prompt, invoking the callback function that was registered to handle the value returned by the prompt.
Arguments:
e : goog.ui.Dialog.Event
The dialog's selection event.
code »
setCols(cols)
Set the number of cols in the user input element.
Arguments:
cols : number
Number of cols for user input element.
code »
setDefaultValue(defaultValue)
Sets the default value of the prompt when it is displayed.
Arguments:
defaultValue : string
The default value to display.
code »
setInputDecoratorFn(inputDecoratorFn)
Sets an input decorator function. This function will be called in #enterDocument and will be passed the input element. This is useful for attaching handlers to the input element for specific change events, for example.
Arguments:
inputDecoratorFn : function(Element)
A function to call on the input element on #enterDocument.
code »
setRows(rows)
Set the number of rows in the user input element. A values of 1 means use an element. If the prompt is already rendered then you cannot change from to
Arguments:
rows : number
Number of rows for user input element.
code »
setValidationFunction(fn)
Sets the validation function that takes a string and returns true if the string is accepted, false otherwise.
Arguments:
fn : function(string): boolean
The validation function to use on user input.
code »
setVisible(visible)
Causes the prompt to appear, centered on the screen, gives focus to the text box, and selects the text
Arguments:
visible : boolean
Whether the dialog should be visible.
code »
updateOkButtonState_()
Set OK button enabled/disabled state based on input.
code »
validationFn_()
A validation function that takes a string and returns true if the string is accepted, false otherwise.
code »
Defined in goog.ui.Dialog
createDom()
No description.
code »
createDragger() !goog.fx.Dragger
Returns a dragger for moving the dialog and adds a class for the move cursor. Defaults to allow dragging of the title only, but can be overridden if different drag targets or dragging behavior is desired.
Returns: !goog.fx.Dragger  The created dragger instance.
code »
decorateInternal()
No description.
code »
disposeInternal()
No description.
code »
enterDocument()
No description.
code »
exitDocument()
No description.
code »
findParentButton_(element) Element
Finds the parent button of an element (or null if there was no button parent).
Arguments:
element : Element
The element that was clicked on.
Returns: Element  Returns the parent button or null if not found.
code »
getBackgroundElement() Element
Returns the background mask element so that more complicated things can be done with the background region. Renders if the DOM is not yet created.
Returns: Element  The background mask element.
code »
getBackgroundElementOpacity() number
Gets the opacity of the background mask.
Returns: number  Background mask opacity.
code »
getButtonElement() Element
Returns the button element so that more complicated things can be done with the button area. Renders if the DOM is not yet created.
Returns: Element  The button container element.
code »
getButtonSet() ?goog.ui.Dialog.ButtonSet
Returns the button set being used.
Returns: ?goog.ui.Dialog.ButtonSet  The button set being used.
code »
getClass() string
No description.
Returns: string  The CSS class name for the dialog element.
code »
getContent() string
Gets the content HTML of the content element as a plain string. Note that this method returns the HTML markup that was previously set via setContent(). In particular, the HTML returned by this method does not reflect any changes to the content element's DOM that were made my means other than setContent().
Returns: string  Content HTML.
code »
getContentElement() Element
Returns the content element so that more complicated things can be done with the content area. Renders if the DOM is not yet created. Overrides goog.ui.Component#getContentElement.
Returns: Element  The content element.
code »
getCssClass()
No description.
code »
getDialogElement() Element
Returns the dialog element so that more complicated things can be done with the dialog box. Renders if the DOM is not yet created.
Returns: Element  The dialog element.
code »
getDisposeOnHide() boolean
No description.
Returns: boolean  Whether the dialog should be disposed when it is hidden.
code »
getDraggable() boolean
No description.
Returns: boolean  Whether the dialog is draggable.
code »
getHasTitleCloseButton() boolean
No description.
Returns: boolean  Whether this dialog has a title close button.
code »
getModal() boolean
No description.
Returns: boolean  modal Whether the dialog is modal.
code »
getPreferredAriaRole() goog.a11y.aria.Role
Returns the dialog's preferred ARIA role. This can be used to override the default dialog role, e.g. with an ARIA role of ALERTDIALOG for a simple warning or confirmation dialog.
Returns: goog.a11y.aria.Role  This dialog's preferred ARIA role.
code »
getSafeHtmlContent() goog.html.SafeHtml
Gets the content HTML of the content element.
Returns: goog.html.SafeHtml  Content HTML.
code »
getTitle() string
Gets the title.
Returns: string  The title.
code »
getTitleCloseElement() Element
Returns the title close element so that more complicated things can be done with the close area of the title. Renders if the DOM is not yet created.
Returns: Element  The close box.
code »
getTitleElement() Element
Returns the title element so that more complicated things can be done with the title. Renders if the DOM is not yet created.
Returns: Element  The title element.
code »
getTitleTextElement() Element
Returns the title text element so that more complicated things can be done with the text of the title. Renders if the DOM is not yet created.
Returns: Element  The title text element.
code »
handleTitleClose_()
Performs the action of closing the dialog in response to the title close button being interacted with. General purpose method to be called by click and button event handlers.
code »
isEscapeToCancel() boolean
No description.
Returns: boolean  Whether the escape key should close this dialog.
code »
onButtonClick_(e)
Handles a click on the button container.
Arguments:
e : goog.events.BrowserEvent
Browser's event object.
code »
onHide()
No description.
code »
onKey_(e)
Handles keydown and keypress events, and dismisses the popup if cancel is pressed. If there is a cancel action in the ButtonSet, than that will be fired. Also prevents tabbing out of the dialog.
Arguments:
e : goog.events.BrowserEvent
Browser's event object.
code »
onShow()
No description.
code »
onTitleCloseClick_(e)
Handles a click on the title close area.
Arguments:
e : goog.events.BrowserEvent
Browser's event object.
code »
renderIfNoDom_()
Renders if the DOM is not created.
code »
setBackgroundElementOpacity(opacity)
Sets the opacity of the background mask.
Arguments:
opacity : number
Background mask opacity.
code »
setButtonSet(buttons)
Sets the button set to use. Note: Passing in null will cause no button set to be rendered.
Arguments:
buttons : ?goog.ui.Dialog.ButtonSet
The button set to use.
code »
setContent(html)
Allows arbitrary HTML to be set in the content element. TODO(user): Deprecate in favor of setSafeHtmlContent, once developer docs on using goog.html.SafeHtml are in place.
Arguments:
html : string
Content HTML.
code »
setDisposeOnHide(b)
Sets whether the dialog should be disposed when it is hidden. By default dialogs are not disposed when they are hidden.
Arguments:
b : boolean
Whether the dialog should get disposed when it gets hidden.
code »
setDraggable(draggable)
Sets whether the dialog can be dragged.
Arguments:
draggable : boolean
Whether the dialog can be dragged.
code »
setDraggerLimits_(e)
Sets dragger limits when dragging is started.
Arguments:
e : !goog.events.Event
goog.fx.Dragger.EventType.START event.
code »
setDraggingEnabled_(enabled)
Enables or disables dragging.
Arguments:
enabled : boolean
Whether to enable it.
code »
setEscapeToCancel(b)
No description.
Arguments:
b : boolean
Whether the escape key should close this dialog.
code »
setHasTitleCloseButton(b)
Sets whether the dialog should have a close button in the title bar. There will always be an element for the title close button, but setting this parameter to false will cause it to be hidden and have no active listener.
Arguments:
b : boolean
Whether this dialog should have a title close button.
code »
setModal(modal)
Sets the modal property of the dialog. In case the dialog is already inDocument, renders the modal background elements according to the specified modal parameter. Note that non-modal dialogs cannot use an iframe mask.
Arguments:
modal : boolean
Whether the dialog is modal.
code »
setModalInternal_(modal)
Sets the modal property of the dialog.
Arguments:
modal : boolean
Whether the dialog is modal.
code »
setPreferredAriaRole(role)
Sets the dialog's preferred ARIA role. This can be used to override the default dialog role, e.g. with an ARIA role of ALERTDIALOG for a simple warning or confirmation dialog.
Arguments:
role : goog.a11y.aria.Role
This dialog's preferred ARIA role.
code »
setSafeHtmlContent(html)
Allows arbitrary HTML to be set in the content element.
Arguments:
html : !goog.html.SafeHtml
Content HTML.
code »
setTitle(title)
Sets the title.
Arguments:
title : string
The title text.
code »
setVisible(visible)
Sets the visibility of the dialog box and moves focus to the default button. Lazily renders the component if needed. After this method returns, isVisible() will always return the new state, even if there is a transition.
Arguments:
visible : boolean
Whether the dialog should be visible.
code »
canDecorate()
No description.
code »
createDom()
Creates the initial DOM representation for the modal popup.
code »
createTabCatcher_()
Creates the tab catcher element.
code »
decorateInternal()
No description.
code »
disposeInternal()
No description.
code »
enterDocument()
No description.
code »
exitDocument()
No description.
code »
focus()
Focuses on the modal popup.
code »
focusElement_()
Moves the focus to the modal popup.
code »
getBackgroundElement() Element
Returns the background mask element.
Returns: Element  The background mask element.
code »
getBackgroundIframe() Element
Returns the background iframe mask element, if any.
Returns: Element  The background iframe mask element, may return null/undefined if the modal popup does not use iframe mask.
code »
getCssClass() string
No description.
Returns: string  Base CSS class for this component.
code »
getTabCatcherElement() Element
Returns the magic tab catcher element used to detect when the user has rolled focus off of the popup content. It is automatically created during the createDom method() and can be used by subclasses to implement custom tab-loop behavior.
Returns: Element  The tab catcher element.
code »
hide_()
Hides the popup.
code »
isVisible() boolean
No description.
Returns: boolean  Whether the modal popup is visible.
code »
manageBackgroundDom_()
Creates and disposes of the DOM for background mask elements.
code »
onFocus(e)
Handles focus events. Makes sure that if the user tabs past the elements in the modal popup, the focus wraps back to the beginning, and that if the user shift-tabs past the front of the modal popup, focus wraps around to the end.
Arguments:
e : goog.events.BrowserEvent
Browser's event object.
code »
onHide()
Called after the popup is hidden. If there is a transition, this will be called after the transition completed or stopped.
code »
onShow()
Called after the popup is shown. If there is a transition, this will be called after the transition completed or stopped.
code »
renderBackground_()
Renders the background mask.
code »
reposition()
Centers the modal popup in the viewport, taking scrolling into account.
code »
resetBackwardTabWrap_()
Resets the backward tab wrap flag.
code »
resizeBackground_()
Make the background element the size of the document. NOTE(user): We must hide the background element before measuring the document, otherwise the size of the background will stop the document from shrinking to fit a smaller window. This does cause a slight flicker in Linux browsers, but should not be a common scenario.
code »
setA11YDetectBackground(hide)
Sets aria-hidden on the rest of the page to restrict screen reader focus. Top-level elements with an explicit aria-hidden state are not altered.
Arguments:
hide : boolean
Whether to hide or show the rest of the page.
code »
setTransition(popupShowTransitionpopupHideTransitionbgShowTransitionbgHideTransition)
Sets the transitions to show and hide the popup and background.
Arguments:
popupShowTransition : !goog.fx.Transition
Transition to show the popup.
popupHideTransition : !goog.fx.Transition
Transition to hide the popup.
bgShowTransition : !goog.fx.Transition
Transition to show the background.
bgHideTransition : !goog.fx.Transition
Transition to hide the background.
code »
setVisible(visible)
Sets the visibility of the modal popup box and focus to the popup. Lazily renders the component if needed.
Arguments:
visible : boolean
Whether the modal popup should be visible.
code »
setupBackwardTabWrap()
Allow a shift-tab from the top of the modal popup to the last tabbable element by moving focus to the tab catcher. This should be called after catching a wrapping shift-tab event and before allowing it to propagate, so that focus will land on the last tabbable element before the tab catcher.
code »
showPopupElement_(visible)
Shows or hides the popup element.
Arguments:
visible : boolean
Shows the popup element if true, hides if false.
code »
show_()
Shows the popup.
code »
addChild(childopt_render)
Adds the specified component as the last child of this component. See goog.ui.Component#addChildAt for detailed semantics.
Arguments:
child : goog.ui.Component
The new child component.
opt_render : boolean=
If true, the child component will be rendered into the parent.
code »
addChildAt(childindexopt_render) void
Adds the specified component as a child of this component at the given 0-based index. Both addChild and addChildAt assume the following contract between parent and child components:
  • the child component's element must be a descendant of the parent component's element, and
  • the DOM state of the child component must be consistent with the DOM state of the parent component (see isInDocument) in the steady state -- the exception is to addChildAt(child, i, false) and then immediately decorate/render the child.
In particular, parent.addChild(child) will throw an error if the child component is already in the document, but the parent isn't. Clients of this API may call addChild and addChildAt with opt_render set to true. If opt_render is true, calling these methods will automatically render the child component's element into the parent component's element. If the parent does not yet have an element, then createDom will automatically be invoked on the parent before rendering the child. Invoking parent.addChild(child, true) will throw an error if the child component is already in the document, regardless of the parent's DOM state. If opt_render is true and the parent component is not already in the document, enterDocument will not be called on this component at this point. Finally, this method also throws an error if the new child already has a different parent, or the given index is out of bounds.
Arguments:
child : goog.ui.Component
The new child component.
index : number
0-based index at which the new child component is to be added; must be between 0 and the current child count (inclusive).
opt_render : boolean=
If true, the child component will be rendered into the parent.
Returns: void  Nada.
code »
canDecorate(element) boolean
Determines if a given element can be decorated by this type of component. This method should be overridden by inheriting objects.
Arguments:
element : Element
Element to decorate.
Returns: boolean  True if the element can be decorated, false otherwise.
code »
createDom()
Creates the initial DOM representation for the component. The default implementation is to set this.element_ = div.
code »
decorate(element)
Decorates the element for the UI component. If the element is in the document, the enterDocument method will be called. If goog.ui.Component.ALLOW_DETACHED_DECORATION is false, the caller must pass an element that is in the document.
Arguments:
element : Element
Element to decorate.
code »
decorateInternal(element)
Actually decorates the element. Should be overridden by inheriting objects. This method can assume there are checks to ensure the component has not already been rendered have occurred and that enter document will be called afterwards. This method is considered protected.
Arguments:
element : Element
Element to decorate.
code »
disposeInternal()
Disposes of the component. Calls exitDocument, which is expected to remove event handlers and clean up the component. Propagates the call to the component's children, if any. Removes the component's DOM from the document unless it was decorated.
code »
enterDocument()
Called when the component's element is known to be in the document. Anything using document.getElementById etc. should be done at this stage. If the component contains child components, this call is propagated to its children.
code »
exitDocument()
Called by dispose to clean up the elements and listeners created by a component, or by a parent component/application who has removed the component from the document but wants to reuse it later. If the component contains child components, this call is propagated to its children. It should be possible for the component to be rendered again once this method has been called.
code »
forEachChild(fopt_obj)
Calls the given function on each of this component's children in order. If opt_obj is provided, it will be used as the 'this' object in the function when called. The function should take two arguments: the child component and its 0-based index. The return value is ignored.
Arguments:
f : function(this:T,?,number):?
The function to call for every child component; should take 2 arguments (the child and its index).
opt_obj : T=
Used as the 'this' object in f when called.
code »
getChild(id) ?goog.ui.Component
Returns the child with the given ID, or null if no such child exists.
Arguments:
id : string
Child component ID.
Returns: ?goog.ui.Component  The child with the given ID; null if none.
code »
getChildAt(index) ?goog.ui.Component
Returns the child at the given index, or null if the index is out of bounds.
Arguments:
index : number
0-based index.
Returns: ?goog.ui.Component  The child at the given index; null if none.
code »
getChildCount() number
Returns the number of children of this component.
Returns: number  The number of children.
code »
getChildIds() !Array.<string>
Returns an array containing the IDs of the children of this component, or an empty array if the component has no children.
Returns: !Array.<string>  Child component IDs.
code »
getContentElement() Element
Returns the DOM element into which child components are to be rendered, or null if the component itself hasn't been rendered yet. This default implementation returns the component's root element. Subclasses with complex DOM structures must override this method.
Returns: Element  Element to contain child elements (null if none).
code »
getDomHelper() !goog.dom.DomHelper
Returns the dom helper that is being used on this component.
Returns: !goog.dom.DomHelper  The dom helper used on this component.
code »
getElement() Element
Gets the component's element.
Returns: Element  The element for the component.
code »
getElementByClass(className) Element
Returns the first element in this component's DOM with the provided className.
Arguments:
className : string
The name of the class to look for.
Returns: Element  The first item with the class name provided.
code »
getElementByFragment(idFragment) Element
Helper function for returning an element in the document with a unique id generated using makeId().
Arguments:
idFragment : string
The partial id.
Returns: Element  The element with the unique id, or null if it cannot be found.
code »
getElementStrict() !Element
Gets the component's element. This differs from getElement in that it assumes that the element exists (i.e. the component has been rendered/decorated) and will cause an assertion error otherwise (if assertion is enabled).
Returns: !Element  The element for the component.
code »
getElementsByClass(className) !goog.array.ArrayLike
Returns an array of all the elements in this component's DOM with the provided className.
Arguments:
className : string
The name of the class to look for.
Returns: !goog.array.ArrayLike  The items found with the class name provided.
code »
getFragmentFromId(id) string
Helper function for returning the fragment portion of an id generated using makeId().
Arguments:
id : string
Id generated with makeId().
Returns: string  Fragment.
code »
getHandler() !goog.events.EventHandler.<T>
Returns the event handler for this component, lazily created the first time this method is called.
Returns: !goog.events.EventHandler.<T>  Event handler for this component.
code »
getId() string
Gets the unique ID for the instance of this component. If the instance doesn't already have an ID, generates one on the fly.
Returns: string  Unique component ID.
code »
getModel() *
Returns the model associated with the UI component.
Returns: *  The model.
code »
getParent() ?goog.ui.Component
Returns the component's parent, if any.
Returns: ?goog.ui.Component  The parent component.
code »
getRequiredElementByClass(className) !Element
Similar to getElementByClass except that it expects the element to be present in the dom thus returning a required value. Otherwise, will assert.
Arguments:
className : string
The name of the class to look for.
Returns: !Element  The first item with the class name provided.
code »
hasChildren() boolean
Returns true if the component has children.
Returns: boolean  True if the component has children.
code »
indexOfChild(child) number
Returns the 0-based index of the given child component, or -1 if no such child is found.
Arguments:
child : ?goog.ui.Component
The child component.
Returns: number  0-based index of the child component; -1 if not found.
code »
isInDocument() boolean
Determines whether the component has been added to the document.
Returns: boolean  TRUE if rendered. Otherwise, FALSE.
code »
isRightToLeft() boolean
Returns true if the component is rendered right-to-left, false otherwise. The first time this function is invoked, the right-to-left rendering property is set if it has not been already.
Returns: boolean  Whether the control is rendered right-to-left.
code »
makeId(idFragment) string
Helper function for subclasses that gets a unique id for a given fragment, this can be used by components to generate unique string ids for DOM elements.
Arguments:
idFragment : string
A partial id.
Returns: string  Unique element id.
code »
makeIds(object) !Object
Makes a collection of ids. This is a convenience method for makeId. The object's values are the id fragments and the new values are the generated ids. The key will remain the same.
Arguments:
object : Object
The object that will be used to create the ids.
Returns: !Object  An object of id keys to generated ids.
code »
removeChild(childopt_unrender) goog.ui.Component
Removes the given child from this component, and returns it. Throws an error if the argument is invalid or if the specified child isn't found in the parent component. The argument can either be a string (interpreted as the ID of the child component to remove) or the child component itself. If opt_unrender is true, calls goog.ui.component#exitDocument on the removed child, and subsequently detaches the child's DOM from the document. Otherwise it is the caller's responsibility to clean up the child component's DOM.
Arguments:
child : string | goog.ui.Component | null
The ID of the child to remove, or the child component itself.
opt_unrender : boolean=
If true, calls exitDocument on the removed child component, and detaches its DOM from the document.
Returns: goog.ui.Component  The removed component, if any.
code »
removeChildAt(indexopt_unrender) goog.ui.Component
Removes the child at the given index from this component, and returns it. Throws an error if the argument is out of bounds, or if the specified child isn't found in the parent. See goog.ui.Component#removeChild for detailed semantics.
Arguments:
index : number
0-based index of the child to remove.
opt_unrender : boolean=
If true, calls exitDocument on the removed child component, and detaches its DOM from the document.
Returns: goog.ui.Component  The removed component, if any.
code »
removeChildren(opt_unrender) !Array.<goog.ui.Component>
Removes every child component attached to this one and returns them.
Arguments:
opt_unrender : boolean=
If true, calls #exitDocument on the removed child components, and detaches their DOM from the document.
Returns: !Array.<goog.ui.Component>  The removed components if any.
code »
render(opt_parentElement)
Renders the component. If a parent element is supplied, the component's element will be appended to it. If there is no optional parent element and the element doesn't have a parentNode then it will be appended to the document body. If this component has a parent component, and the parent component is not in the document already, then this will not call enterDocument on this component. Throws an Error if the component is already rendered.
Arguments:
opt_parentElement : Element=
Optional parent element to render the component into.
code »
renderBefore(sibling)
Renders the component before another element. The other element should be in the document already. Throws an Error if the component is already rendered.
Arguments:
sibling : Node
Node to render the component before.
code »
render_(opt_parentElementopt_beforeNode)
Renders the component. If a parent element is supplied, the component's element will be appended to it. If there is no optional parent element and the element doesn't have a parentNode then it will be appended to the document body. If this component has a parent component, and the parent component is not in the document already, then this will not call enterDocument on this component. Throws an Error if the component is already rendered.
Arguments:
opt_parentElement : Element=
Optional parent element to render the component into.
opt_beforeNode : Node=
Node before which the component is to be rendered. If left out the node is appended to the parent element.
code »
setElementInternal(element)
Sets the component's root element to the given element. Considered protected and final. This should generally only be called during createDom. Setting the element does not actually change which element is rendered, only the element that is associated with this UI component. This should only be used by subclasses and its associated renderers.
Arguments:
element : Element
Root element for the component.
code »
setId(id)
Assigns an ID to this component instance. It is the caller's responsibility to guarantee that the ID is unique. If the component is a child of a parent component, then the parent component's child index is updated to reflect the new ID; this may throw an error if the parent already has a child with an ID that conflicts with the new ID.
Arguments:
id : string
Unique component ID.
code »
setModel(obj)
Sets the model associated with the UI component.
Arguments:
obj : *
The model.
code »
setParent(parent)
Sets the parent of this component to use for event bubbling. Throws an error if the component already has a parent or if an attempt is made to add a component to itself as a child. Callers must use removeChild or removeChildAt to remove components from their containers before calling this method.
Arguments:
parent : goog.ui.Component
The parent component.
code »
setParentEventTarget()
Overrides goog.events.EventTarget#setParentEventTarget to throw an error if the parent component is set, and the argument is not the parent.
code »
setRightToLeft(rightToLeft)
Set is right-to-left. This function should be used if the component needs to know the rendering direction during dom creation (i.e. before #enterDocument is called and is right-to-left is set).
Arguments:
rightToLeft : boolean
Whether the component is rendered right-to-left.
code »
wasDecorated() boolean
No description.
Returns: boolean  Whether the component was decorated.
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

Defined in goog.ui.Prompt
callback_ :
Callback function which is invoked with the response to the prompt
Code »
cols_ :
Number of cols in the user input element. The default is 0 which means use browser default.
Code »
constructor :
No description.
Code »
defaultValue_ :
Default value to display in prompt window
Code »
inputElementId_ :
The id of the input element.
Code »
isClosing_ :
Tracks whether the prompt is in the process of closing to prevent multiple calls to the callback when the user presses enter.
Code »
rows_ :
Number of rows in the user input element. The default is 1 which means use an element.
Code »
userInputEl_ :
Element in which user enters response (HTML text box)
Code »
Defined in goog.ui.Dialog
backgroundElementOpacity_ :
Opacity for background mask. Defaults to 50%.
Code »
buttonEl_ :
Element for the button bar.
Code »
Button set. Default to Ok/Cancel.
Code »
class_ :
CSS class name for the dialog element, also used as a class name prefix for related elements. Defaults to goog.getCssName('modal-dialog').
Code »
constructor :
No description.
Code »
contentEl_ :
Element for the content area.
Code »
content_ : goog.html.SafeHtml
Dialog's content (HTML).
Code »
disposeOnHide_ :
Whether the dialog should be disposed when it is hidden.
Code »
draggable_ :
Whether the dialog is draggable. Defaults to true.
Code »
dragger_ : goog.fx.Dragger
Dragger.
Code »
escapeToCancel_ :
Whether the escape key closes this dialog.
Code »
hasTitleCloseButton_ :
Whether this dialog should include a title close button.
Code »
modal_ :
Whether the dialog is modal. Defaults to true.
Code »
preferredAriaRole_ :
The dialog's preferred ARIA role.
Code »
titleCloseEl_ :
Element for the close box area of the title bar.
Code »
titleEl_ :
Element for the title bar.
Code »
titleTextEl_ :
Element for the text area of the title bar.
Code »
titleTextId_ :
Id of element for the text area of the title bar.
Code »
title_ :
Dialog's title.
Code »
backwardTabWrapInProgress_ :
Whether the modal popup is in the process of wrapping focus from the top of the popup to the last tabbable element.
Code »
bgEl_ :
Element for the background which obscures the UI and blocks events.
Code »
bgHideTransition_ : goog.fx.Transition
Transition to hide the background.
Code »
bgIframeEl_ :
Iframe element that is only used for IE as a workaround to keep select-type elements from burning through background.
Code »
bgShowTransition_ : goog.fx.Transition
Transition to show the background.
Code »
constructor :
No description.
Code »
focusHandler_ : goog.events.FocusHandler
Focus handler. It will be initialized in enterDocument.
Code »
hiddenElements_ :
The elements set to aria-hidden when the popup was made visible.
Code »
lastFocus_ :
The element that had focus before the popup was displayed.
Code »
popupHideTransition_ : goog.fx.Transition
Transition to hide the popup.
Code »
popupShowTransition_ : goog.fx.Transition
Transition to show the popup.
Code »
tabCatcherElement_ :
Element used to catch focus and prevent the user from tabbing out of the popup.
Code »
useIframeMask_ :
Whether the modal popup should use an iframe as the background element to work around z-order issues.
Code »
visible_ :
Whether the modal popup is visible.
Code »
childIndex_ :
Map of child component IDs to child components. Used for constant-time random access to child components by ID. Lazily initialized on first use. Must be kept in sync with children_. This property is strictly private and must not be accessed directly outside of this class! We use a plain Object, not a goog.structs.Map, for simplicity. This means components can't have children with IDs such as 'constructor' or 'valueOf', but this shouldn't really be an issue in practice, and if it is, we can always fix it later without changing the API.
Code »
children_ :
Array of child components. Lazily initialized on first use. Must be kept in sync with childIndex_. This property is strictly private and must not be accessed directly outside of this class!
Code »
constructor :
No description.
Code »
DomHelper used to interact with the document, allowing components to be created in a different window.
Code »
element_ :
The DOM element for the component.
Code »
googUiComponentHandler_ : goog.events.EventHandler
Event handler. TODO(user): rename it to handler_ after all component subclasses in inside Google have been cleaned up. Code search: http://go/component_code_search
Code »
idGenerator_ : goog.ui.IdGenerator
Generator for unique IDs.
Code »
id_ :
Unique ID of the component, lazily initialized in goog.ui.Component#getId if needed. This property is strictly private and must not be accessed directly outside of this class!
Code »
inDocument_ :
Whether the component is in the document.
Code »
model_ :
Arbitrary data object associated with the component. Such as meta-data.
Code »
parent_ : goog.ui.Component
Parent component to which events will be propagated. This property is strictly private and must not be accessed directly outside of this class!
Code »
rightToLeft_ :
Whether the component is rendered right-to-left. Right-to-left is set lazily when #isRightToLeft is called the first time, unless it has been set by calling #setRightToLeft explicitly.
Code »
wasDecorated_ :
Flag used to keep track of whether a component decorated an already existing element or whether it created the DOM itself. If an element is decorated, dispose will leave the node in the document. It is up to the app to remove the node. If an element was rendered, dispose will remove the node automatically.
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.Prompt.superClass_ :
No description.
Code »

Package ui

Package Reference