provide installation instructions
[extjs.git] / docs / output / Ext.air.Clipboard.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.air.Clipboard-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.air.Clipboard-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.air.Clipboard-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                         <a class="bookmark" href="../docs/?class=Ext.air.Clipboard"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
7         </div>
8                 <h1>Class Ext.air.Clipboard</h1>
9         <table cellspacing="0">
10             <tr><td class="label">Package:</td><td class="hd-info">Ext.air</td></tr>
11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/Clipboard.js" target="_blank">Clipboard.js</a></td></tr>
12             <tr><td class="label">Class:</td><td class="hd-info">Clipboard</td></tr>
13                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
14                     </table>
15         <div class="description">
16             *<br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
17         
18         <div class="hr"></div>
19                 <a id="Ext.air.Clipboard-props"></a>
20         <h2>Public Properties</h2>
21         <div class="no-members">This class has no public properties.</div>        <a id="Ext.air.Clipboard-methods"></a>
22         <h2>Public Methods</h2>
23                 <table cellspacing="0" class="member-table">
24             <tr>
25                 <th class="sig-header" colspan="2">Method</th>
26                 <th class="msource-header">Defined By</th>
27             </tr>
28                 <tr class="method-row expandable">\r
29         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
30         <td class="sig">\r
31         <a id="Ext.air.Clipboard-clear"></a>\r
32             <b>clear</b>() : void            <div class="mdesc">\r
33                         <div class="short">Clear the clipboard for all formats.</div>\r
34             <div class="long">\r
35                 Clear the clipboard for all formats.    <div class="mdetail-params">\r
36         <strong>Parameters:</strong>\r
37         <ul><li>None.</li>        </ul>\r
38         <strong>Returns:</strong>\r
39         <ul>\r
40             <li><code>void</code></li>\r
41         </ul>\r
42     </div>\r
43                 </div>\r
44                         </div>\r
45         </td>\r
46         <td class="msource">Clipboard</td>\r
47     </tr>\r
48         <tr class="method-row alt expandable">\r
49         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
50         <td class="sig">\r
51         <a id="Ext.air.Clipboard-clearData"></a>\r
52             <b>clearData</b>(&nbsp;<code>String format</code>&nbsp;) : void            <div class="mdesc">\r
53                         <div class="short">Clear the data for a particular format.</div>\r
54             <div class="long">\r
55                 Clear the data for a particular format.    <div class="mdetail-params">\r
56         <strong>Parameters:</strong>\r
57         <ul><li><code>format</code> : String<div class="sub-desc">Use the air.ClipboardFormats CONSTANT or the string value</div></li>        </ul>\r
58         <strong>Returns:</strong>\r
59         <ul>\r
60             <li><code>void</code></li>\r
61         </ul>\r
62     </div>\r
63                 </div>\r
64                         </div>\r
65         </td>\r
66         <td class="msource">Clipboard</td>\r
67     </tr>\r
68         <tr class="method-row expandable">\r
69         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
70         <td class="sig">\r
71         <a id="Ext.air.Clipboard-getData"></a>\r
72             <b>getData</b>(&nbsp;<code>String format</code>, <code>String transferMode</code>&nbsp;) : void            <div class="mdesc">\r
73                         <div class="short">Get the data for a particular format.</div>\r
74             <div class="long">\r
75                 Get the data for a particular format.    <div class="mdetail-params">\r
76         <strong>Parameters:</strong>\r
77         <ul><li><code>format</code> : String<div class="sub-desc">Use the air.ClipboardFormats CONSTANT or the string value</div></li><li><code>transferMode</code> : String<div class="sub-desc"></div></li>        </ul>\r
78         <strong>Returns:</strong>\r
79         <ul>\r
80             <li><code>void</code></li>\r
81         </ul>\r
82     </div>\r
83                 </div>\r
84                         </div>\r
85         </td>\r
86         <td class="msource">Clipboard</td>\r
87     </tr>\r
88         <tr class="method-row alt expandable">\r
89         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
90         <td class="sig">\r
91         <a id="Ext.air.Clipboard-hasData"></a>\r
92             <b>hasData</b>(&nbsp;<code>String format</code>&nbsp;) : void            <div class="mdesc">\r
93                         <div class="short">Determine if there is any data in a particular format clipboard.</div>\r
94             <div class="long">\r
95                 Determine if there is any data in a particular format clipboard.    <div class="mdetail-params">\r
96         <strong>Parameters:</strong>\r
97         <ul><li><code>format</code> : String<div class="sub-desc">Use the air.ClipboardFormats CONSTANT or the string value</div></li>        </ul>\r
98         <strong>Returns:</strong>\r
99         <ul>\r
100             <li><code>void</code></li>\r
101         </ul>\r
102     </div>\r
103                 </div>\r
104                         </div>\r
105         </td>\r
106         <td class="msource">Clipboard</td>\r
107     </tr>\r
108         <tr class="method-row expandable">\r
109         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
110         <td class="sig">\r
111         <a id="Ext.air.Clipboard-setData"></a>\r
112             <b>setData</b>(&nbsp;<code>String format</code>, <code>Mixed data</code>&nbsp;) : void            <div class="mdesc">\r
113                         <div class="short">Set the data for a particular format clipboard.</div>\r
114             <div class="long">\r
115                 Set the data for a particular format clipboard.    <div class="mdetail-params">\r
116         <strong>Parameters:</strong>\r
117         <ul><li><code>format</code> : String<div class="sub-desc">Use the air.ClipboardFormats CONSTANT or the string value</div></li><li><code>data</code> : Mixed<div class="sub-desc">Data to set</div></li>        </ul>\r
118         <strong>Returns:</strong>\r
119         <ul>\r
120             <li><code>void</code></li>\r
121         </ul>\r
122     </div>\r
123                 </div>\r
124                         </div>\r
125         </td>\r
126         <td class="msource">Clipboard</td>\r
127     </tr>\r
128         <tr class="method-row alt expandable">\r
129         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
130         <td class="sig">\r
131         <a id="Ext.air.Clipboard-setDataHandler"></a>\r
132             <b>setDataHandler</b>(&nbsp;<code>String format</code>, <code>Function fn</code>&nbsp;) : void            <div class="mdesc">\r
133                         <div class="short">Set the data handler for a particular format clipboard.</div>\r
134             <div class="long">\r
135                 Set the data handler for a particular format clipboard.    <div class="mdetail-params">\r
136         <strong>Parameters:</strong>\r
137         <ul><li><code>format</code> : String<div class="sub-desc">Use the air.ClipboardFormats CONSTANT or the string value</div></li><li><code>fn</code> : Function<div class="sub-desc">The function to evaluate when getting the clipboard data</div></li>        </ul>\r
138         <strong>Returns:</strong>\r
139         <ul>\r
140             <li><code>void</code></li>\r
141         </ul>\r
142     </div>\r
143                 </div>\r
144                         </div>\r
145         </td>\r
146         <td class="msource">Clipboard</td>\r
147     </tr>\r
148             </table>
149                 <a id="Ext.air.Clipboard-events"></a>
150         <h2>Public Events</h2>
151         <div class="no-members">This class has no public events.</div>
152         </div>