goog.ui.ContainerScroller

Provided By	`goog.ui.ContainerScroller`
Extends	`goog.Disposable`
All Implemented Interfaces	`goog.disposable.IDisposable`

Plug-on scrolling behavior for a container.

Use this to style containers, such as pop-up menus, to be scrolling, and automatically keep the highlighted element visible.

To use this, first style your container with the desired overflow properties and height to achieve vertical scrolling. Also, the scrolling div should have no vertical padding, for two reasons: it is difficult to compensate for, and is generally not what you want due to the strange way CSS handles padding on the scrolling dimension.

The container must already be rendered before this may be constructed.

new ContainerScroller( `container` )

Parameters

`container`	`goog.ui.Container`
	The container to attach behavior to.

VIEW SOURCE

Instance Methods

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added. If a callback is added to an already disposed Disposable, it will be called immediately.

Defined by

goog.Disposable

Parameters

`callback`	`function(): ?`
	The callback function.
`opt_scope`	`(T\|null)=`
	An optional scope to call the callback in.

VIEW SOURCE

Disposes of the object and its resources.

Overrides

goog.Disposable

Specified by

goog.disposable.IDisposable

Parameters

None.

Returns

Nothing.

VIEW SOURCE

Performs appropriate cleanup. See description of goog.disposable.IDisposable for examples. 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');
   };