typescript-closure-tools
Version:
Command-line tools to convert closure-style JSDoc annotations to typescript, and to convert typescript sources to closure externs files
148 lines (126 loc) • 6.33 kB
TypeScript
/// <reference path="../../../globals.d.ts" />
/// <reference path="./control.d.ts" />
/// <reference path="./paletterenderer.d.ts" />
/// <reference path="../dom/dom.d.ts" />
/// <reference path="../events/event.d.ts" />
/// <reference path="../math/size.d.ts" />
declare module goog.ui {
class Palette extends Palette__Class { }
/** Fake class which should be extended to avoid inheriting static properties */
class Palette__Class extends goog.ui.Control__Class {
/**
* A palette is a grid of DOM nodes that the user can highlight or select via
* the keyboard or the mouse. The selection state of the palette is controlled
* an ACTION event. Event listeners may retrieve the selected item using the
* {@link #getSelectedItem} or {@link #getSelectedIndex} method.
*
* Use this class as the base for components like color palettes or emoticon
* pickers. Use {@link #setContent} to set/change the items in the palette
* after construction. See palette.html demo for example usage.
*
* @param {Array.<Node>} items Array of DOM nodes to be displayed as items
* in the palette grid (limited to one per cell).
* @param {goog.ui.PaletteRenderer=} opt_renderer Renderer used to render or
* decorate the palette; defaults to {@link goog.ui.PaletteRenderer}.
* @param {goog.dom.DomHelper=} opt_domHelper Optional DOM helper, used for
* document interaction.
* @constructor
* @extends {goog.ui.Control}
*/
constructor(items: Node[], opt_renderer?: goog.ui.PaletteRenderer, opt_domHelper?: goog.dom.DomHelper);
/**
* Handles selection change events dispatched by the selection model.
* @param {goog.events.Event} e Selection event to handle.
*/
handleSelectionChange(e: goog.events.Event): void;
/**
* Returns the size of the palette grid.
* @return {goog.math.Size} Palette size (columns x rows).
*/
getSize(): goog.math.Size;
/**
* Sets the size of the palette grid to the given size. Callers can either
* pass a single {@link goog.math.Size} or a pair of numbers (first the number
* of columns, then the number of rows) to this method. In both cases, the
* number of rows is optional and will be calculated automatically if needed.
* It is an error to attempt to change the size of the palette after it has
* been rendered.
* @param {goog.math.Size|number} size Either a size object or the number of
* columns.
* @param {number=} opt_rows The number of rows (optional).
*/
setSize(size: goog.math.Size|number, opt_rows?: number): void;
/**
* Returns the 0-based index of the currently highlighted palette item, or -1
* if no item is highlighted.
* @return {number} Index of the highlighted item (-1 if none).
*/
getHighlightedIndex(): number;
/**
* Returns the currently highlighted palette item, or null if no item is
* highlighted.
* @return {Node} The highlighted item (undefined if none).
*/
getHighlightedItem(): Node;
/**
* Highlights the item at the given 0-based index, or removes the highlight
* if the argument is -1 or out of range. Any previously-highlighted item
* will be un-highlighted.
* @param {number} index 0-based index of the item to highlight.
*/
setHighlightedIndex(index: number): void;
/**
* Highlights the given item, or removes the highlight if the argument is null
* or invalid. Any previously-highlighted item will be un-highlighted.
* @param {Node|undefined} item Item to highlight.
*/
setHighlightedItem(item: Node|any /*undefined*/): void;
/**
* Returns the 0-based index of the currently selected palette item, or -1
* if no item is selected.
* @return {number} Index of the selected item (-1 if none).
*/
getSelectedIndex(): number;
/**
* Returns the currently selected palette item, or null if no item is selected.
* @return {Node} The selected item (null if none).
*/
getSelectedItem(): Node;
/**
* Selects the item at the given 0-based index, or clears the selection
* if the argument is -1 or out of range. Any previously-selected item
* will be deselected.
* @param {number} index 0-based index of the item to select.
*/
setSelectedIndex(index: number): void;
/**
* Selects the given item, or clears the selection if the argument is null or
* invalid. Any previously-selected item will be deselected.
* @param {Node} item Item to select.
*/
setSelectedItem(item: Node): void;
}
}
declare module goog.ui.Palette {
class CurrentCell_ extends CurrentCell___Class { }
/** Fake class which should be extended to avoid inheriting static properties */
class CurrentCell___Class extends goog.ui.Control__Class {
/**
* A component to represent the currently highlighted cell.
* @constructor
* @extends {goog.ui.Control}
* @private
*/
constructor();
/**
* @param {boolean} highlight Whether to highlight or unhighlight the component.
* @return {boolean} Whether it was successful.
*/
tryHighlight(highlight: boolean): boolean;
}
/**
* Events fired by the palette object
* @enum {string}
*/
enum EventType { AFTER_HIGHLIGHT }
}