1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/*
Copyright (c) 2004-2011, The Dojo Foundation All Rights Reserved.
Available via Academic Free License >= 2.1 OR the modified BSD license.
see: http://dojotoolkit.org/license for details
*/
if(!dojo._hasResource["dojox.widget.UpgradeBar"]){ //_hasResource checks added by build. Do not use _hasResource directly in your code.
dojo._hasResource["dojox.widget.UpgradeBar"] = true;
dojo.provide("dojox.widget.UpgradeBar");
dojo.require("dojo.window");
dojo.require("dojo.fx");
dojo.require("dojo.cookie");
dojo.require("dijit._Widget");
dojo.require("dijit._Templated");
dojo.experimental("dojox.widget.UpgradeBar");
dojo.declare("dojox.widget.UpgradeBar", [dijit._Widget, dijit._Templated], {
// summary:
// Shows a bar at the top of the screen when the user is to
// be notified that they should upgrade their browser or a
// plugin.
//
// description:
// You can insert custom validations to trigger the UpgradeBar
// to display. An evaluation of 'true' shows the bar (as this
// version *is* less than it should be). Multiple validations
// may be checked, although only the first in the list will be
// displayed.
// Markup and programmatic are supported. Markup is a little
// cleaner, since a majority of the parameters are the HTML
// snippets to be displayed. In markup, the validate code should
// be an expression that will evaluate to true or false. This
// expression is wrapped in a try/catch, so if it blows up, it
// is assumed to be true and trigger the bar.
// In programmtic, a function should be used that returns true
// or false. You would need to use your own try/catch in that.
//
// example: See tests for examples.
//
// notifications: Array
// An array of objects that hold the criteria for upgrades.
// message: String
// The message to display in the bar. Can be HTML.
// validate:Function
// The expression to evaluate to determine if the
// bar should show or not. Should be a simple expression
// if used in HTML:
// | <div validate="!google.gears">
// | <div validate="dojo.isIE<8">
notifications:[],
//
// buttonCancel:String
// The HTML tip show when hovering over the close button.
buttonCancel:"Close for now",
//
// noRemindButton:String
// The text link shown that when clicked, permanently dismisses
// the message (sets a cookie). If this string is blank, this
// link is not displayed.
noRemindButton:"Don't Remind Me Again",
templateString: dojo.cache("dojox.widget", "UpgradeBar/UpgradeBar.html", "<div class=\"dojoxUpgradeBar\">\r\n\t<div class=\"dojoxUpgradeBarMessage\" dojoAttachPoint=\"messageNode\">message</div>\r\n\t<div class=\"dojoxUpgradeBarReminderButton\" dojoAttachPoint=\"dontRemindButtonNode\" dojoAttachEvent=\"onclick:_onDontRemindClick\">${noRemindButton}</div>\r\n\t<span dojoAttachPoint=\"closeButtonNode\" class=\"dojoxUpgradeBarCloseIcon\" dojoAttachEvent=\"onclick: hide, onmouseenter: _onCloseEnter, onmouseleave: _onCloseLeave\" title=\"${buttonCancel}\"></span>\r\n</div>\r\n"),
constructor: function(props, node){
if(!props.notifications && node){
// From markup. Create the notifications Array from the
// srcRefNode children.
dojo.forEach(node.childNodes, function(n){
if(n.nodeType==1){
var val = dojo.attr(n, "validate");
this.notifications.push({
message:n.innerHTML,
validate:function(){
// the function that fires to determine if the
// bar shows or not.
var evals = true;
try{
evals = dojo.eval(val);
}catch(e){ /* squelch. it's true.*/ }
return evals;
}
});
}
}, this);
}
},
checkNotifications: function(){
// summary:
// Internal. Go through the notifications Array
// and check for any that evaluate to true.
// tags:
// private
//
if(!this.notifications.length){
// odd. why use the bar but not set any notifications?
return;
}
for(var i=0;i<this.notifications.length;i++){
var evals = this.notifications[i].validate();
if(evals){
this.notify(this.notifications[i].message);
// Validation resulted in true, meaning a feature is missing
// Don't check any other messages. One at a time.
break;
}
}
},
postCreate: function(){
this.inherited(arguments);
if(this.domNode.parentNode){
dojo.style(this.domNode, "display", "none");
}
dojo.mixin(this.attributeMap, {
message:{ node:"messageNode", type:"innerHTML" }
});
if(!this.noRemindButton){
dojo.destroy(this.dontRemindButtonNode)
}
if(dojo.isIE==6){
// IE6 is challenged when it comes to 100% width.
// It thinks the body has more padding and more
// margin than it really does. It would work to
// set the body pad and margin to 0, but we can't
// set that and disturb a potential layout.
//
var self = this;
var setWidth = function(){
var v = dojo.window.getBox();
dojo.style(self.domNode, "width", v.w+"px");
}
this.connect(window, "resize", function(){
setWidth();
});
setWidth();
}
dojo.addOnLoad(this, "checkNotifications");
//this.checkNotifications();
},
notify: function(msg){
// summary:
// Triggers the bar to display. An internal function,
// but could ne called externally for fun.
// tags:
// protected
//
if(dojo.cookie("disableUpgradeReminders")){
return;
}
if(!this.domNode.parentNode || !this.domNode.parentNode.innerHTML){
document.body.appendChild(this.domNode);
}
dojo.style(this.domNode, "display", "");
if(msg){
this.set("message", msg);
}
},
show: function(){
// summary:
// Internal. Shows the bar. Do not call directly.
// Use notify();
// tags:
// private
//
this._bodyMarginTop = dojo.style(dojo.body(), "marginTop");
this._size = dojo.contentBox(this.domNode).h;
dojo.style(this.domNode, { display:"block", height:0, opacity:0 });
if(!this._showAnim){
this._showAnim = dojo.fx.combine([
dojo.animateProperty({ node:dojo.body(), duration:500, properties:{ marginTop:this._bodyMarginTop+this._size } }),
dojo.animateProperty({ node:this.domNode, duration:500, properties:{ height:this._size, opacity:1 } })
]);
}
this._showAnim.play();
},
hide: function(){
// summary:
// Hides the bar. May be called externally.
//
if(!this._hideAnim){
this._hideAnim = dojo.fx.combine([
dojo.animateProperty({ node:dojo.body(), duration:500, properties:{ marginTop:this._bodyMarginTop } }),
dojo.animateProperty({ node:this.domNode, duration:500, properties:{ height:0, opacity:0 } })
]);
dojo.connect(this._hideAnim, "onEnd", this, function(){
dojo.style(this.domNode, "display", "none");
});
}
this._hideAnim.play();
},
_onDontRemindClick: function(){
// summary:
// Called when user clicks the "do not remind" link.
// tags:
// private
dojo.cookie("disableUpgradeReminders", true, { expires:3650 });
this.hide();
},
_onCloseEnter: function(){
// summary:
// Called when user hovers over close icon
// tags:
// private
dojo.addClass(this.closeButtonNode, "dojoxUpgradeBarCloseIcon-hover");
},
_onCloseLeave: function(){
// summary:
// Called when user stops hovering over close icon
// tags:
// private
dojo.removeClass(this.closeButtonNode, "dojoxUpgradeBarCloseIcon-hover");
}
});
}
|
