Debian Codegraph @

closure-library/closure/goog/ui/emoji/emojipaletterenderer.js

raw
1 // Copyright 2008 The Closure Library Authors. All Rights Reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS-IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 /**
16 * @fileoverview Emoji Palette renderer implementation.
17 *
18 */
19
20 goog.provide('goog.ui.emoji.EmojiPaletteRenderer');
21
22 goog.require('goog.a11y.aria');
23 goog.require('goog.asserts');
24 goog.require('goog.dom.NodeType');
25 goog.require('goog.dom.TagName');
26 goog.require('goog.dom.classlist');
27 goog.require('goog.style');
28 goog.require('goog.ui.PaletteRenderer');
29 goog.require('goog.ui.emoji.Emoji');
30
31
32
33 /**
34 * Renders an emoji palette.
35 *
36 * @param {?string} defaultImgUrl Url of the img that should be used to fill up
37 * the cells in the emoji table, to prevent jittering. Will be stretched
38 * to the emoji cell size. A good image is a transparent dot.
39 * @constructor
40 * @extends {goog.ui.PaletteRenderer}
41 */
42 goog.ui.emoji.EmojiPaletteRenderer = function(defaultImgUrl) {
43 goog.ui.PaletteRenderer.call(this);
44
45 this.defaultImgUrl_ = defaultImgUrl;
46 };
47 goog.inherits(goog.ui.emoji.EmojiPaletteRenderer, goog.ui.PaletteRenderer);
48
49
50 /**
51 * Globally unique ID sequence for cells rendered by this renderer class.
52 * @type {number}
53 * @private
54 */
55 goog.ui.emoji.EmojiPaletteRenderer.cellId_ = 0;
56
57
58 /**
59 * Url of the img that should be used for cells in the emoji palette that are
60 * not filled with emoji, i.e., after all the emoji have already been placed
61 * on a page.
62 *
63 * @type {?string}
64 * @private
65 */
66 goog.ui.emoji.EmojiPaletteRenderer.prototype.defaultImgUrl_ = null;
67
68
69 /** @override */
70 goog.ui.emoji.EmojiPaletteRenderer.getCssClass = function() {
71 return goog.getCssName('goog-ui-emojipalette');
72 };
73
74
75 /**
76 * Creates a palette item from the given emoji data.
77 *
78 * @param {goog.dom.DomHelper} dom DOM helper for constructing DOM elements.
79 * @param {string} id Goomoji id for the emoji.
80 * @param {goog.ui.emoji.SpriteInfo} spriteInfo Spriting info for the emoji.
81 * @param {string} displayUrl URL of the image served for this cell, whether
82 * an individual emoji image or a sprite.
83 * @return {!HTMLDivElement} The palette item for this emoji.
84 */
85 goog.ui.emoji.EmojiPaletteRenderer.prototype.createPaletteItem = function(
86 dom, id, spriteInfo, displayUrl) {
87 var el;
88
89 if (spriteInfo) {
90 var cssClass = spriteInfo.getCssClass();
91 if (cssClass) {
92 el = dom.createDom(goog.dom.TagName.DIV, cssClass);
93 } else {
94 el = this.buildElementFromSpriteMetadata(dom, spriteInfo, displayUrl);
95 }
96 } else {
97 el = dom.createDom(goog.dom.TagName.IMG, {'src': displayUrl});
98 }
99
100 var outerdiv = dom.createDom(
101 goog.dom.TagName.DIV, goog.getCssName('goog-palette-cell-wrapper'), el);
102 outerdiv.setAttribute(goog.ui.emoji.Emoji.ATTRIBUTE, id);
103 outerdiv.setAttribute(goog.ui.emoji.Emoji.DATA_ATTRIBUTE, id);
104 return /** @type {!HTMLDivElement} */ (outerdiv);
105 };
106
107
108 /**
109 * Modifies a palette item containing an animated emoji, in response to the
110 * animated emoji being successfully downloaded.
111 *
112 * @param {Element} item The palette item to update.
113 * @param {Image} animatedImg An Image object containing the animated emoji.
114 */
115 goog.ui.emoji.EmojiPaletteRenderer.prototype.updateAnimatedPaletteItem =
116 function(item, animatedImg) {
117 // An animated emoji is one that had sprite info for a static version and is
118 // now being updated. See createPaletteItem for the structure of the palette
119 // items we're modifying.
120
121 var inner = /** @type {Element} */ (item.firstChild);
122 goog.asserts.assert(inner);
123 // The first case is a palette item with a CSS class representing the sprite,
124 // and an animated emoji.
125 var classes = goog.dom.classlist.get(inner);
126 if (classes && classes.length == 1) {
127 inner.className = '';
128 }
129
130 goog.style.setStyle(inner, {
131 'width': animatedImg.width,
132 'height': animatedImg.height,
133 'background-image': 'url(' + animatedImg.src + ')',
134 'background-position': '0 0'
135 });
136 };
137
138
139 /**
140 * Builds the inner contents of a palette item out of sprite metadata.
141 *
142 * @param {goog.dom.DomHelper} dom DOM helper for constructing DOM elements.
143 * @param {goog.ui.emoji.SpriteInfo} spriteInfo The metadata to create the css
144 * for the sprite.
145 * @param {string} displayUrl The URL of the image for this cell.
146 * @return {HTMLDivElement} The inner element for a palette item.
147 */
148 goog.ui.emoji.EmojiPaletteRenderer.prototype.buildElementFromSpriteMetadata =
149 function(dom, spriteInfo, displayUrl) {
150 var width = spriteInfo.getWidthCssValue();
151 var height = spriteInfo.getHeightCssValue();
152 var x = spriteInfo.getXOffsetCssValue();
153 var y = spriteInfo.getYOffsetCssValue();
154
155 var el = dom.createDom(goog.dom.TagName.DIV);
156 goog.style.setStyle(el, {
157 'width': width,
158 'height': height,
159 'background-image': 'url(' + displayUrl + ')',
160 'background-repeat': 'no-repeat',
161 'background-position': x + ' ' + y
162 });
163
164 return /** @type {!HTMLDivElement} */ (el);
165 };
166
167
168 /** @override */
169 goog.ui.emoji.EmojiPaletteRenderer.prototype.createCell = function(node, dom) {
170 // Create a cell with the default img if we're out of items, in order to
171 // prevent jitter in the table. If there's no default img url, just create an
172 // empty div, to prevent trying to fetch a null url.
173 if (!node) {
174 var elem = this.defaultImgUrl_ ?
175 dom.createDom(goog.dom.TagName.IMG, {src: this.defaultImgUrl_}) :
176 dom.createDom(goog.dom.TagName.DIV);
177 node = dom.createDom(
178 goog.dom.TagName.DIV, goog.getCssName('goog-palette-cell-wrapper'),
179 elem);
180 }
181
182 var cell = dom.createDom(
183 goog.dom.TagName.TD, {
184 'class': goog.getCssName(this.getCssClass(), 'cell'),
185 // Cells must have an ID, for accessibility, so we generate one here.
186 'id': this.getCssClass() + '-cell-' +
187 goog.ui.emoji.EmojiPaletteRenderer.cellId_++
188 },
189 node);
190 goog.a11y.aria.setRole(cell, 'gridcell');
191 return cell;
192 };
193
194
195 /**
196 * Returns the item corresponding to the given node, or null if the node is
197 * neither a palette cell nor part of a palette item.
198 * @param {goog.ui.Palette} palette Palette in which to look for the item.
199 * @param {Node} node Node to look for.
200 * @return {Node} The corresponding palette item (null if not found).
201 * @override
202 */
203 goog.ui.emoji.EmojiPaletteRenderer.prototype.getContainingItem = function(
204 palette, node) {
205 var root = palette.getElement();
206 while (node && node.nodeType == goog.dom.NodeType.ELEMENT && node != root) {
207 if (node.tagName == goog.dom.TagName.TD) {
208 return node.firstChild;
209 }
210 node = node.parentNode;
211 }
212
213 return null;
214 };