| 1 |
<!DOCTYPE html> |
| 2 |
<html> |
| 3 |
<!-- |
| 4 |
Copyright 2010 The Closure Library Authors. All Rights Reserved. |
| 5 |
|
| 6 |
Use of this source code is governed by the Apache License, Version 2.0. |
| 7 |
See the COPYING file for details. |
| 8 |
--> |
| 9 |
<head> |
| 10 |
<title>goog.tweak.TweakUi</title> |
| 11 |
<script src="../base.js"></script> |
| 12 |
<script> |
| 13 |
goog.require('goog.tweak'); |
| 14 |
goog.require('goog.tweak.TweakUi'); |
| 15 |
</script> |
| 16 |
<link rel="stylesheet" type="text/css" href="../css/common.css"> |
| 17 |
</head> |
| 18 |
<body> |
| 19 |
<h1>goog.ui.TweakUi</h1> |
| 20 |
The goog.tweak package provides a convenient and flexible way to add |
| 21 |
configurable settings to an app. These settings: |
| 22 |
<ul> |
| 23 |
<li>can be set at compile time |
| 24 |
<li>can be set in code (using goog.tweak.overrideDefaultValue) |
| 25 |
<li>can be set by query parameters |
| 26 |
<li>can be set through the TweakUi interface |
| 27 |
</ul> |
| 28 |
Tweaks IDs are checked by the compiler and tweaks can be fully removed when |
| 29 |
tweakProcessing=STRIP. Tweaks are great for toggling debugging facilities. |
| 30 |
|
| 31 |
<h2>A collapsible menu</h2><div id="menu1"></div> |
| 32 |
<h2>An expanded menu</h2><div id="menu2"></div> |
| 33 |
<ul> |
| 34 |
<li>When "Apply Tweaks" is clicked, all non-default values are encoded into |
| 35 |
query parameters and the page is refreshed. |
| 36 |
<li>Blue entries are ones where the value of the tweak will change without |
| 37 |
clicking apply tweaks (the value of goog.tweak.get*() will change) |
| 38 |
</ul> |
| 39 |
<script> |
| 40 |
|
| 41 |
var entryCounter = 0; |
| 42 |
|
| 43 |
goog.tweak.registerButton('CreateNewTweak', 'Creates a new tweak. Meant ' + |
| 44 |
'to simulate a tweak being registered in a lazy-loaded module.', |
| 45 |
function() { |
| 46 |
var registry = goog.tweak.getRegistry(); |
| 47 |
entryCounter++; |
| 48 |
registry.register(new goog.tweak.BooleanSetting('Lazy' + entryCounter, |
| 49 |
'Lazy-loaded tweak ' + entryCounter)); |
| 50 |
}); |
| 51 |
|
| 52 |
goog.tweak.registerButton('CreateNewTweakInNamespace1', |
| 53 |
'Creates a new tweak within a namespace. Meant to simulate a tweak ' + |
| 54 |
'being registered in a lazy-loaded module.', function() { |
| 55 |
var registry = goog.tweak.getRegistry(); |
| 56 |
entryCounter++; |
| 57 |
registry.register(new goog.tweak.StringSetting( |
| 58 |
'namespace1.Lazy' + entryCounter, 'Lazy-loaded tweak ' + entryCounter)); |
| 59 |
}); |
| 60 |
|
| 61 |
goog.tweak.registerButton('CreateNewTweakInNamespace2', |
| 62 |
'Creates a new tweak within a namespace. Meant to simulate a tweak ' + |
| 63 |
'being registered in a lazy-loaded module.', function() { |
| 64 |
var registry = goog.tweak.getRegistry(); |
| 65 |
entryCounter++; |
| 66 |
var entry = new goog.tweak.NumericSetting( |
| 67 |
'namespace1.subnamespace.Lazy' + entryCounter, |
| 68 |
'Lazy-loaded tweak ' + entryCounter); |
| 69 |
entry.setValidValues([1, 2, 3]); |
| 70 |
entry.setDefaultValue((entryCounter % 3) + 1); |
| 71 |
registry.register(entry); |
| 72 |
}); |
| 73 |
|
| 74 |
goog.tweak.registerBoolean('Bool1', 'A boolean tweak that defaults to false'); |
| 75 |
goog.tweak.registerBoolean('Bool2', 'A boolean tweak that defaults to true', |
| 76 |
true); |
| 77 |
goog.tweak.registerString('Str1', 'A string tweak that defaults to false'); |
| 78 |
goog.tweak.registerString('Str2', 'A string tweak with a default value', |
| 79 |
'some value'); |
| 80 |
goog.tweak.registerString('Str3', 'A string tweak with validValues.', '', { |
| 81 |
validValues: ['A', 'B', 'C'] |
| 82 |
}); |
| 83 |
goog.tweak.registerNumber('Num1', 'A numeric tweak'); |
| 84 |
goog.tweak.registerNumber('Num2', 'A numeric tweak with default value', 10); |
| 85 |
goog.tweak.registerNumber('Num3', 'A numeric tweak with validValues.', 0, { |
| 86 |
validValues: [1, 2, 3] |
| 87 |
}); |
| 88 |
goog.tweak.beginBooleanGroup('BooleanGroup', 'A boolean group are boolean ' + |
| 89 |
'tweaks that share a query parameter.'); |
| 90 |
goog.tweak.registerBoolean('Value1', 'Example 1'); |
| 91 |
goog.tweak.registerBoolean('Value2', 'Example 2'); |
| 92 |
goog.tweak.registerBoolean('Value3', 'Example 3 (default on)', true); |
| 93 |
goog.tweak.endBooleanGroup(); |
| 94 |
goog.tweak.registerBoolean('Fancy1', 'A boolean tweak with a callback', false, { |
| 95 |
restartRequired: false, |
| 96 |
callback: function(entry) { |
| 97 |
alert('Tweak value is now ' + entry.getValue()); |
| 98 |
} |
| 99 |
}); |
| 100 |
goog.tweak.registerBoolean('Fancy2', 'A boolean tweak with a custom query ' + |
| 101 |
'parameter', false, { |
| 102 |
paramName: 'WowSoFancy' |
| 103 |
}); |
| 104 |
goog.tweak.registerBoolean('Fancy3', 'A boolean tweak with a custom label.', |
| 105 |
false, { |
| 106 |
label: 'Relabeled Tweak' |
| 107 |
}); |
| 108 |
goog.tweak.registerBoolean('namespace1.NamespacedTweak', |
| 109 |
'Tweaks are grouped by namespace'); |
| 110 |
goog.tweak.registerBoolean('namespace1.NamespacedTweak2', |
| 111 |
'Tweaks are grouped by namespace'); |
| 112 |
goog.tweak.registerBoolean('namespace1.NamespacedTweak3', |
| 113 |
'Tweaks are grouped by namespace'); |
| 114 |
|
| 115 |
document.getElementById('menu1').appendChild( |
| 116 |
goog.tweak.TweakUi.createCollapsible()); |
| 117 |
document.getElementById('menu2').appendChild(goog.tweak.TweakUi.create()); |
| 118 |
|
| 119 |
</script> |
| 120 |
</body> |
| 121 |
</html> |