Debian Codegraph @

closure-library/closure/goog/ui/imagelessbuttonrenderer.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/imagelessbutton.html
26 */
27
28 goog.provide('goog.ui.ImagelessButtonRenderer');
29
30 goog.require('goog.dom.TagName');
31 goog.require('goog.dom.classlist');
32 goog.require('goog.ui.Button');
33 goog.require('goog.ui.Component');
34 goog.require('goog.ui.CustomButtonRenderer');
35 goog.require('goog.ui.INLINE_BLOCK_CLASSNAME');
36 goog.require('goog.ui.registry');
37
38
39
40 /**
41 * Custom renderer for {@link goog.ui.Button}s. Imageless buttons can contain
42 * almost arbitrary HTML content, will flow like inline elements, but can be
43 * 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.CustomButtonRenderer}
49 */
50 goog.ui.ImagelessButtonRenderer = function() {
51 goog.ui.CustomButtonRenderer.call(this);
52 };
53 goog.inherits(goog.ui.ImagelessButtonRenderer, goog.ui.CustomButtonRenderer);
54 goog.addSingletonGetter(goog.ui.ImagelessButtonRenderer);
55
56
57 /**
58 * Default CSS class to be applied to the root element of components rendered
59 * by this renderer.
60 * @type {string}
61 */
62 goog.ui.ImagelessButtonRenderer.CSS_CLASS =
63 goog.getCssName('goog-imageless-button');
64
65
66 /**
67 * Returns the button's contents wrapped in the following DOM structure:
68 *
69 * <div class="goog-inline-block goog-imageless-button">
70 * <div class="goog-inline-block goog-imageless-button-outer-box">
71 * <div class="goog-imageless-button-inner-box">
72 * <div class="goog-imageless-button-pos-box">
73 * <div class="goog-imageless-button-top-shadow">&nbsp;</div>
74 * <div class="goog-imageless-button-content">Contents...</div>
75 * </div>
76 * </div>
77 * </div>
78 * </div>
79 * @override
80 */
81 goog.ui.ImagelessButtonRenderer.prototype.createDom;
82
83
84 /** @override */
85 goog.ui.ImagelessButtonRenderer.prototype.getContentElement = function(
86 element) {
87 return /** @type {Element} */ (
88 element && element.firstChild && element.firstChild.firstChild &&
89 element.firstChild.firstChild.firstChild.lastChild);
90 };
91
92
93 /**
94 * Takes a text caption or existing DOM structure, and returns the content
95 * wrapped in a pseudo-rounded-corner box. Creates the following DOM structure:
96 *
97 * <div class="goog-inline-block goog-imageless-button-outer-box">
98 * <div class="goog-inline-block goog-imageless-button-inner-box">
99 * <div class="goog-imageless-button-pos">
100 * <div class="goog-imageless-button-top-shadow">&nbsp;</div>
101 * <div class="goog-imageless-button-content">Contents...</div>
102 * </div>
103 * </div>
104 * </div>
105 *
106 * Used by both {@link #createDom} and {@link #decorate}. To be overridden
107 * by subclasses.
108 * @param {goog.ui.ControlContent} content Text caption or DOM structure to wrap
109 * in a box.
110 * @param {goog.dom.DomHelper} dom DOM helper, used for document interaction.
111 * @return {Element} Pseudo-rounded-corner box containing the content.
112 * @override
113 */
114 goog.ui.ImagelessButtonRenderer.prototype.createButton = function(
115 content, dom) {
116 var baseClass = this.getCssClass();
117 var inlineBlock = goog.ui.INLINE_BLOCK_CLASSNAME + ' ';
118 return dom.createDom(
119 goog.dom.TagName.DIV,
120 inlineBlock + goog.getCssName(baseClass, 'outer-box'),
121 dom.createDom(
122 goog.dom.TagName.DIV,
123 inlineBlock + goog.getCssName(baseClass, 'inner-box'),
124 dom.createDom(
125 goog.dom.TagName.DIV, goog.getCssName(baseClass, 'pos'),
126 dom.createDom(
127 goog.dom.TagName.DIV,
128 goog.getCssName(baseClass, 'top-shadow'), '\u00A0'),
129 dom.createDom(
130 goog.dom.TagName.DIV, goog.getCssName(baseClass, 'content'),
131 content))));
132 };
133
134
135 /**
136 * Check if the button's element has a box structure.
137 * @param {goog.ui.Button} button Button instance whose structure is being
138 * checked.
139 * @param {Element} element Element of the button.
140 * @return {boolean} Whether the element has a box structure.
141 * @protected
142 * @override
143 */
144 goog.ui.ImagelessButtonRenderer.prototype.hasBoxStructure = function(
145 button, element) {
146 var outer = button.getDomHelper().getFirstElementChild(element);
147 var outerClassName = goog.getCssName(this.getCssClass(), 'outer-box');
148 if (outer && goog.dom.classlist.contains(outer, outerClassName)) {
149 var inner = button.getDomHelper().getFirstElementChild(outer);
150 var innerClassName = goog.getCssName(this.getCssClass(), 'inner-box');
151 if (inner && goog.dom.classlist.contains(inner, innerClassName)) {
152 var pos = button.getDomHelper().getFirstElementChild(inner);
153 var posClassName = goog.getCssName(this.getCssClass(), 'pos');
154 if (pos && goog.dom.classlist.contains(pos, posClassName)) {
155 var shadow = button.getDomHelper().getFirstElementChild(pos);
156 var shadowClassName = goog.getCssName(this.getCssClass(), 'top-shadow');
157 if (shadow && goog.dom.classlist.contains(shadow, shadowClassName)) {
158 var content = button.getDomHelper().getNextElementSibling(shadow);
159 var contentClassName = goog.getCssName(this.getCssClass(), 'content');
160 if (content &&
161 goog.dom.classlist.contains(content, contentClassName)) {
162 // We have a proper box structure.
163 return true;
164 }
165 }
166 }
167 }
168 }
169 return false;
170 };
171
172
173 /**
174 * Returns the CSS class to be applied to the root element of components
175 * rendered using this renderer.
176 * @return {string} Renderer-specific CSS class.
177 * @override
178 */
179 goog.ui.ImagelessButtonRenderer.prototype.getCssClass = function() {
180 return goog.ui.ImagelessButtonRenderer.CSS_CLASS;
181 };
182
183
184 // Register a decorator factory function for goog.ui.ImagelessButtonRenderer.
185 goog.ui.registry.setDecoratorByClassName(
186 goog.ui.ImagelessButtonRenderer.CSS_CLASS, function() {
187 return new goog.ui.Button(
188 null, goog.ui.ImagelessButtonRenderer.getInstance());
189 });
190
191
192 // Register a decorator factory function for toggle buttons using the
193 // goog.ui.ImagelessButtonRenderer.
194 goog.ui.registry.setDecoratorByClassName(
195 goog.getCssName('goog-imageless-toggle-button'), function() {
196 var button = new goog.ui.Button(
197 null, goog.ui.ImagelessButtonRenderer.getInstance());
198 button.setSupportedState(goog.ui.Component.State.CHECKED, true);
199 return button;
200 });