Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs.old / symbols / Roo.form.HtmlEditor.ToolbarStandard.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
3
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
6         <head>
7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8                 <meta name="generator" content="JsDoc Toolkit" />
9                 
10                 
11                 <title>JsDoc Reference - Roo.form.HtmlEditor.ToolbarStandard</title>
12                 
13                 
14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />            
15         <link rel="stylesheet" type="text/css" href="../default.css" />
16         
17         
18         <script type="text/javascript" src="../page.js">
19         
20         </script>
21          
22                 
23         </head>
24
25         <body onload="RooDocsPage.onload();">
26          
27         
28 <div class="body-wrap">
29
30     <!-- ============================== links to methods. ================================= --> 
31
32     <div class="top-tools">
33     <!--
34         <a class="inner-link" href="#Roo.form.HtmlEditor.ToolbarStandard-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35         <a class="inner-link" href="#Roo.form.HtmlEditor.ToolbarStandard-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36         <a class="inner-link" href="#Roo.form.HtmlEditor.ToolbarStandard-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37         <a class="inner-link" href="#Roo.form.HtmlEditor.ToolbarStandard-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
39         -->
40     </div>
41
42     
43 <!-- ============================== inheritance Block. ================================= -->    
44         
45 <!-- ============================== class title / details ============================ -->
46     
47     
48     <h1 class="classTitle">
49                                 
50                                 Class Roo.form.HtmlEditor.ToolbarStandard
51                         </h1>
52                         
53     <table cellspacing="0" class="class-summary-table">
54         
55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.form.HtmlEditor</td></tr>
56         
57         <tr><td class="label">Defined In:</td><td class="hd-info">
58                         
59                                         <a href="./src/Roo_form_HtmlEditor_ToolbarStandard.js.html">Roo/form/HtmlEditor/ToolbarStandard.js</a>.
60                         
61         </td></tr>
62         <tr><td class="label">Class:</td><td class="hd-info">ToolbarStandard</td></tr>
63         
64         
65         
66         
67     </table>
68
69     
70 <!-- ============================== class summary ========================== -->                        
71     <div class="description">
72         Basic Toolbar<br/><br/>Usage:<br/><br/> new Roo.form.HtmlEditor({<br/>    ....<br/>    toolbars : [<br/>        new Roo.form.HtmlEditorToolbar1({<br/>            disable : { fonts: 1 , format: 1, ..., ... , ...],<br/>            btns : [ .... ]<br/>        })<br/>    }
73     </div>
74
75         
76 <!-- ============================== Class comment block... ========================== -->                                       
77
78 <div class="comments">
79         <b>Class Comments / Notes</B> =>  
80         <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.HtmlEditor.ToolbarStandard';">[Add Your comment/notes about this class]</u>
81         <br/>
82         <iframe frameborder="0"  id="comments-Roo.form.HtmlEditor" style="border: none;width:100%;" 
83                 src="/blog.php/GtkDjsComments/Roo.form.HtmlEditor.ToolbarStandard.html"></iframe>
84 </div>
85         
86
87                 
88 <!-- ============================== config options ========================== -->                                               
89                  
90     
91     
92                 
93     <div class="hr"></div>
94     <a id="Roo.form.HtmlEditor.ToolbarStandard-configs"></a>
95                 
96     
97      
98     
99         
100       <table cellspacing="0" class="member-table">   
101       <caption>Config Options (Usually are also Properties)</caption>
102     
103         
104         <tr>
105             <th class="sig-header" colspan="2">Options</th>
106             
107             <th class="msource-header">Defined By</th>
108         </tr>
109         
110         
111         
112         
113         
114                 <tr class="config-row expandable config-row-alt0 notInherited">
115                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
116                     <td class="sig">
117
118                         <a id="Roo.form.HtmlEditor.ToolbarStandard-cfg-btns" name=".btns"></a>
119                         <div class="fixedFont">
120                                 <b  class="itemname">btns</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
121                                 
122                                 
123                         </div>
124                   
125                         <div class="mdesc">
126                             <div class="short">List of additional buttons.</div> 
127                         </div>
128                         
129                         <div class="mdesc">
130                             <div class="long">
131                     List of additional buttons.<br/><br/><br/>NEEDS Extra CSS? <br/>.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }
132                     
133                 </div> 
134                         </div>
135                         
136                         
137
138                     </td>
139                     <td class="msource">
140                         
141                         Roo.form.HtmlEditor.ToolbarStandard
142                                 
143                     </td>
144                 </tr>
145         
146         
147                 <tr class="config-row expandable config-row-alt1 notInherited">
148                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
149                     <td class="sig">
150
151                         <a id="Roo.form.HtmlEditor.ToolbarStandard-cfg-createLinkText" name=".createLinkText"></a>
152                         <div class="fixedFont">
153                                 <b  class="itemname">createLinkText</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
154                                 
155                                 
156                         </div>
157                   
158                         <div class="mdesc">
159                             <div class="short">The default text for the create link prompt</div> 
160                         </div>
161                         
162                         <div class="mdesc">
163                             <div class="long">
164                     The default text for the create link prompt
165                     
166                 </div> 
167                         </div>
168                         
169                         
170
171                     </td>
172                     <td class="msource">
173                         
174                         Roo.form.HtmlEditor.ToolbarStandard
175                                 
176                     </td>
177                 </tr>
178         
179         
180                 <tr class="config-row expandable config-row-alt0 notInherited">
181                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
182                     <td class="sig">
183
184                         <a id="Roo.form.HtmlEditor.ToolbarStandard-cfg-defaultFont" name=".defaultFont"></a>
185                         <div class="fixedFont">
186                                 <b  class="itemname">defaultFont</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
187                                 
188                                 
189                         </div>
190                   
191                         <div class="mdesc">
192                             <div class="short">default font to use.</div> 
193                         </div>
194                         
195                         <div class="mdesc">
196                             <div class="long">
197                     default font to use.
198                     
199                 </div> 
200                         </div>
201                         
202                         
203
204                     </td>
205                     <td class="msource">
206                         
207                         Roo.form.HtmlEditor.ToolbarStandard
208                                 
209                     </td>
210                 </tr>
211         
212         
213                 <tr class="config-row expandable config-row-alt1 notInherited">
214                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
215                     <td class="sig">
216
217                         <a id="Roo.form.HtmlEditor.ToolbarStandard-cfg-defaultLinkValue" name=".defaultLinkValue"></a>
218                         <div class="fixedFont">
219                                 <b  class="itemname">defaultLinkValue</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
220                                 
221                                 
222                         </div>
223                   
224                         <div class="mdesc">
225                             <div class="short">The default value for the create link prompt (defaults to http:/ /)</div> 
226                         </div>
227                         
228                         <div class="mdesc">
229                             <div class="long">
230                     The default value for the create link prompt (defaults to http:/ /)
231                     
232                 </div> 
233                         </div>
234                         
235                         
236
237                     </td>
238                     <td class="msource">
239                         
240                         Roo.form.HtmlEditor.ToolbarStandard
241                                 
242                     </td>
243                 </tr>
244         
245         
246                 <tr class="config-row expandable config-row-alt0 notInherited">
247                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
248                     <td class="sig">
249
250                         <a id="Roo.form.HtmlEditor.ToolbarStandard-cfg-disable" name=".disable"></a>
251                         <div class="fixedFont">
252                                 <b  class="itemname">disable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
253                                 
254                                 
255                         </div>
256                   
257                         <div class="mdesc">
258                             <div class="short">List of elements to disable.</div> 
259                         </div>
260                         
261                         <div class="mdesc">
262                             <div class="long">
263                     List of elements to disable..
264                     
265                 </div> 
266                         </div>
267                         
268                         
269
270                     </td>
271                     <td class="msource">
272                         
273                         Roo.form.HtmlEditor.ToolbarStandard
274                                 
275                     </td>
276                 </tr>
277         
278         
279                 <tr class="config-row expandable config-row-alt1 notInherited">
280                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
281                     <td class="sig">
282
283                         <a id="Roo.form.HtmlEditor.ToolbarStandard-cfg-fontFamilies" name=".fontFamilies"></a>
284                         <div class="fixedFont">
285                                 <b  class="itemname">fontFamilies</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
286                                 
287                                 
288                         </div>
289                   
290                         <div class="mdesc">
291                             <div class="short">An array of available font families</div> 
292                         </div>
293                         
294                         <div class="mdesc">
295                             <div class="long">
296                     An array of available font families
297                     
298                 </div> 
299                         </div>
300                         
301                         
302
303                     </td>
304                     <td class="msource">
305                         
306                         Roo.form.HtmlEditor.ToolbarStandard
307                                 
308                     </td>
309                 </tr>
310         
311         
312     </table>
313                 
314   
315   
316   
317   
318   
319   
320   
321   
322   <!-- ============================== public properties ==================== -->        
323   
324   
325   
326     <a id="Roo.form.HtmlEditor.ToolbarStandard-props"></a>      
327     
328     
329
330     
331     
332      <table cellspacing="0" class="member-table">
333       <caption class="Empty">Public Properties - Has None</caption>
334      </table>
335     
336     
337      
338     
339   <!-- ============================== methods summary / details ======================== -->
340   
341   
342   <a id="Roo.form.HtmlEditor.ToolbarStandard-methods"></a>
343         <!-- constructor?? -->
344         
345         <!-- static's first 
346         
347         
348         -->
349         
350         <!-- then dynamics first -->
351         
352   
353   
354     
355     
356     
357       <table cellspacing="0" class="member-table">
358       <caption>Public Methods</caption>
359         <tr>
360             <th class="sig-header" colspan="2">Method</th>            
361             <th class="msource-header">Defined By</th>
362
363         </tr>
364         
365         
366         
367          
368         
369         
370           
371           <tr class="method-row config-row-alt0 notInherited">
372             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
373            
374            
375             <td class="sig">
376                 <a id="Roo.form.HtmlEditor-method-ToolbarStandard"   name=".ToolbarStandard"></a>
377                 <div class="fixedFont">
378                         <span class="attributes">new <B>Roo.form.HtmlEditor.</B></span><b class="itemname">ToolbarStandard</b>
379                                 
380                                  () 
381                         
382                                 
383                         
384                 </div>
385                 <div class="mdesc">
386                 
387                  
388                         <div class="short">Create a new Roo.form.HtmlEditor.ToolbarStandard</div> 
389                  
390                  
391                     <div class="long">
392                         
393                         
394                         
395                                 Create a new Roo.form.HtmlEditor.ToolbarStandard
396                         
397                         
398                         
399                         
400                         
401                         
402                         
403                         
404
405                     
406                     
407                      
408                     </div>                    
409                 </div>
410
411             </td>
412             <td class="msource">
413                 &nbsp;
414             </td>
415         </tr>
416         
417           
418           <tr class="method-row config-row-alt1 expandable notInherited">
419             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
420            
421            
422             <td class="sig">
423                 <a id="Roo.form.HtmlEditor.ToolbarStandard-method-updateToolbar"   name=".updateToolbar"></a>
424                 <div class="fixedFont">
425                         <span class="attributes"></span><b class="itemname">updateToolbar</b>
426                                 
427                                  () 
428                         
429                                 
430                         
431                 </div>
432                 <div class="mdesc">
433                 
434                    <div class="short">Protected method that will not generally be called directly.</div> 
435                  
436                  
437                  
438                     <div class="long">
439                         
440                                 Protected method that will not generally be called directly. It triggers<br/>a toolbar update by reading the markup state of the current selection in the editor.
441                     
442                                 
443                         
444                         
445                         
446                         
447                         
448                         
449                         
450                         
451                         
452                         
453
454                     
455                     
456                      
457                     </div>                    
458                 </div>
459
460             </td>
461             <td class="msource">
462                 
463                         Roo.form.HtmlEditor.ToolbarStandard
464                 &nbsp;
465             </td>
466         </tr>
467         
468                                                        
469     </table>
470
471   
472   <!-- ============================== events summary / details ======================== -->
473   
474   
475   <a id="Roo.form.HtmlEditor.ToolbarStandard-events"></a>
476     
477   
478         
479    
480     
481      <table cellspacing="0" class="member-table">
482       <caption class="Empty">Events - Has None</caption>
483      </table>
484     
485     
486   
487     
488     
489   
490   
491   
492  
493 <!-- ============================== footer ================================= -->
494                 <div class="fineprint" style="clear:both">
495                         
496                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
497                         Based on 
498                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>  
499                 </div>
500         </body>
501 </html>