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
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: variable.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: variable.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/*************************************************************
*
* Copyright (c) 2015-2016 The MathJax Consortium
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @fileoverview Generic class for keeping menu variables together with callback
* functions to hook into third party libraries.
*
* @author volker.sorge@gmail.com (Volker Sorge)
*/
/// <reference path="variable_item.ts" />
var ContextMenu;
(function (ContextMenu) {
class Variable {
/**
* @constructor
* @template T
* @param {string} name The variable name.
* @param {T} value It's initial value.
* @param {function(T)} callback Function to call when value is changed.
*/
constructor(name, value, callback) {
this.name = '';
this.items = [];
this.name = name;
this.value = value;
this.callback = callback;
}
/**
* @return {string} The name of the variable.
*/
getName() {
return this.name;
}
;
/**
* @return {T} The value of the variable.
*/
getValue() {
return this.value;
}
;
//// TODO: Add accessors for callback.
// Possibly put in some messaging service for menu item selected.
/**
* Sets new variable value. If different from old one it will execute the
* callback.
* @param {T} value New value of the variable.
*/
setValue(value) {
if (value === this.value) {
return;
}
this.value = value;
try {
this.callback(value);
}
catch (e) {
ContextMenu.MenuUtil.error(e, 'Command of variable ' + this.name + ' failed.');
}
this.update();
}
/**
* Registers a new item that has this variable.
* @param {VariableItem} item The new variable item.
*/
register(item) {
if (this.items.indexOf(item) === -1) {
this.items.push(item);
}
}
/**
* Unregisters an item for this variable.
* @param {VariableItem} item The old variable item.
*/
unregister(item) {
let index = this.items.indexOf(item);
if (index !== -1) {
this.items.splice(index, 1);
}
}
/**
* Updates the items belonging to the variable.
*/
update() {
this.items.forEach(x => x.update());
}
/**
* Registers a callback function with all items associated to this variable.
* @param {Function} func Callback that does not take any arguments.
* @final
*/
registerCallback(func) {
this.items.forEach(x => x.registerCallback(func));
}
/**
* Removes a callback function from all items associated to this variable.
* @param {Function} func Callback that does not take any arguments.
* @final
*/
unregisterCallback(func) {
this.items.forEach(x => x.unregisterCallback(func));
}
}
ContextMenu.Variable = Variable;
})(ContextMenu || (ContextMenu = {}));
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AbstractEntry.html">AbstractEntry</a></li><li><a href="AbstractItem.html">AbstractItem</a></li><li><a href="AbstractMenu.html">AbstractMenu</a></li><li><a href="AbstractNavigatable.html">AbstractNavigatable</a></li><li><a href="AbstractPostable.html">AbstractPostable</a></li><li><a href="Checkbox.html">Checkbox</a></li><li><a href="CloseButton.html">CloseButton</a></li><li><a href="Command.html">Command</a></li><li><a href="ContextMenu.html">ContextMenu</a></li><li><a href="Info.html">Info</a></li><li><a href="Label.html">Label</a></li><li><a href="MenuElement.html">MenuElement</a></li><li><a href="MenuStore.html">MenuStore</a></li><li><a href="Popup.html">Popup</a></li><li><a href="Radio.html">Radio</a></li><li><a href="Rule.html">Rule</a></li><li><a href="SubMenu.html">SubMenu</a></li><li><a href="Submenu_.html">Submenu</a></li><li><a href="Variable.html">Variable</a></li><li><a href="VariablePool.html">VariablePool</a></li></ul><h3>Namespaces</h3><ul><li><a href="CssStyles.html">CssStyles</a></li><li><a href="MenuUtil.html">MenuUtil</a></li></ul><h3>Interfaces</h3><ul><li><a href="Element.html">Element</a></li><li><a href="Entry.html">Entry</a></li><li><a href="Item.html">Item</a></li><li><a href="KeyNavigatable.html">KeyNavigatable</a></li><li><a href="Menu.html">Menu</a></li><li><a href="MouseNavigatable.html">MouseNavigatable</a></li><li><a href="Postable.html">Postable</a></li><li><a href="TouchNavigatable.html">TouchNavigatable</a></li><li><a href="VariableItem.html">VariableItem</a></li></ul><h3>Global</h3><ul><li><a href="global.html#HtmlAttrs">HtmlAttrs</a></li><li><a href="global.html#HtmlClasses">HtmlClasses</a></li><li><a href="global.html#KEY">KEY</a></li><li><a href="global.html#MOUSE">MOUSE</a></li><li><a href="global.html#TOUCH">TOUCH</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Wed Aug 17 2016 12:38:38 GMT+0100 (BST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
|
