ui.Zippy Extends goog.events.EventTarget
Zippy widget. Expandable/collapsible container, clicking the header toggles the visibility of the content.

Inheritance

Constructor

goog.ui.Zippy(headeropt_contentopt_expandedopt_expandedHeaderopt_domHelper)

Parameters

header : Element | string | null
Header element, either element reference, string id or null if no header exists.
opt_content : Element | string | function():Element=
Content element (if any), either element reference or string id. If skipped, the caller should handle the TOGGLE event in its own way. If a function is passed, then if will be called to create the content element the first time the zippy is expanded.
opt_expanded : boolean=
Initial expanded/visibility state. Defaults to false.
opt_expandedHeader : Element | string=
Element to use as the header when the zippy is expanded.
opt_domHelper : goog.dom.DomHelper=
An optional DOM helper.

Instance Methods

Public Protected Private
Defined in goog.ui.Zippy
collapse()
Collapses content pane.
code »
dispatchActionEvent_()
Dispatch an ACTION event whenever there is user interaction with the header. Please note that after the zippy state change is completed a TOGGLE event will be dispatched. However, the TOGGLE event is dispatch on every toggle, including programmatic call to #toggle.
code »
disposeInternal()
No description.
code »
enableKeyboardEventsHandling_(header)
Enables keyboard events handling for the passed header element.
Arguments:
header : Element
The header element.
code »
enableMouseEventsHandling_(header)
Enables mouse events handling for the passed header element.
Arguments:
header : Element
The header element.
code »
expand()
Expands content pane.
code »
getAriaRole() goog.a11y.aria.Role
No description.
Returns: goog.a11y.aria.Role  The ARIA role to be applied to Zippy element.
code »
getContentElement() Element
No description.
Returns: Element  The content element.
code »
getVisibleHeaderElement() Element
No description.
Returns: Element  The visible header element.
code »
isExpanded() boolean
No description.
Returns: boolean  Whether the zippy is expanded.
code »
isHandleKeyEvents() boolean
No description.
Returns: boolean  Whether the Zippy handles its own key events.
code »
isHandleMouseEvents() boolean
No description.
Returns: boolean  Whether the Zippy handles its own mouse events.
code »
lazyCreateFunc_()
Function that will create the content element, or false if there is no such function.
code »
onHeaderClick_(event)
Click event handler for header element.
Arguments:
event : goog.events.BrowserEvent
Click event.
code »
onHeaderKeyDown_(event)
KeyDown event handler for header element. Enter and space toggles expanded state.
Arguments:
event : goog.events.BrowserEvent
KeyDown event.
code »
setExpanded(expanded)
Sets expanded state.
Arguments:
expanded : boolean
Expanded/visibility state.
code »
setExpandedInternal(expanded)
Sets expanded internal state.
Arguments:
expanded : boolean
Expanded/visibility state.
code »
setHandleKeyboardEvents(enable)
Sets whether the Zippy handles it's own keyboard events.
Arguments:
enable : boolean
Whether the Zippy handles keyboard events.
code »
setHandleMouseEvents(enable)
Sets whether the Zippy handles it's own mouse events.
Arguments:
enable : boolean
Whether the Zippy handles mouse events.
code »
toggle()
Toggles expanded state.
code »
updateHeaderClassName(expanded)
Updates the header element's className and ARIA (accessibility) EXPANDED state.
Arguments:
expanded : boolean
Expanded/visibility state.
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.Zippy
constructor :
No description.
Code »
DomHelper used to interact with the document, allowing components to be created in a different window.
Code »
elContent_ :
Content element.
Code »
elExpandedHeader_ :
When present, the header to use when the zippy is expanded.
Code »
elHeader_ :
Header element or null if no header exists.
Code »
expanded_ :
Expanded state.
Code »
handleKeyEvents_ :
Whether to listen for and handle key events; defaults to true.
Code »
handleMouseEvents_ :
Whether to listen for and handle mouse events; defaults to true.
Code »
keyboardEventHandler_ : goog.events.EventHandler
A keyboard events handler. If there are two headers it is shared for both.
Code »
mouseEventHandler_ : goog.events.EventHandler
A mouse events handler. If there are two headers it is shared for both.
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.Zippy.Events :
Constants for event names
Code »
goog.ui.Zippy.superClass_ :
No description.
Code »

Package ui

Package Reference