/assets/plugins/tiny-mce/docs/api/class_tinymce.ui.Container.html

https://bitbucket.org/yohanaputra/codeigniter-case · HTML · 292 lines · 290 code · 2 blank · 0 comment · 0 complexity · 75db5f189865e521823b5b5b0b52d11b MD5 · raw file 

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Class: tinymce.ui.Container</title>
    5. 

  5. <meta name="generator" content="MoxieDoc" />
    6. 

  6. 

  7. <link rel="stylesheet" type="text/css" href="css/reset.css" />
    8. 

  8. <link rel="stylesheet" type="text/css" href="css/grids.css" />
    9. 

  9. <link rel="stylesheet" type="text/css" href="css/general.css" />
    10. 

  10. 

  11. <script type="text/javascript" src="http://www.google.com/jsapi"></script>
    12. 

  12. <script type="text/javascript">
    13. 

  13. 	google.load("jquery", "1.3");
    14. 

  14. </script>
    15. 

  15. <script type="text/javascript" src="js/jquery.treeview.min.js"></script>
    16. 

  16. <script type="text/javascript" src="js/general.js"></script>
    17. 

  17. </head>
    18. 

  18. <body>
    19. 

  19. <div class="classDetailsContent">
    20. 

  20. <h1>tinymce.ui.Container</h1>
    21. 

  21. <table class="classDetails">
    22. 

  22. <tr>
    23. 

  23. <td class="first">Namespace</td>
    24. 

  24. <td class="last">tinymce.ui</td>
    25. 

  25. </tr>
    26. 

  26. <tr>
    27. 

  27. <td class="first">Class</td>
    28. 

  28. <td class="last">Container</td>
    29. 

  29. </tr>
    30. 

  30. <tr>
    31. 

  31. <td class="first">Inheritance</td>
    32. 

  32. <td class="last inheritageList">
    33. 

  33. <span>Container</span>
    34. 

  34. <span class="last">
    35. 

  35. <a href="class_tinymce.ui.Control.html">Control</a>
    36. 

  36. </span>
    37. 

  37. </td>
    38. 

  38. </tr>
    39. 

  39. <tr>
    40. 

  40. <td class="first">Subclasses</td>
    41. 

  41. <td class="last subClassList">
    42. 

  42. <a href="class_tinymce.ui.Toolbar.html">Toolbar</a>, <a href="class_tinymce.ui.ToolbarGroup.html">ToolbarGroup</a>
    43. 

  43. </td>
    44. 

  44. </tr>
    45. 

  45. </table>
    46. 

  46. <div class="classDescription">This class is the base class for all container controls like toolbars. This class should not
    47. 

  47. be instantiated directly other container controls should inherit from this one.
    48. 

  48. </div>
    49. 

  49. <div class="summaryLists">
    50. 

  50. <h2>Public Properties</h2>
    51. 

  51. <table class="Properties summary">
    52. 

  52. <thead>
    53. 

  53. <tr>
    54. 

  54. <th>Property</th>
    55. 

  55. <th>Defined By</th>
    56. 

  56. </tr>
    57. 

  57. </thead>
    58. 

  58. <tbody>
    59. 

  59. <tr>
    60. 

  60. <td class="first">
    61. 

  61. <div>
    62. 

  62. <a class="memberName" href="class_tinymce.ui.Container.html#controls">controls</a> : Array</div>
    63. 

  63. <div class="summary">Array of controls added to the container.</div>
    64. 

  64. </td>
    65. 

  65. <td class="last">Container</td>
    66. 

  66. </tr>
    67. 

  67. </tbody>
    68. 

  68. </table>
    69. 

  69. <h2>Public Methods</h2>
    70. 

  70. <table class="Methods summary">
    71. 

  71. <thead>
    72. 

  72. <tr>
    73. 

  73. <th>Method</th>
    74. 

  74. <th>Defined By</th>
    75. 

  75. </tr>
    76. 

  76. </thead>
    77. 

  77. <tbody>
    78. 

  78. <tr>
    79. 

  79. <td class="first">
    80. 

  80. <div>
    81. 

  81. <a class="memberName" href="class_tinymce.ui.Container.html#Container">Container</a>(id:String, s:Object)</div>
    82. 

  82. <div class="summary">Base contrustor a new container control instance.</div>
    83. 

  83. </td>
    84. 

  84. <td class="last">Container</td>
    85. 

  85. </tr>
    86. 

  86. <tr class="even">
    87. 

  87. <td class="first">
    88. 

  88. <div>
    89. 

  89. <a class="memberName" href="class_tinymce.ui.Container.html#add">add</a>(c:<a href="class_tinymce.ui.Control.html">Control</a>):<a href="class_tinymce.ui.Control.html">Control</a>
    90. 

  90. </div>
    91. 

  91. <div class="summary">Adds a control to the collection of controls for the container.</div>
    92. 

  92. </td>
    93. 

  93. <td class="last">Container</td>
    94. 

  94. </tr>
    95. 

  95. <tr class="inherited">
    96. 

  96. <td class="first">
    97. 

  97. <div>
    98. 

  98. <a class="memberName" href="class_tinymce.ui.Control.html#destroy">destroy</a>():void</div>
    99. 

  99. <div class="summary">Destroys the control will free any memory by removing event listeners etc.</div>
    100. 

  100. </td>
    101. 

  101. <td class="last">
    102. 

  102. <a href="class_tinymce.ui.Control.html">Control</a>
    103. 

  103. </td>
    104. 

  104. </tr>
    105. 

  105. <tr class="even">
    106. 

  106. <td class="first">
    107. 

  107. <div>
    108. 

  108. <a class="memberName" href="class_tinymce.ui.Container.html#get">get</a>(n:String):<a href="class_tinymce.ui.Control.html">Control</a>
    109. 

  109. </div>
    110. 

  110. <div class="summary">Returns a control by id from the containers collection.</div>
    111. 

  111. </td>
    112. 

  112. <td class="last">Container</td>
    113. 

  113. </tr>
    114. 

  114. <tr class="inherited">
    115. 

  115. <td class="first">
    116. 

  116. <div>
    117. 

  117. <a class="memberName" href="class_tinymce.ui.Control.html#isActive">isActive</a>():Boolean</div>
    118. 

  118. <div class="summary">Returns true/false if the control is disabled or not.</div>
    119. 

  119. </td>
    120. 

  120. <td class="last">
    121. 

  121. <a href="class_tinymce.ui.Control.html">Control</a>
    122. 

  122. </td>
    123. 

  123. </tr>
    124. 

  124. <tr class="inherited even">
    125. 

  125. <td class="first">
    126. 

  126. <div>
    127. 

  127. <a class="memberName" href="class_tinymce.ui.Control.html#isDisabled">isDisabled</a>():Boolean</div>
    128. 

  128. <div class="summary">Returns true/false if the control is disabled or not.</div>
    129. 

  129. </td>
    130. 

  130. <td class="last">
    131. 

  131. <a href="class_tinymce.ui.Control.html">Control</a>
    132. 

  132. </td>
    133. 

  133. </tr>
    134. 

  134. <tr class="inherited">
    135. 

  135. <td class="first">
    136. 

  136. <div>
    137. 

  137. <a class="memberName" href="class_tinymce.ui.Control.html#isRendered">isRendered</a>():Boolean</div>
    138. 

  138. <div class="summary">Returns true/false if the control has been rendered or not.</div>
    139. 

  139. </td>
    140. 

  140. <td class="last">
    141. 

  141. <a href="class_tinymce.ui.Control.html">Control</a>
    142. 

  142. </td>
    143. 

  143. </tr>
    144. 

  144. <tr class="inherited even">
    145. 

  145. <td class="first">
    146. 

  146. <div>
    147. 

  147. <a class="memberName" href="class_tinymce.ui.Control.html#postRender">postRender</a>():void</div>
    148. 

  148. <div class="summary">Post render event.</div>
    149. 

  149. </td>
    150. 

  150. <td class="last">
    151. 

  151. <a href="class_tinymce.ui.Control.html">Control</a>
    152. 

  152. </td>
    153. 

  153. </tr>
    154. 

  154. <tr class="inherited">
    155. 

  155. <td class="first">
    156. 

  156. <div>
    157. 

  157. <a class="memberName" href="class_tinymce.ui.Control.html#remove">remove</a>():void</div>
    158. 

  158. <div class="summary">Removes the control.</div>
    159. 

  159. </td>
    160. 

  160. <td class="last">
    161. 

  161. <a href="class_tinymce.ui.Control.html">Control</a>
    162. 

  162. </td>
    163. 

  163. </tr>
    164. 

  164. <tr class="inherited even">
    165. 

  165. <td class="first">
    166. 

  166. <div>
    167. 

  167. <a class="memberName" href="class_tinymce.ui.Control.html#renderHTML">renderHTML</a>():String</div>
    168. 

  168. <div class="summary">Renders the control as a HTML string.</div>
    169. 

  169. </td>
    170. 

  170. <td class="last">
    171. 

  171. <a href="class_tinymce.ui.Control.html">Control</a>
    172. 

  172. </td>
    173. 

  173. </tr>
    174. 

  174. <tr class="inherited">
    175. 

  175. <td class="first">
    176. 

  176. <div>
    177. 

  177. <a class="memberName" href="class_tinymce.ui.Control.html#renderTo">renderTo</a>(n:Element):void</div>
    178. 

  178. <div class="summary">Renders the control to the specified container element.</div>
    179. 

  179. </td>
    180. 

  180. <td class="last">
    181. 

  181. <a href="class_tinymce.ui.Control.html">Control</a>
    182. 

  182. </td>
    183. 

  183. </tr>
    184. 

  184. <tr class="inherited even">
    185. 

  185. <td class="first">
    186. 

  186. <div>
    187. 

  187. <a class="memberName" href="class_tinymce.ui.Control.html#setActive">setActive</a>(s:Boolean):void</div>
    188. 

  188. <div class="summary">Sets the activated state for the control.</div>
    189. 

  189. </td>
    190. 

  190. <td class="last">
    191. 

  191. <a href="class_tinymce.ui.Control.html">Control</a>
    192. 

  192. </td>
    193. 

  193. </tr>
    194. 

  194. <tr class="inherited">
    195. 

  195. <td class="first">
    196. 

  196. <div>
    197. 

  197. <a class="memberName" href="class_tinymce.ui.Control.html#setDisabled">setDisabled</a>(s:Boolean):void</div>
    198. 

  198. <div class="summary">Sets the disabled state for the control.</div>
    199. 

  199. </td>
    200. 

  200. <td class="last">
    201. 

  201. <a href="class_tinymce.ui.Control.html">Control</a>
    202. 

  202. </td>
    203. 

  203. </tr>
    204. 

  204. <tr class="inherited even">
    205. 

  205. <td class="first">
    206. 

  206. <div>
    207. 

  207. <a class="memberName" href="class_tinymce.ui.Control.html#setState">setState</a>(c:String, s:Boolean):void</div>
    208. 

  208. <div class="summary">Sets the specified class state for the control.</div>
    209. 

  209. </td>
    210. 

  210. <td class="last">
    211. 

  211. <a href="class_tinymce.ui.Control.html">Control</a>
    212. 

  212. </td>
    213. 

  213. </tr>
    214. 

  214. </tbody>
    215. 

  215. </table>
    216. 

  216. </div>
    217. 

  217. <div class="detailsList">
    218. 

  218. <div class="details">
    219. 

  219. <h2>Property details</h2>
    220. 

  220. <div class="memberDetails last" id="controls">
    221. 

  221. <h3>controls<span class="memberType">property</span>
    222. 

  222. </h3>
    223. 

  223. <code class="syntax">public controls : Array</code>
    224. 

  224. <div class="memberDescription">Array of controls added to the container.
    225. 

  225. </div>
    226. 

  226. </div>
    227. 

  227. </div>
    228. 

  228. <div class="details">
    229. 

  229. <h2>Method details</h2>
    230. 

  230. <div class="memberDetails" id="Container">
    231. 

  231. <h3>Container<span class="memberType">constructor</span>
    232. 

  232. </h3>
    233. 

  233. <code class="syntax">public 
    234. 

  234. 						function Container(id:String, s:Object)</code>
    235. 

  235. <div class="memberDescription">Base contrustor a new container control instance.
    236. 

  236. </div>
    237. 

  237. <h4>Parameters</h4>
    238. 

  238. <table class="params">
    239. 

  239. <tr>
    240. 

  240. <td class="first">id:String</td>
    241. 

  241. <td class="last">Control id to use for the container.</td>
    242. 

  242. </tr>
    243. 

  243. <tr>
    244. 

  244. <td class="first">s:Object</td>
    245. 

  245. <td class="last">Optional name/value settings object.</td>
    246. 

  246. </tr>
    247. 

  247. </table>
    248. 

  248. </div>
    249. 

  249. <div class="memberDetails" id="add">
    250. 

  250. <h3>add<span class="memberType">method</span>
    251. 

  251. </h3>
    252. 

  252. <code class="syntax">public 
    253. 

  253. 						function add(c:<a href="class_tinymce.ui.Control.html">Control</a>):<a href="class_tinymce.ui.Control.html">Control</a>
    254. 

  254. </code>
    255. 

  255. <div class="memberDescription">Adds a control to the collection of controls for the container.
    256. 

  256. </div>
    257. 

  257. <h4>Parameters</h4>
    258. 

  258. <table class="params">
    259. 

  259. <tr>
    260. 

  260. <td class="first">c:<a href="class_tinymce.ui.Control.html">Control</a>
    261. 

  261. </td>
    262. 

  262. <td class="last">Control instance to add to the container.</td>
    263. 

  263. </tr>
    264. 

  264. </table>
    265. 

  265. <h4>Returns</h4>
    266. 

  266. <div class="returns">
    267. 

  267. <a href="class_tinymce.ui.Control.html">Control</a> - Same control instance that got passed in.</div>
    268. 

  268. </div>
    269. 

  269. <div class="memberDetails last" id="get">
    270. 

  270. <h3>get<span class="memberType">method</span>
    271. 

  271. </h3>
    272. 

  272. <code class="syntax">public 
    273. 

  273. 						function get(n:String):<a href="class_tinymce.ui.Control.html">Control</a>
    274. 

  274. </code>
    275. 

  275. <div class="memberDescription">Returns a control by id from the containers collection.
    276. 

  276. </div>
    277. 

  277. <h4>Parameters</h4>
    278. 

  278. <table class="params">
    279. 

  279. <tr>
    280. 

  280. <td class="first">n:String</td>
    281. 

  281. <td class="last">Id for the control to retrive.</td>
    282. 

  282. </tr>
    283. 

  283. </table>
    284. 

  284. <h4>Returns</h4>
    285. 

  285. <div class="returns">
    286. 

  286. <a href="class_tinymce.ui.Control.html">Control</a> - Control instance by the specified name or undefined if it wasn't found.</div>
    287. 

  287. </div>
    288. 

  288. </div>
    289. 

  289. </div>
    290. 

  290. </div>
    291. 

  291. </body>
    292. 

  292. </html>
    293.