Debian Codegraph @

closure-library/closure/goog/ui/imagelessmenubuttonrenderer.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 An alternative custom button renderer that uses even more CSS
17 * voodoo than the default implementation to render custom buttons with fake
18 * rounded corners and dimensionality (via a subtle flat shadow on the bottom
19 * half of the button) without the use of images.
20 *
21 * Based on the Custom Buttons 3.1 visual specification, see
22 * http://go/custombuttons
23 *
24 * @author [email protected] (Emil A Eklund)
25 * @see ../demos/imagelessmenubutton.html
26 */
27
28 goog.provide('goog.ui.ImagelessMenuButtonRenderer');
29
30 goog.require('goog.dom');
31 goog.require('goog.dom.TagName');
32 goog.require('goog.dom.classlist');
33 goog.require('goog.ui.INLINE_BLOCK_CLASSNAME');
34 goog.require('goog.ui.MenuButton');
35 goog.require('goog.ui.MenuButtonRenderer');
36 goog.require('goog.ui.registry');
37
38
39
40 /**
41 * Custom renderer for {@link goog.ui.MenuButton}s. Imageless buttons can
42 * contain almost arbitrary HTML content, will flow like inline elements, but
43 * can be styled like block-level elements.
44 *
45 * @deprecated These contain a lot of unnecessary DOM for modern user agents.
46 * Please use a simpler button renderer like css3buttonrenderer.
47 * @constructor
48 * @extends {goog.ui.MenuButtonRenderer}
49 * @final
50 */
51 goog.ui.ImagelessMenuButtonRenderer = function() {
52 goog.ui.MenuButtonRenderer.call(this);
53 };
54 goog.inherits(goog.ui.ImagelessMenuButtonRenderer, goog.ui.MenuButtonRenderer);
55 goog.addSingletonGetter(goog.ui.ImagelessMenuButtonRenderer);
56
57
58 /**
59 * Default CSS class to be applied to the root element of components rendered
60 * by this renderer.
61 * @type {string}
62 */
63 goog.ui.ImagelessMenuButtonRenderer.CSS_CLASS =
64 goog.getCssName('goog-imageless-button');
65
66
67 /** @override */
68 goog.ui.ImagelessMenuButtonRenderer.prototype.getContentElement = function(
69 element) {
70 if (element) {
71 var captionElem = goog.dom.getElementsByTagNameAndClass(
72 '*', goog.getCssName(this.getCssClass(), 'caption'), element)[0];
73 return captionElem;
74 }
75 return null;
76 };
77
78
79 /**
80 * Returns true if this renderer can decorate the element. Overrides
81 * {@link goog.ui.MenuButtonRenderer#canDecorate} by returning true if the
82 * element is a DIV, false otherwise.
83 * @param {Element} element Element to decorate.
84 * @return {boolean} Whether the renderer can decorate the element.
85 * @override
86 */
87 goog.ui.ImagelessMenuButtonRenderer.prototype.canDecorate = function(element) {
88 return element.tagName == goog.dom.TagName.DIV;
89 };
90
91
92 /**
93 * Takes a text caption or existing DOM structure, and returns the content
94 * wrapped in a pseudo-rounded-corner box. Creates the following DOM structure:
95 *
96 * <div class="goog-inline-block goog-imageless-button">
97 * <div class="goog-inline-block goog-imageless-button-outer-box">
98 * <div class="goog-imageless-button-inner-box">
99 * <div class="goog-imageless-button-pos-box">
100 * <div class="goog-imageless-button-top-shadow">&nbsp;</div>
101 * <div class="goog-imageless-button-content
102 * goog-imageless-menubutton-caption">Contents...
103 * </div>
104 * <div class="goog-imageless-menubutton-dropdown"></div>
105 * </div>
106 * </div>
107 * </div>
108 * </div>
109 *
110 * Used by both {@link #createDom} and {@link #decorate}. To be overridden
111 * by subclasses.
112 * @param {goog.ui.ControlContent} content Text caption or DOM structure to wrap
113 * in a box.
114 * @param {goog.dom.DomHelper} dom DOM helper, used for document interaction.
115 * @return {!Element} Pseudo-rounded-corner box containing the content.
116 * @override
117 */
118 goog.ui.ImagelessMenuButtonRenderer.prototype.createButton = function(
119 content, dom) {
120 var baseClass = this.getCssClass();
121 var inlineBlock = goog.ui.INLINE_BLOCK_CLASSNAME + ' ';
122 return dom.createDom(
123 goog.dom.TagName.DIV,
124 inlineBlock + goog.getCssName(baseClass, 'outer-box'),
125 dom.createDom(
126 goog.dom.TagName.DIV,
127 inlineBlock + goog.getCssName(baseClass, 'inner-box'),
128 dom.createDom(
129 goog.dom.TagName.DIV, goog.getCssName(baseClass, 'pos'),
130 dom.createDom(
131 goog.dom.TagName.DIV,
132 goog.getCssName(baseClass, 'top-shadow'), '\u00A0'),
133 dom.createDom(
134 goog.dom.TagName.DIV,
135 [
136 goog.getCssName(baseClass, 'content'),
137 goog.getCssName(baseClass, 'caption'),
138 goog.getCssName('goog-inline-block')
139 ],
140 content),
141 dom.createDom(goog.dom.TagName.DIV, [
142 goog.getCssName(baseClass, 'dropdown'),
143 goog.getCssName('goog-inline-block')
144 ]))));
145 };
146
147
148 /**
149 * Check if the button's element has a box structure.
150 * @param {goog.ui.Button} button Button instance whose structure is being
151 * checked.
152 * @param {Element} element Element of the button.
153 * @return {boolean} Whether the element has a box structure.
154 * @protected
155 * @override
156 */
157 goog.ui.ImagelessMenuButtonRenderer.prototype.hasBoxStructure = function(
158 button, element) {
159 var outer = button.getDomHelper().getFirstElementChild(element);
160 var outerClassName = goog.getCssName(this.getCssClass(), 'outer-box');
161 if (outer && goog.dom.classlist.contains(outer, outerClassName)) {
162 var inner = button.getDomHelper().getFirstElementChild(outer);
163 var innerClassName = goog.getCssName(this.getCssClass(), 'inner-box');
164 if (inner && goog.dom.classlist.contains(inner, innerClassName)) {
165 var pos = button.getDomHelper().getFirstElementChild(inner);
166 var posClassName = goog.getCssName(this.getCssClass(), 'pos');
167 if (pos && goog.dom.classlist.contains(pos, posClassName)) {
168 var shadow = button.getDomHelper().getFirstElementChild(pos);
169 var shadowClassName = goog.getCssName(this.getCssClass(), 'top-shadow');
170 if (shadow && goog.dom.classlist.contains(shadow, shadowClassName)) {
171 var content = button.getDomHelper().getNextElementSibling(shadow);
172 var contentClassName = goog.getCssName(this.getCssClass(), 'content');
173 if (content &&
174 goog.dom.classlist.contains(content, contentClassName)) {
175 // We have a proper box structure.
176 return true;
177 }
178 }
179 }
180 }
181 }
182 return false;
183 };
184
185
186 /**
187 * Returns the CSS class to be applied to the root element of components
188 * rendered using this renderer.
189 * @return {string} Renderer-specific CSS class.
190 * @override
191 */
192 goog.ui.ImagelessMenuButtonRenderer.prototype.getCssClass = function() {
193 return goog.ui.ImagelessMenuButtonRenderer.CSS_CLASS;
194 };
195
196
197 // Register a decorator factory function for
198 // goog.ui.ImagelessMenuButtonRenderer. Since we're using goog-imageless-button
199 // as the base class in order to get the same styling as
200 // goog.ui.ImagelessButtonRenderer, we need to be explicit about giving
201 // goog-imageless-menu-button here.
202 goog.ui.registry.setDecoratorByClassName(
203 goog.getCssName('goog-imageless-menu-button'), function() {
204 return new goog.ui.MenuButton(
205 null, null, goog.ui.ImagelessMenuButtonRenderer.getInstance());
206 });