← Back to branch summary

~ci-train-bot/ubuntu-html5-theme/ubuntu-html5-theme-ubuntu-yakkety-landing-067

« back to all changes in this revision

Viewing changes to 0.1/ambiance/js/docsbuild/classes/UbuntuUI.Dialog.html

  • Committer: CI Train Bot
  • Author(s): Michael Hall, Alexandre Abreu
  • Date: 2015-04-09 14:26:31 UTC
  • mfrom: (200.2.3 ubuntu-html5-theme)
  • Revision ID: ci-train-bot@canonical.com-20150409142631-5axmx6p7x08ej1im
Add -doc package, whose contents have to be generated locally (use the ./update-docs command) because not all of its node dependencies are in the archive. This is done, so we can more easily update developer.ubuntu.com/api
Approved by: David Barth

Show diffs side-by-side

added added

removed removed

Lines of Context:
0.1/ambiance/js/docsbuild/classes/UbuntuUI.Dialog.html
 
1
<!DOCTYPE html>
 
2
<html lang="en">
 
3
<head>
 
4
    <meta charset="utf-8">
 
5
    <title>UbuntuUI.Dialog - Ubuntu HTML5 API</title>
 
6
    <link rel="stylesheet" href="http://yui.yahooapis.com/3.8.0pr2/build/cssgrids/cssgrids-min.css">
 
7
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
 
8
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
 
9
    <script src="http://yui.yahooapis.com/combo?3.8.0pr2/build/yui/yui-min.js"></script>
 
10
</head>
 
11
<body class="yui3-skin-sam">
 
12
 
 
13
<div id="doc">
 
14
    <div id="hd" class="yui3-g header">
 
15
        <div class="yui3-u-3-4">
 
16
            <h1><a href="../index.html"><img src="../assets/css/logo.png">Ubuntu HTML5 API: UbuntuUI.Dialog</a></h1>
 
17
        </div>
 
18
        <div class="yui3-u-1-4 version">
 
19
            <em>API Docs for: HTML-14.04-dev~bzr202</em>
 
20
        </div>
 
21
    </div>
 
22
    <div class="yui3-g">
 
23
 
 
24
        <div id="sidebar" class="yui3-u">
 
25
            <div id="modules" class="sidebox">
 
26
                <div class="hd">
 
27
                    <h2 class="no-toc">Modules</h2>
 
28
                </div>
 
29
                <div class="bd">
 
30
                    <ul>
 
31
                            <li><a href="../modules/UbuntuUI.html">UbuntuUI</a>
 
32
                            </li>
 
33
                    </ul>
 
34
                </div>
 
35
            </div>
 
36
            
 
37
            <div id="classes" class="sidebox">
 
38
                <div class="hd">
 
39
                    <h2 class="no-toc">Classes</h2>
 
40
                </div>
 
41
                <div class="bd">
 
42
                    <ul>
 
43
                            <li><a href="../classes/UbuntuUI.html">UbuntuUI</a></li>
 
44
                            <li><a href="../classes/UbuntuUI.Button.html">UbuntuUI.Button</a></li>
 
45
                            <li><a href="../classes/UbuntuUI.Dialog.html">UbuntuUI.Dialog</a></li>
 
46
                            <li><a href="../classes/UbuntuUI.Header.html">UbuntuUI.Header</a></li>
 
47
                            <li><a href="../classes/UbuntuUI.List.html">UbuntuUI.List</a></li>
 
48
                            <li><a href="../classes/UbuntuUI.OptionSelector.html">UbuntuUI.OptionSelector</a></li>
 
49
                            <li><a href="../classes/UbuntuUI.Page.html">UbuntuUI.Page</a></li>
 
50
                            <li><a href="../classes/UbuntuUI.Pagestack.html">UbuntuUI.Pagestack</a></li>
 
51
                            <li><a href="../classes/UbuntuUI.Popover.html">UbuntuUI.Popover</a></li>
 
52
                            <li><a href="../classes/UbuntuUI.Progress.html">UbuntuUI.Progress</a></li>
 
53
                            <li><a href="../classes/UbuntuUI.Shape.html">UbuntuUI.Shape</a></li>
 
54
                            <li><a href="../classes/UbuntuUI.Tab.html">UbuntuUI.Tab</a></li>
 
55
                            <li><a href="../classes/UbuntuUI.Tabs.html">UbuntuUI.Tabs</a></li>
 
56
                            <li><a href="../classes/UbuntuUI.Toolbar.html">UbuntuUI.Toolbar</a></li>
 
57
                    </ul>
 
58
                </div>
 
59
            </div>
 
60
            
 
61
            <div id="methods-on-page" class="sidebox on-page">
 
62
                <div class="hd">
 
63
                    <h2 class="no-toc">Methods On Page</h2>
 
64
                </div>
 
65
                <div class="bd">
 
66
                    <ul>
 
67
                            <li><a href="#methods_element">element</a></li>
 
68
                            <li><a href="#methods_hide">hide</a></li>
 
69
                            <li><a href="#methods_show">show</a></li>
 
70
                            <li><a href="#methods_toggle">toggle</a></li>
 
71
                    </ul>
 
72
                </div>
 
73
            </div>
 
74
            
 
75
            
 
76
            
 
77
            
 
78
            <div id="fileTree" class="sidebox">
 
79
                <div class="hd">
 
80
                    <h2 class="no-toc">Files</h2>
 
81
                </div>
 
82
                <div class="bd">
 
83
                    <ul><li>buttons.js/<ul></ul></li><li>core.js/<ul></ul></li><li>dialogs.js/<ul></ul></li><li>fast-buttons.js/<ul></ul></li><li>header.js/<ul></ul></li><li>list.js/<ul></ul></li><li>option-selector.js/<ul></ul></li><li>page.js/<ul></ul></li><li>pagestacks.js/<ul></ul></li><li>popovers.js/<ul></ul></li><li>progress.js/<ul></ul></li><li>shape.js/<ul></ul></li><li>tab.js/<ul></ul></li><li>tabs.js/<ul></ul></li><li>toolbars.js/<ul></ul></li></ul>
 
84
                </div>
 
85
            </div>
 
86
            
 
87
        </div>
 
88
 
 
89
        <div id="main" class="yui3-u">
 
90
            <div class="content"><h4>Class UbuntuUI.Dialog</h4>
 
91
<span class="foundat">Class defined in: <a href="../../files/dialogs.js.html#l23"><code>dialogs.js:23</code></a></span>
 
92
<div class="intro"><p>Dialogs are modal full-screen popups that prevent other GUI interactions with the application until dismissed.</p>
 
93
<p>Dialogs wrap arbitrary markup.</p>
 
94
<p>Dialogs are declared at the top level inside the &lt;em&gt;content&lt;/em&gt; div.</p>
 
95
</div>
 
96
 
 
97
    <a name="methods_UbuntuUI.Dialog"></a>
 
98
    <div class="method item">
 
99
         <strong class="name"><code>UbuntuUI.Dialog</code></strong>( <code>  </code> ) 
 
100
        <br>
 
101
        <span class="foundat">
 
102
            
 
103
            <a href="../../files/dialogs.js.html#l23"><code>dialogs.js:23</code></a>
 
104
        </span><br>
 
105
        
 
106
            <h5>Example</h5>
 
107
            <pre class="code prettyprint"><code> &lt;div data-role=&quot;content&quot;&gt;
 
108
       &lt;div data-role=&quot;pagestack&quot;&gt;
 
109
         [...]
 
110
       &lt;/div&gt;
 
111
       &lt;div data-role=&quot;dialog&quot; id=&quot;dialogID&quot;&gt;
 
112
         [...]
 
113
       &lt;/div&gt;
 
114
     &lt;/div&gt;
 
115
    
 
116
     JavaScript access:
 
117
     var dialog = UI.dialog(&quot;dialogID&quot;);
 
118
    </code></pre>
 
119
    
 
120
    </div>
 
121
 
 
122
<div id="classdocs">
 
123
    <ul>
 
124
        <li><a href="#methods">Methods</a></li>
 
125
    </ul>
 
126
    <div>
 
127
            <div id="methods">
 
128
                <a name="methods_element"></a>
 
129
                <div class="method item">
 
130
                    DOMElement <strong class="name"><code>element</code></strong>( <code>  </code> ) 
 
131
                    <br>
 
132
                    <span class="foundat">
 
133
                        
 
134
                        <a href="../../files/dialogs.js.html#l73"><code>dialogs.js:73</code></a>
 
135
                    </span><br>
 
136
                    <p>Returns the DOM element associated with the id this widget is bind to.</p>
 
137
                
 
138
                    <br><div class="returns"><strong>Returns:</strong> &lt;DOMElement&gt; </div>
 
139
                        <h5>Example</h5>
 
140
                        <pre class="code prettyprint"><code>   var mydialog = UI.dialog(&quot;dialogid&quot;).element();</code></pre>
 
141
                
 
142
                </div>
 
143
                <a name="methods_hide"></a>
 
144
                <div class="method item">
 
145
                     <strong class="name"><code>hide</code></strong>( <code>  </code> ) 
 
146
                    <br>
 
147
                    <span class="foundat">
 
148
                        
 
149
                        <a href="../../files/dialogs.js.html#l59"><code>dialogs.js:59</code></a>
 
150
                    </span><br>
 
151
                    <p>Hide a dialog by removing 'active' class</p>
 
152
                
 
153
                </div>
 
154
                <a name="methods_show"></a>
 
155
                <div class="method item">
 
156
                     <strong class="name"><code>show</code></strong>( <code>  </code> ) 
 
157
                    <br>
 
158
                    <span class="foundat">
 
159
                        
 
160
                        <a href="../../files/dialogs.js.html#l52"><code>dialogs.js:52</code></a>
 
161
                    </span><br>
 
162
                    <p>Display a dialog by adding 'active' CSS class</p>
 
163
                
 
164
                </div>
 
165
                <a name="methods_toggle"></a>
 
166
                <div class="method item">
 
167
                     <strong class="name"><code>toggle</code></strong>( <code>  </code> ) 
 
168
                    <br>
 
169
                    <span class="foundat">
 
170
                        
 
171
                        <a href="../../files/dialogs.js.html#l66"><code>dialogs.js:66</code></a>
 
172
                    </span><br>
 
173
                    <p>Toggle a dialog, which means removing its 'active' class if it has one, or adding the 'active' class if it does not have one</p>
 
174
                
 
175
                </div>
 
176
            </div>
 
177
    </div>
 
178
</div>
 
179
</div>
 
180
        </div>
 
181
    </div>
 
182
</div>
 
183
<script src="../assets/vendor/prettify/prettify-min.js"></script>
 
184
<script>prettyPrint();</script>
 
185
<script src="../assets/js/yui-prettify.js"></script>
 
186
<script src="../assets/js/tabs.js"></script>
 
187
</body>
 
188
</html>