typescript-closure-tools
Version:
Command-line tools to convert closure-style JSDoc annotations to typescript, and to convert typescript sources to closure externs files
91 lines (76 loc) • 3.63 kB
TypeScript
/// <reference path="../../../globals.d.ts" />
/// <reference path="./component.d.ts" />
/// <reference path="../dom/dom.d.ts" />
declare module goog.ui {
class ScrollFloater extends ScrollFloater__Class { }
/** Fake class which should be extended to avoid inheriting static properties */
class ScrollFloater__Class extends goog.ui.Component__Class {
/**
* Creates a ScrollFloater; see file overview for details.
*
* @param {Element=} opt_parentElement Where to attach the element when it's
* floating. Default is the document body. If the floating element
* contains form inputs, it will be necessary to attach it to the
* corresponding form element, or to an element in the DOM subtree under
* the form element.
* @param {goog.dom.DomHelper=} opt_domHelper Optional DOM helper.
* @constructor
* @extends {goog.ui.Component}
*/
constructor(opt_parentElement?: Element, opt_domHelper?: goog.dom.DomHelper);
/**
* Forces the component to update the cached element positions and sizes and
* to re-evaluate whether the the component should be docked, floated or
* pinned.
*/
update(): void;
/**
* Sets whether the element should be floated if it scrolls out of view.
* @param {boolean} enable Whether floating is enabled for this element.
*/
setScrollingEnabled(enable: boolean): void;
/**
* @return {boolean} Whether the component is enabled for scroll-floating.
*/
isScrollingEnabled(): boolean;
/**
* @return {boolean} Whether the component is currently scroll-floating.
*/
isFloating(): boolean;
/**
* @return {boolean} Whether the component is currently pinned to the bottom
* of the container.
*/
isPinned(): boolean;
/**
* @param {number} offset A vertical offset from the top of the viewport, from
* which to start floating the element. Default is 0. This is useful in cases
* when there are 'position:fixed' elements covering up part of the viewport.
*/
setViewportTopOffset(offset: number): void;
/**
* @param {Element} container An element used to define the boundaries within
* which the floater can be positioned. If not specified, scrolling the page
* down far enough may result in the floated element extending past the
* containing element as it is being scrolled out of the viewport. In some
* cases, such as a list with a sticky header, this may be undesirable. If
* the container element is specified and the floated element extends past
* the bottom of the container, the element will be pinned to the bottom of
* the container.
*/
setContainerElement(container: Element): void;
}
}
declare module goog.ui.ScrollFloater {
/**
* Events dispatched by this component.
* @enum {string}
*/
enum EventType { FLOAT, DOCK, PIN }
/**
* The element can float at different positions on the page.
* @enum {number}
* @private
*/
enum FloatMode_ { TOP, BOTTOM }
}