src/cm/media/js/lib/yui/yui_3.10.3/docs/dial/index.html
author Yves-Marie Haussonne <ymh.work+github@gmail.com>
Fri, 09 May 2014 18:35:26 +0200
changeset 656 a84519031134
parent 525 89ef5ed3c48b
permissions -rw-r--r--
add link to "privacy policy" in the header test
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
525
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     1
<!DOCTYPE html>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     2
<html lang="en">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     3
<head>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     4
    <meta charset="utf-8">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     5
    <title>Dial</title>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     6
    <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=PT+Sans:400,700,400italic,700italic">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     7
    <link rel="stylesheet" href="../../build/cssgrids/cssgrids-min.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     8
    <link rel="stylesheet" href="../assets/css/main.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
     9
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    10
    <link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    11
    <script src="../../build/yui/yui-min.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    12
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    13
</head>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    14
<body>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    15
<!--
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    16
<a href="https://github.com/yui/yui3"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    17
-->
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    18
<div id="doc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    19
    <div id="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    20
        <h1><img src="http://yuilibrary.com/img/yui-logo.png"></h1>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    21
    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    22
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    23
        <a href="#toc" class="jump">Jump to Table of Contents</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    24
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    25
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    26
            <h1>Dial</h1>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    27
    <div class="yui3-g">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    28
        <div class="yui3-u-3-4">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    29
            <div id="main">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    30
                <div class="content"><div class="intro" style="min-height:181px;">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    31
    <p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    32
        <img src="../assets/dial/images/dial_drag.png" alt="Screenshot of the Dial widget" style="border: 1px solid #bfbfbf; float:right; height:146px; margin: 0 0 8px 8px; width:154px;">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    33
        The Dial widget is a circular value input control. It's like a real-world, analog volume control dial, but with much finer UI control. 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    34
        Have you ever needed a slider with a 2000 unit range, wanted 1 unit accuracy, but didn't have 2000 pixels of real estate for a slider?
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    35
        The Dial widget is made for cases like this. 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    36
    </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    37
    <p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    38
        The user sets the value of the dial by dragging its handle or clicking on the ring.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    39
    </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    40
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    41
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    42
<h2 id="getting-started">Getting Started</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    43
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    44
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    45
To include the source files for Dial and its dependencies, first load
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    46
the YUI seed file if you haven't already loaded it.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    47
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    48
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    49
<pre class="code prettyprint">&lt;script src=&quot;http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.10.3&#x2F;build&#x2F;yui&#x2F;yui-min.js&quot;&gt;&lt;&#x2F;script&gt;</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    50
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    51
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    52
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    53
Next, create a new YUI instance for your application and populate it with the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    54
modules you need by specifying them as arguments to the <code>YUI().use()</code> method.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    55
YUI will automatically load any dependencies required by the modules you
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    56
specify.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    57
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    58
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    59
<pre class="code prettyprint">&lt;script&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    60
&#x2F;&#x2F; Create a new YUI instance and populate it with the required modules.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    61
YUI().use(&#x27;dial&#x27;, function (Y) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    62
    &#x2F;&#x2F; Dial is available and ready for use. Add implementation
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    63
    &#x2F;&#x2F; code here.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    64
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    65
&lt;&#x2F;script&gt;</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    66
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    67
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    68
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    69
For more information on creating YUI instances and on the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    70
<a href="http://yuilibrary.com/yui/docs/api/classes/YUI.html#method_use"><code>use()</code> method</a>, see the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    71
documentation for the <a href="../yui/index.html">YUI Global Object</a>.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    72
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    73
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    74
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    75
<h2 id="using-the-dial-widget">Using the Dial Widget</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    76
<h3 id="anatomy-of-a-dial">Anatomy of a Dial</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    77
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    78
<h4 id="dom-structure">Dom Structure</h4>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    79
    <p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    80
        The major parts of the Dial are:
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    81
        <ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    82
            <li>Ring</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    83
            <li>Marker</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    84
            <li>User-draggable handle</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    85
            <li>Reset button</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    86
        </ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    87
        The ring is the background element and container of the other elements. 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    88
        The marker is always displayed at a fixed but configurable distance from the dial center. 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    89
        Its position around the dial indicates the current value as the user drags the handle or clicks 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    90
        on the ring to adjust the value.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    91
        When not being dragged, the handle occupies the same space as the marker, and the marker is not displayed.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    92
        When the keyboard is used for input, the marker is not displayed. 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    93
        The reset button restores the dial to the initial configuration value.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    94
    </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    95
    <p>A label string and a value string are dislayed above the dial.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    96
    </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    97
    <p>Like other form controls, Dials are inline elements.</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    98
    <img src="../assets/dial/images/dial_anatomy.png" alt="illustration of the parts of a Dial">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
    99
    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   100
<h3 id="markup-structure">Markup Structure</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   101
    <p>The final rendered Dial has the markup structure shown below:</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   102
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   103
<pre class="code prettyprint">&lt;div id=&quot;demo&quot;&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   104
    &lt;div class=&quot;yui3-widget yui3-dial&quot;&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   105
        &lt;div class=&quot;yui3-dial-content&quot;&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   106
            &lt;div class=&quot;yui3-dial-label&quot; id=&quot;[custom YUI gen id for screen reader]&quot;&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   107
                &lt;span class=&quot;yui3-dial-label-string&quot;&gt;My label&lt;&#x2F;span&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   108
                &lt;span class=&quot;yui3-dial-value-string&quot;&gt;30&lt;&#x2F;span&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   109
            &lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   110
            &lt;div class=&quot;yui3-dial-ring&quot;&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   111
                &lt;div class=&quot;yui3-dial-north-mark&quot;&gt;&lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   112
                &lt;div class=&quot;yui3-dial-marker yui3-dial-marker-hidden&quot;&gt;&lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   113
                &lt;div class=&quot;yui3-dial-center-button&quot;&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   114
                    &lt;div class=&quot;yui3-dial-reset-str&quot;&gt;&lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   115
                &lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   116
                &lt;div class=&quot;yui3-dial-handle yui3-dd-draggable&quot; title=&quot;Drag to set value&quot; tabindex=&quot;0&quot; role=&quot;slider&quot; aria-valuenow=&quot;30&quot; aria-valuemin=&quot;-220&quot; aria-valuemax=&quot;220&quot; aria-valuetext=&quot;30&quot; aria-labelledby=&quot;[custom YUI gen id for screen reader]&quot;&gt;&lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   117
            &lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   118
        &lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   119
    &lt;&#x2F;div&gt;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   120
&lt;&#x2F;div&gt;</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   121
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   122
<h3 id="instantiating-the-dial">Instantiating the Dial</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   123
<p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   124
<strong>Note:</strong> be sure to add the <code>yui3-skin-sam</code> classname to the
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   125
page's <code>&lt;body&gt;</code> element or to a parent element of the widget in order to apply
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   126
the default CSS skin. See <a href="http://yuilibrary.com/yui/docs/tutorials/skins/">Understanding Skinning</a>.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   127
</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   128
<pre class="code prettyprint">&lt;body class=&quot;yui3-skin-sam&quot;&gt; &lt;!-- You need this skin class --&gt;</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   129
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   130
    <p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   131
        The only markup required to instantiate a <code>Dial</code> is an HTML tag into which the widget will be rendered.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   132
    </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   133
<pre class="code prettyprint">&lt;div id=&quot;demo&quot;&gt;&lt;&#x2F;div&gt;</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   134
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   135
    <p><code>Dial</code> extends the <code>Widget</code> class, following the same pattern 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   136
    as any widget constructor, accepting a configuration object to 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   137
    set the initial configuration for the widget.</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   138
    <p>Some commonly used configuration attributes are shown below.</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   139
<pre class="code prettyprint">YUI().use(&#x27;dial&#x27;, function(Y) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   140
    var dial = new Y.Dial({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   141
        min:-220,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   142
        max:220,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   143
        stepsPerRevolution:100,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   144
        value: 30,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   145
    });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   146
});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   147
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   148
    <p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   149
    After creating and configuring the new <code>Dial</code>, 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   150
    Call the <code>render</code> method on your <code>Dial</code> object, passing it
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   151
    the <code>selector</code> of a container object. 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   152
    This renders it in the container and makes it usable.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   153
    </p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   154
<pre class="code prettyprint">var dial = new Y.Dial();
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   155
dial.render(&quot;#demo&quot;);</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   156
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   157
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   158
<h4 id="attributes">Attributes</h4>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   159
    <p>The following configuration attributes are provided to define default values for each Dial widget:</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   160
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   161
<table>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   162
    <thead>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   163
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   164
            <th>Attribute</th>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   165
            <th>Description</th>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   166
            <th>Default</th>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   167
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   168
    </thead>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   169
    <tbody>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   170
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   171
            <td><code>min</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   172
            <td>Minimum input value allowed</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   173
            <td><code>-220</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   174
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   175
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   176
            <td><code>max</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   177
            <td>Maximum input value allowed</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   178
            <td><code>220</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   179
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   180
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   181
            <td><code>diameter</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   182
            <td>Diameter of the dial control in pixels</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   183
            <td><code>100</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   184
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   185
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   186
            <td><code>centerButtonDiameter</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   187
            <td>The diameter of the center button. This value is a percentage of the diameter of the Dial widget.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   188
            <td><code>0.5</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   189
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   190
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   191
            <td><code>markerDiameter</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   192
            <td>The diameter of the marker that follows the angle of the handle as it is dragged. This value is a percentage of the diameter of the Dial widget.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   193
            <td><code>0.1</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   194
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   195
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   196
            <td><code>handleDiameter</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   197
            <td>The diameter of the handle that sets the Dial value. This value is a percentage of the diameter of the Dial widget.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   198
            <td><code>0.2</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   199
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   200
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   201
            <td><code>value</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   202
            <td>The initial value which will set the UI display</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   203
            <td><code>0</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   204
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   205
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   206
            <td><code>minorStep</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   207
            <td>Value is incremented/decremented by this value on arrow key press.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   208
            <td><code>1</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   209
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   210
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   211
            <td><code>majorStep</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   212
            <td>Value is incremented/decremented by this value on page up/down key press.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   213
            <td><code>10</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   214
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   215
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   216
            <td><code>stepsPerRevolution</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   217
            <td>One revolution of the dial adds/subtracts this many value units.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   218
            <td><code>100</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   219
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   220
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   221
            <td><code>decimalPlaces</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   222
            <td>Number of digits to the right of decimal point to retain in the value.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   223
            <td><code>0</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   224
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   225
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   226
            <td><code>strings</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   227
            <td>Display text strings are isolated in object literals and are handled through YUI's Internationalization utility.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   228
                See the examples for ways to replace these strings.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   229
            </td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   230
            <td><code>{label:&#x27;My label&#x27;, resetStr:&#x27;Reset&#x27;, tooltipHandle:&#x27;Drag to set value&#x27;}</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   231
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   232
        <tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   233
            <td><code>handleDistance</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   234
            <td>This is the distance from the center of the dial to the center of the marker and handle when at rest. This value is a percentage of the radius of the Dial widget.</td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   235
            <td><code>0.75</code></td>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   236
        </tr>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   237
    </tbody>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   238
</table>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   239
<h4 id="setting-and-constraining-the-dial-value">Setting and Constraining the Dial Value</h4>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   240
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   241
<h5 id="setting-and-getting-dial-values">Setting and Getting Dial Values</h5>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   242
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   243
<p>Like any input element, the most important thing about a Dial is its <code>value</code>.  
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   244
<code>value</code> is managed as an attribute.</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   245
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   246
<pre class="code prettyprint">&#x2F;&#x2F; Specify value at construction
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   247
var dial = new Y.Dial({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   248
    value  : 50
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   249
});
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   250
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   251
&#x2F;&#x2F; Get and set the value as an attribute
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   252
var val = dial.get(&#x27;value&#x27;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   253
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   254
dial.set(&#x27;value&#x27;,val + 10);</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   255
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   256
<h5 id="constraining-dial-values">Constraining Dial Values</h5>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   257
<p>A Dial's <code>value</code> is constrained between the configured <code>min</code> and <code>max</code> attribute values.  
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   258
Values outside this range are treated as the closer of <code>min</code> or <code>max</code>.</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   259
 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   260
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   261
<p>Configuring values for <code>max</code> and <code>min</code> that are respectively larger or smaller than the configured
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   262
<code>stepsPerRevolution</code> or <code>-stepsPerRevolution</code> can be used to configure a Dial to allow the user to drag the handle more than 360&#176.
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   263
By this means, a <code>Dial</code> can be configured to "go around and around," allowing a very large range of values.</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   264
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   265
<pre class="code prettyprint">YUI().use(&quot;dial&quot;, function(Y) {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   266
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   267
    var dial = new Y.Dial({
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   268
        min:-520,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   269
        max:720,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   270
        stepsPerRevolution:100,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   271
        value: 30,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   272
    });
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   273
    dial.render(&quot;#demo&quot;);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   274
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   275
});</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   276
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   277
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   278
<h5 id="sync-the-ui-if-the-dial-was-rendered-off-the-dom">Sync the UI If the Dial Was Rendered off the DOM</h5>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   279
    <p>If a Dial is rendered off the DOM, you must call the Dial's <code>syncUI()</code> method after attaching it to the DOM 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   280
    in order for the handle to be placed correctly.  
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   281
    When off DOM, the dimensional information necessary to place the handle is unavailable.</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   282
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   283
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   284
<h3 id="css">CSS</h3>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   285
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   286
    <p>The core structural CSS for the Dial is shown below. Widths and heights of elements 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   287
    are computed based on the "diameter" configuration property.</p>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   288
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   289
<pre class="code prettyprint">&#x2F;* VML implementation for IE *&#x2F;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   290
v\:oval,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   291
v\:shadow,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   292
v\:fill {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   293
    behavior: url(#default#VML);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   294
    display: inline-block;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   295
    zoom: 1; *display: inline; &#x2F;* IE &lt; 8: fake inline-block *&#x2F;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   296
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   297
.yui3-dial{
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   298
    position:relative;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   299
    display:-moz-inline-stack;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   300
    display:inline-block;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   301
    zoom:1;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   302
    *display:inline;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   303
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   304
.yui3-dial-content,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   305
.yui3-dial-ring{
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   306
    position:relative;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   307
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   308
.yui3-dial-handle,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   309
.yui3-dial-marker,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   310
.yui3-dial-center-button,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   311
.yui3-dial-reset-string,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   312
.yui3-dial-handle-vml,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   313
.yui3-dial-marker-vml,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   314
.yui3-dial-center-button-vml,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   315
.yui3-dial-ring-vml v\:oval,
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   316
.yui3-dial-center-button-vml v\:oval
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   317
{
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   318
    position:absolute;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   319
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   320
.yui3-dial-center-button-vml v\:oval {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   321
    font-size:1px;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   322
    top:0;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   323
    left:0;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   324
}
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   325
.yui3-skin-sam .yui3-dial-hidden {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   326
    opacity:0;
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   327
    filter:alpha(opacity=0);
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   328
}</pre>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   329
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   330
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   331
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   332
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   333
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   334
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   335
            </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   336
        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   337
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   338
        <div class="yui3-u-1-4">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   339
            <div class="sidebar">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   340
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   341
                    <div id="toc" class="sidebox">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   342
                        <div class="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   343
                            <h2 class="no-toc">Table of Contents</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   344
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   345
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   346
                        <div class="bd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   347
                            <ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   348
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   349
<a href="#getting-started">Getting Started</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   350
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   351
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   352
<a href="#using-the-dial-widget">Using the Dial Widget</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   353
<ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   354
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   355
<a href="#anatomy-of-a-dial">Anatomy of a Dial</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   356
<ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   357
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   358
<a href="#dom-structure">Dom Structure</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   359
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   360
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   361
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   362
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   363
<a href="#markup-structure">Markup Structure</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   364
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   365
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   366
<a href="#instantiating-the-dial">Instantiating the Dial</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   367
<ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   368
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   369
<a href="#attributes">Attributes</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   370
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   371
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   372
<a href="#setting-and-constraining-the-dial-value">Setting and Constraining the Dial Value</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   373
<ul class="toc">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   374
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   375
<a href="#setting-and-getting-dial-values">Setting and Getting Dial Values</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   376
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   377
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   378
<a href="#constraining-dial-values">Constraining Dial Values</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   379
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   380
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   381
<a href="#sync-the-ui-if-the-dial-was-rendered-off-the-dom">Sync the UI If the Dial Was Rendered off the DOM</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   382
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   383
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   384
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   385
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   386
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   387
<li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   388
<a href="#css">CSS</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   389
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   390
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   391
</li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   392
</ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   393
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   394
                    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   395
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   396
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   397
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   398
                    <div class="sidebox">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   399
                        <div class="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   400
                            <h2 class="no-toc">Examples</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   401
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   402
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   403
                        <div class="bd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   404
                            <ul class="examples">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   405
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   406
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   407
                                        <li data-description="Create a Dial from existing markup on the page - a simple use case.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   408
                                            <a href="dial-basic.html">Basic Dial</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   409
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   410
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   411
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   412
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   413
                                        <li data-description="Link a Dial with a text input field.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   414
                                            <a href="dial-text-input.html">Dial Linked With Text Input</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   415
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   416
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   417
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   418
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   419
                                        <li data-description="Use image backgrounds to control the visual display of a Dial.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   420
                                            <a href="dial-image-background.html">Dial With Image Background</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   421
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   422
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   423
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   424
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   425
                                        <li data-description="Use images to surround a Dial instance and provide additional styling.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   426
                                            <a href="dial-image-surrounding.html">Dial With a Surrounding Image</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   427
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   428
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   429
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   430
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   431
                                        <li data-description="This example employs Dial to drive an interactive UI.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   432
                                            <a href="dial-interactive.html">Dial With Interactive UI</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   433
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   434
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   435
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   436
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   437
                                        <li data-description="This example shows how to use Dial to animate an image sprite.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   438
                                            <a href="duck.html">Image Sprite Animation with Dial</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   439
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   440
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   441
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   442
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   443
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   444
                            </ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   445
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   446
                    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   447
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   448
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   449
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   450
                    <div class="sidebox">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   451
                        <div class="hd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   452
                            <h2 class="no-toc">Examples That Use This Component</h2>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   453
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   454
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   455
                        <div class="bd">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   456
                            <ul class="examples">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   457
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   458
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   459
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   460
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   461
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   462
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   463
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   464
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   465
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   466
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   467
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   468
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   469
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   470
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   471
                                        <li data-description="Use the HSL color picker to select a new color. Then chose the color type you like best.">
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   472
                                            <a href="../color/hsl-picker.html">HSL Color Picker</a>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   473
                                        </li>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   474
                                    
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   475
                                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   476
                            </ul>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   477
                        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   478
                    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   479
                
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   480
            </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   481
        </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   482
    </div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   483
</div>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   484
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   485
<script src="../assets/vendor/prettify/prettify-min.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   486
<script>prettyPrint();</script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   487
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   488
<script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   489
YUI.Env.Tests = {
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   490
    examples: [],
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   491
    project: '../assets',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   492
    assets: '../assets/dial',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   493
    name: 'dial',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   494
    title: 'Dial',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   495
    newWindow: '',
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   496
    auto:  false 
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   497
};
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   498
YUI.Env.Tests.examples.push('dial-basic');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   499
YUI.Env.Tests.examples.push('dial-text-input');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   500
YUI.Env.Tests.examples.push('dial-image-background');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   501
YUI.Env.Tests.examples.push('dial-image-surrounding');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   502
YUI.Env.Tests.examples.push('dial-interactive');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   503
YUI.Env.Tests.examples.push('duck');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   504
YUI.Env.Tests.examples.push('hsl-picker');
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   505
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   506
</script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   507
<script src="../assets/yui/test-runner.js"></script>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   508
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   509
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   510
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   511
</body>
89ef5ed3c48b Upgrades to yui 3.10.3
gibus
parents:
diff changeset
   512
</html>