ui.TabPane Extends goog.events.EventTarget
TabPane widget. All children already inside the tab pane container element will be be converted to tabs. Each tab is represented by a goog.ui.TabPane. TabPage object. Further pages can be constructed either from an existing container or created from scratch.

Inheritance

Constructor

goog.ui.TabPane(elopt_tabLocationopt_domHelperopt_useMouseDown)

Parameters

el : Element
Container element to create the tab pane out of.
opt_tabLocation : goog.ui.TabPane.TabLocation=
Location of the tabs in relation to the content container. Default is top.
opt_domHelper : goog.dom.DomHelper=
Optional DOM helper.
opt_useMouseDown : boolean=
Whether to use MOUSEDOWN instead of CLICK for tab changes.

Instance Methods

Public Protected Private
addPage(pageopt_index)
Adds a page to the tab pane.
Arguments:
page : goog.ui.TabPane.TabPage
Tab page to add.
opt_index : number=
Zero based index to insert tab at. Inserted at the end if not specified.
code »
createClear_() !Element
Creates the HTML node for the clearing div, and associated style in the .
Returns: !Element  Reference to a DOM div node.
code »
createPages_(nodes)
Creates pages out of a collection of elements.
Arguments:
nodes : Array.<Element>
Array of elements to create pages out of.
code »
create_()
Creates HTML nodes for tab pane.
code »
disposeInternal()
No description.
code »
getChildNodes_() !Array.<Element>
No description.
Returns: !Array.<Element>  The element child nodes of tab pane container.
code »
getContentElement() Element
No description.
Returns: Element  The element that contains the tab pages.
code »
getElement() Element
No description.
Returns: Element  The main element for the tabpane.
code »
getPage(index) ?goog.ui.TabPane.TabPage
Gets the tab page by zero based index.
Arguments:
index : number
Index of page to return.
Returns: ?goog.ui.TabPane.TabPage  page The tab page.
code »
getSelectedIndex() number
No description.
Returns: number  The index for the selected tab page or -1 if no page is selected.
code »
getSelectedPage() ?goog.ui.TabPane.TabPage
No description.
Returns: ?goog.ui.TabPane.TabPage  The selected tab page.
code »
onHeaderClick_(event)
Click event handler for header element, handles clicks on tabs.
Arguments:
event : goog.events.BrowserEvent
Click event.
code »
onHeaderKeyDown_(event)
KeyDown event handler for header element. Arrow keys moves between pages. Home and end selects the first/last page.
Arguments:
event : goog.events.BrowserEvent
KeyDown event.
code »
removePage(page)
Removes the specified page from the tab pane.
Arguments:
page : goog.ui.TabPane.TabPage | number
Reference to tab page or zero based index.
code »
setSelectedIndex(index)
Sets the selected tab page by zero based index.
Arguments:
index : number
Index of page to select.
code »
setSelectedPage(page)
Sets the selected tab page by object reference.
Arguments:
page : goog.ui.TabPane.TabPage
Tab page to select.
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 »
DomHelper used to interact with the document, allowing components to be created in a different window. This property is considered protected; subclasses of Component may refer to it directly.
Code »
elButtonBar_ :
Element containing the tab buttons.
Code »
elContent_ :
Element containing the tab pages.
Code »
el_ :
Tab pane element.
Code »
pages_ :
Collection of tab panes.
Code »
Selected page.
Code »
tabLocation_ :
Location of the tabs with respect to the content box.
Code »
useMouseDown_ :
Whether to use MOUSEDOWN instead of CLICK for tab change events. This fixes some focus problems on Safari/Chrome.
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.TabPane.Events :
Constants for event names
Code »
goog.ui.TabPane.superClass_ :
No description.
Code »

Enumerations

goog.ui.TabPane.TabLocation :
Enum for representing the location of the tabs in relation to the content.
Constants:
BOTTOM
No description.
LEFT
No description.
RIGHT
No description.
TOP
No description.
Code »

Package ui

Package Reference