Zend_Dojo-View-Helpers.xml 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15156 -->
  3. <!-- Reviewed: no -->
  4. <sect2 id="zend.dojo.view.dijit">
  5. <title>Dijit-Spezifische View Helfer</title>
  6. <para>
  7. Aus dem Dojo Handbuch: "Dijit ist ein Widget System das über Dojo gelegt wurde.". Dijit
  8. enthält eine Vielzahl von Layout und Formular Widgets die erstellt wurden um Zugriffsfeatures,
  9. Lokalisation, und standardtisiertes (und themenbasierendes) Look-and-Feel zu bieten.
  10. </para>
  11. <para>
  12. Zend Framework wird mit einer Vielzahl an View Helfern ausgeliefert die es erlauben Dijits
  13. in eigenen View Skripten darzustellen und anzupassen. Es gibt drei Basistypen:
  14. </para>
  15. <itemizedlist>
  16. <listitem>
  17. <para>
  18. <emphasis>Layout Container</emphasis>: Diese wurden erstellt um in View Skripten verwendet,
  19. oder von Formular Dekoratoren für Formulare, Unterformulare oder Anzeigegruppen
  20. konsumiert zu werden. Sie hüllen die verschiedenen angebotenen Klassen in dijit.layout ein.
  21. Jeder Dijit Layout Viewhelfer erwartet die folgenden Argumente:
  22. </para>
  23. <itemizedlist>
  24. <listitem><para>
  25. <code>$id</code>: Der Name des Containers oder die DOM ID.
  26. </para></listitem>
  27. <listitem><para>
  28. <code>$content</code>: Der Inhalt der vom Layout Container umhüllt werden soll.
  29. </para></listitem>
  30. <listitem><para>
  31. <code>$params</code> (Optional): Dijit-spezifische Parameter. Grundsätzlich kann
  32. jedes nicht-HTML Attribut verwendet werden um den Dijit Layout Container zu
  33. konfigurieren.
  34. </para></listitem>
  35. <listitem><para>
  36. <code>$attribs</code> (Optional): Jedes zusätzliche HTML Attribut das verwendet werden
  37. soll um den Container DIV darzustellen. Wenn der Schlüssel 'id' an dieses Array
  38. übergeben wird, wird es für die ID des DOM Formular Elements verwendet und
  39. <code>$id</code> wird für seinen Namen verwendet.
  40. </para></listitem>
  41. </itemizedlist>
  42. <para>
  43. Wenn an den Dijit Layout Viewhelfer keine Argumente übergeben werden, wird der Helfer selbst
  44. zurückgegeben. Das erlaubt es den Inhalt zu erhalten, was oft der einfachste Weg ist um
  45. Inhalt an den Layout Container zu übergeben. Beispiele für diese Funktionalität werden später
  46. in diesem Kapitel gezeigt.
  47. </para>
  48. </listitem>
  49. <listitem>
  50. <para>
  51. <emphasis>Form Dijit</emphasis>: Auch wen das dijit.form.Form Dijit für die Verwendung von
  52. Dijit Form Elementen nicht vollständig notwendig ist, stellt es sicher das, wenn ein Versuch
  53. unternommen wird ein Formular zu übertragen das die Client-seitigen Prüfungen nicht besteht,
  54. die Übertragung angehalten und eine Prüffehlermeldung geworfen wird. Der Form Dijit
  55. Viewhelfer erwartet die folgenden Argumente:
  56. </para>
  57. <itemizedlist>
  58. <listitem><para>
  59. <code>$id</code>: Der Name des Containers oder der DOM ID.
  60. </para></listitem>
  61. <listitem><para>
  62. <code>$attribs</code> (Optional): Alle zusätzliche HTML Attribute die verwendet werden
  63. sollten um das Container DIV darzustellen.
  64. </para></listitem>
  65. <listitem><para>
  66. <code>$content</code> (Optional): Der Inhalt der im Formular umschlossen wird.
  67. Wenn keiner übergeben wird, wird ein leerer String verwendet.
  68. </para></listitem>
  69. </itemizedlist>
  70. <para>
  71. Die Reihenfolge der Argumente variiert von den anderen Dijits um die Kompatibilität mit dem
  72. standard <code>form()</code> Viewhelfer zu haben.
  73. </para>
  74. </listitem>
  75. <listitem>
  76. <para>
  77. <emphasis>Form Elemente</emphasis>: Diese wurden designed um von <classname>Zend_Form</classname>
  78. verwendet zu werden, können aber auch selbstständig in Viewsktipten verwendet werden.
  79. Jedes Dijit Element Viewhelfer erwartet die folgenden Elemente:
  80. </para>
  81. <itemizedlist>
  82. <listitem><para>
  83. <code>$id</code>: Der Name des Elements oder die DOM ID.
  84. </para></listitem>
  85. <listitem><para>
  86. <code>$value</code> (Optional): Der aktuelle Wert des Elements.
  87. </para></listitem>
  88. <listitem><para>
  89. <code>$params</code> (Optional): Dijit-spezifische Parameter. Grundsätzlich können
  90. alle nicht-HTML Attribute für die Konfiguration des Dijits verwendet werden.
  91. </para></listitem>
  92. <listitem><para>
  93. <code>$attribs</code> (Optional): Jedes zusätzliche HTML Attribut das verwendet werden
  94. soll um das Dijit darzustellen. Wenn der Schlüssel 'id' an dieses Array
  95. übergeben wird, wird es für die ID des DOM Formular Elements verwendet und
  96. <code>$id</code> wird für seinen Namen verwendet.
  97. </para></listitem>
  98. </itemizedlist>
  99. <para>
  100. Einige Elemente benötigen mehr Argumente; diese werden in den Beschreibungen der individuellen
  101. Elementhelfer erklärt.
  102. </para>
  103. </listitem>
  104. </itemizedlist>
  105. <para>
  106. Um diese Viewhelfer zu verwendenn, muß der Pfad zu den Dojo Viewhelfern im View Objekt registriert
  107. werden.
  108. </para>
  109. <example id="zend.dojo.view.dijit.prefixpath">
  110. <title>Registrierung des Präfix Pfades zu den Dojo Viewhelfern</title>
  111. <programlisting role="php"><![CDATA[
  112. $view->addHelperPath('Zend/Dojo/View/Helper', 'Zend_Dojo_View_Helper');
  113. ]]></programlisting>
  114. </example>
  115. <sect3 id="zend.dojo.view.dijit.layout">
  116. <title>Dijit Layout Elemente</title>
  117. <para>
  118. Die Familie der dijit.layout Elemente sind für die Erstellung von eigenen, vorhersagbaren
  119. Layouts für die eigene Site. Für alle Fragen über die generelle Verwendung
  120. <ulink url="http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/layout">lesen Sie hierüber
  121. im Dojo Handbuch nach</ulink>.
  122. </para>
  123. <para>
  124. Alle Dijit Layoutelemente haben die Signatur
  125. <code>string ($id = null, $content = '', array $params = array(), array $attribs = array())</code>.
  126. In allen Fällen wird, wenn man keine Argumente übergibt, das Helferobjekt selbst zurückgegeben.
  127. Das gibt einem Zugriff auf die <code>captureStart()</code> und <code>captureEnd()</code>
  128. Methoden, welche es erlauben Inhalte zu holen statt diese an den Layout Container zu übergeben.
  129. </para>
  130. <itemizedlist>
  131. <listitem>
  132. <para>
  133. <emphasis>AccordionContainer</emphasis>: dijit.layout.AccordionContainer. Fügt alle
  134. Ausschnitte vertikal zusallen; das Klicken auf die Überschrift eines Ausschnittes expandiert
  135. diesen und zeigt den betreffenden Ausschnitt an.
  136. </para>
  137. <programlisting role="php"><![CDATA[
  138. <?php echo $view->accordionContainer(
  139. 'foo',
  140. $content,
  141. array(
  142. 'duration' => 200,
  143. ),
  144. array(
  145. 'style' => 'width: 200px; height: 300px;',
  146. ),
  147. ); ?>
  148. ]]></programlisting>
  149. </listitem>
  150. <listitem>
  151. <para>
  152. <emphasis>AccordionPane</emphasis>: dijit.layout.AccordionPane. Für die Verwendung im
  153. AccordionContainer.
  154. </para>
  155. <programlisting role="php"><![CDATA[
  156. <?php echo $view->accordionPane(
  157. 'foo',
  158. $content,
  159. array(
  160. 'title' => 'Titel des Ausschnittes',
  161. ),
  162. array(
  163. 'style' => 'background-color: lightgray;',
  164. ),
  165. ); ?>
  166. ]]></programlisting>
  167. </listitem>
  168. <listitem>
  169. <para>
  170. <emphasis>BorderContainer</emphasis>: dijit.layout.BorderContainer. Ermöglicht Layouts
  171. mit optional größenveränderbaren Ausschnitten wie man Sie in traditionellen Anwendungen
  172. oft sieht.
  173. </para>
  174. <programlisting role="php"><![CDATA[
  175. <?php echo $view->borderContainer(
  176. 'foo',
  177. $content,
  178. array(
  179. 'design' => 'headline',
  180. ),
  181. array(
  182. 'style' => 'width: 100%; height: 100%',
  183. ),
  184. ); ?>
  185. ]]></programlisting>
  186. </listitem>
  187. <listitem>
  188. <para>
  189. <emphasis>ContentPane</emphasis>: dijit.layout.ContentPane. Wird in allen Containern
  190. ausser AccordionContainer verwendet.
  191. </para>
  192. <programlisting role="php"><![CDATA[
  193. <?php echo $view->contentPane(
  194. 'foo',
  195. $content,
  196. array(
  197. 'title' => 'Titel des Ausschnittes',
  198. 'region' => 'left',
  199. ),
  200. array(
  201. 'style' => 'width: 120px; background-color: lightgray;',
  202. ),
  203. ); ?>
  204. ]]></programlisting>
  205. </listitem>
  206. <listitem>
  207. <para>
  208. <emphasis>SplitContainer</emphasis>: dijit.layout.SplitContainer. Erlaubt Ausschnitte mit
  209. größenveränderbarem Inhalt; sollte in Dojo nicht mehr verwendet werden, stattdessen
  210. BorderContainer.
  211. </para>
  212. <programlisting role="php"><![CDATA[
  213. <?php echo $view->splitContainer(
  214. 'foo',
  215. $content,
  216. array(
  217. 'orientation' => 'horizontal',
  218. 'sizerWidth' => 7,
  219. 'activeSizing' => true,
  220. ),
  221. array(
  222. 'style' => 'width: 400px; height: 500px;',
  223. ),
  224. ); ?>
  225. ]]></programlisting>
  226. </listitem>
  227. <listitem>
  228. <para>
  229. <emphasis>StackContainer</emphasis>: dijit.layout.StackContainer. Alle Ausschnitte eines
  230. StackContainers werden in einem Stack platziert; erstelle Buttons oder Funktionalität um
  231. einen auf einmal zu erhalten.
  232. </para>
  233. <programlisting role="php"><![CDATA[
  234. <?php echo $view->stackContainer(
  235. 'foo',
  236. $content,
  237. array(),
  238. array(
  239. 'style' => 'width: 400px; height: 500px; border: 1px;',
  240. ),
  241. ); ?>
  242. ]]></programlisting>
  243. </listitem>
  244. <listitem>
  245. <para>
  246. <emphasis>TabContainer</emphasis>: dijit.layout.TabContainer. Alle Ausschnitte eines
  247. TabContainers werden in einem Stack platziert, wobei Tabs auf einer Seite positioniert
  248. werden um zwischen Ihnen zu wählen.
  249. </para>
  250. <programlisting role="php"><![CDATA[
  251. <?php echo $view->tabContainer(
  252. 'foo',
  253. $content,
  254. array(),
  255. array(
  256. 'style' => 'width: 400px; height: 500px; border: 1px;',
  257. ),
  258. ); ?>
  259. ]]></programlisting>
  260. </listitem>
  261. </itemizedlist>
  262. <para>
  263. Die folgenden Erfassungsmethoden sind für alle Layout Container vorhanden:
  264. </para>
  265. <itemizedlist>
  266. <listitem>
  267. <para>
  268. <code>captureStart($id, array $params = array(), array $attribs = array())</code>:
  269. Beginnt die Erfassung von Inhalt um Ihn in einem Container einzufügen. <code>$params</code>
  270. referiert auf die Dijit Parameters die mit dem Container verwendet werden, wärend
  271. <code>$attribs</code> auf alle generellen HTML Attribute die verwendet werden, zeigt.
  272. </para>
  273. <para>
  274. Container können für die Erfassung gekoppelt werden, <emphasis>solange keine IDs
  275. doppelt vorhanden sind</emphasis>.
  276. </para>
  277. </listitem>
  278. <listitem>
  279. <para>
  280. <code>captureEnd($id)</code>: Beendet die Erfassung von Inhalten die in den Container
  281. übernommen werden. <code>$id</code> sollte auf eine Id zeigen die vorher bei dem
  282. Aufruf von <code>captureStart()</code> verwendet wurde. Gibt einen String zurück der
  283. den Container und seinen Inhalt repräsentiert, wie wenn man einfach den Inhalt an den
  284. Helfer selbst übergeben hätte.
  285. </para>
  286. </listitem>
  287. </itemizedlist>
  288. <example id="zend.dojo.view.dijit.layout.borderexample">
  289. <title>Beispiel eines BorderContainer Layout Dijits</title>
  290. <para>
  291. BorderContainers, speziell wenn Sie mit der Fähigkeit gekoppelt werden Inhalte zu erfassen,
  292. sind nützlich um komplexe Layouteffekte zu erhalten.
  293. </para>
  294. <programlisting role="php"><![CDATA[
  295. $view->borderContainer()->captureStart('masterLayout',
  296. array('design' => 'headline'));
  297. echo $view->contentPane(
  298. 'menuPane',
  299. 'Das ist der Menü Ausschnitt',
  300. array('region' => 'top'),
  301. array('style' => 'background-color: darkblue;')
  302. );
  303. echo $view->contentPane(
  304. 'navPane',
  305. 'Das ist der Navigations Ausschnitt',
  306. array('region' => 'left'),
  307. array('style' => 'width: 200px; background-color: lightblue;')
  308. );
  309. echo $view->contentPane(
  310. 'mainPane',
  311. 'Das ist der Hauptabschnitt',
  312. array('region' => 'center'),
  313. array('style' => 'background-color: white;')
  314. );
  315. echo $view->contentPane(
  316. 'statusPane',
  317. 'Status area',
  318. array('region' => 'bottom'),
  319. array('style' => 'background-color: lightgray;')
  320. );
  321. echo $view->borderContainer()->captureEnd('masterLayout');
  322. ]]></programlisting>
  323. </example>
  324. </sect3>
  325. <sect3 id="zend.dojo.view.dijit.form">
  326. <title>Dijit Formularelemente</title>
  327. <para>
  328. Dojo's Formularprüfung und Eingabe Dijits sind im dijit.form Baum. Für zusätzliche Informationen
  329. über die generelle Verwendung dieser Elemente, sowie der akzeptierten Parameter
  330. <ulink url="http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/form-validation-specialized-input">besuchen
  331. Sie bitte die dijit.form Dokumentation</ulink>.
  332. </para>
  333. <para>
  334. Die folgenden Dijit Formularelemente sind im Zend Framework vorhanden. Ausser wo es beschrieben
  335. wird, haben alle die Signatur
  336. <code>string ($id, $value = '', array $params = array(), array $attribs = array())</code>.
  337. </para>
  338. <itemizedlist>
  339. <listitem>
  340. <para>
  341. <emphasis>Button</emphasis>: dijit.form.Button. Zeigt einen Formular Button.
  342. </para>
  343. <programlisting role="php"><![CDATA[
  344. <?php echo $view->button(
  345. 'foo',
  346. 'Zeig mich!',
  347. array('iconClass' => 'myButtons'),
  348. ); ?>
  349. ]]></programlisting>
  350. </listitem>
  351. <listitem>
  352. <para>
  353. <emphasis>CheckBox</emphasis>: dijit.form.CheckBox. Zeigt eine Checkbox an. Akzeptiert
  354. ein optionales fünftes Argument, das Array <code>$checkedOptions</code>, welches das
  355. folgende enthalten kann:
  356. </para>
  357. <itemizedlist>
  358. <listitem><para>
  359. ein indiziertes Array mit zwei Werten, einen angehackten Wert und einem nicht
  360. angehackten Wert, in dieser Reihenfolge; oder
  361. </para></listitem>
  362. <listitem><para>
  363. ein assoziatives Array mit den Schnüsseln 'checkedValue' und 'unCheckedValue'.
  364. </para></listitem>
  365. </itemizedlist>
  366. <para>
  367. Wenn <code>$checkedOptions</code> nicht vorhanden ist, wird 1 und 0 angenommen.
  368. </para>
  369. <programlisting role="php"><![CDATA[
  370. <?php echo $view->checkBox(
  371. 'foo',
  372. 'bar',
  373. array(),
  374. array(),
  375. array('checkedValue' => 'foo', 'unCheckedValue' => 'bar')
  376. ); ?>
  377. ]]></programlisting>
  378. </listitem>
  379. <listitem>
  380. <para>
  381. <emphasis>ComboBox</emphasis>: dijit.layout.ComboBox. Komboboxen sind ein Hybrid zwischen
  382. einem Select und einer Textbox mit automatischer Vervollständigung. Der grundsätzliche
  383. Unterschied ist das man eine Option eingeben kann die nicht in der Liste der
  384. vorhandenen Optionen ist, und trotzdem eine gültige Eingabe angenommen wird. Sie akzeptiert
  385. ein optionales fünftes Argument, ein assoziatives Array <code>$options</code>; wenn es
  386. angegeben wird, wird ComboBox als <code>select</code> dargestellt. Es ist auch zu
  387. beachten das die verschiedenen <emphasis>Labelwerte</emphasis> des <code>$options</code>
  388. Arrays im Formular zurückgegeben werden -- nicht die Werte selbst.
  389. </para>
  390. <para>
  391. Alternativ kann eine Information übergeben werden die einen dojo.data Datenspeicher
  392. bezeichnet der mit diesem Element zu verwenden ist. Wenn er angegeben wird,
  393. wird die ComboBox als Texteingabe (<code>input</code>) dargestellt, und wird seine
  394. Optionen über den Datenspeicher holen.
  395. </para>
  396. <para>
  397. Um einen Datenspeicher zu spezifizieren, muß eine der folgenden <code>$params</code>
  398. Schlüsselkombinationen angegeben werden:
  399. </para>
  400. <itemizedlist>
  401. <listitem>
  402. <para>
  403. Der Schlüssel 'store' mit einem Arraywert; das Array sollte die folgenden
  404. Schlüssel enthalten:
  405. </para>
  406. <itemizedlist>
  407. <listitem><para>
  408. <emphasis>store</emphasis>: Der Name der Javascript Variable die den
  409. Datenspeicher repräsentiert (das könnte der Name sein den man für Ihn
  410. verwenden will).
  411. </para></listitem>
  412. <listitem><para>
  413. <emphasis>type</emphasis>: Der Typ des Datenspeichers der verwendet werden
  414. soll; z.B., 'dojo.data.ItemFileReadStore'.
  415. </para></listitem>
  416. <listitem><para>
  417. <emphasis>params</emphasis> (Optional): Ein assoziatives Array von
  418. Schlüssel/Werte Paaren die zu verwenden sind um den Datenspeicher zu
  419. konfigurieren. Der 'url' Parameter ist ein typisches Beispiel.
  420. </para></listitem>
  421. </itemizedlist>
  422. </listitem>
  423. <listitem>
  424. <para>
  425. Die Schlüssel:
  426. </para>
  427. <itemizedlist>
  428. <listitem><para>
  429. <emphasis>store</emphasis>: Ein String der den Namen des Datenspeicher zeigt
  430. der zu verwenden ist.
  431. </para></listitem>
  432. <listitem><para>
  433. <emphasis>storeType</emphasis>: Ein String der den dojo.data.type des
  434. Datenspeichers anzeigt der zu verwenden ist (z.B. 'dojo.data.ItemFileReadStore').
  435. </para></listitem>
  436. <listitem><para>
  437. <emphasis>storeParams</emphasis>: Ein assoziatives Array von
  438. Schlüssel/Wertepaaren mit denen der Datenspeicher konfiguriert wird.
  439. </para></listitem>
  440. </itemizedlist>
  441. </listitem>
  442. </itemizedlist>
  443. <programlisting role="php"><![CDATA[
  444. // Als Select Element:
  445. echo $view->comboBox(
  446. 'foo',
  447. 'bar',
  448. array(
  449. 'autocomplete' => false,
  450. ),
  451. array(),
  452. array(
  453. 'foo' => 'Foo',
  454. 'bar' => 'Bar',
  455. 'baz' => 'Baz',
  456. )
  457. );
  458. // Als dojo-aktiviertes Element:
  459. echo $view->comboBox(
  460. 'foo',
  461. 'bar',
  462. array(
  463. 'autocomplete' => false,
  464. 'store' => 'stateStore',
  465. 'storeType' => 'dojo.data.ItemFileReadStore',
  466. 'storeParams' => array('url' => '/js/states.json'),
  467. ),
  468. );
  469. ]]></programlisting>
  470. </listitem>
  471. <listitem>
  472. <para>
  473. <emphasis>CurrencyTextBox</emphasis>: dijit.form.CurrencyTextBox. Abgeleitet von
  474. ValidationTextBox, und bietet Clientseitige Prüfung von Wärgungen. Es erwartet das
  475. der Dijit Parameter 'currency' mit einem entsprechenden 3-zeichen Währungscode angegeben
  476. wird. Man kann auch anderen Dijit Parameter spezifizieren die für ValidationTextBox und
  477. TextBox gültig sind.
  478. </para>
  479. <programlisting role="php"><![CDATA[
  480. echo $view->currencyTextBox(
  481. 'foo',
  482. '$25.00',
  483. array('currency' => 'USD'),
  484. array('maxlength' => 20)
  485. );
  486. ]]></programlisting>
  487. <note>
  488. <title>Probleme mit Builds</title>
  489. <para>
  490. es gibt aktuell <ulink url="http://trac.dojotoolkit.org/ticket/7183">bekannte
  491. Probleme bei der Verwendung der CurrencyTextBox mit Build Layern</ulink>. Ein
  492. bekannter Work-Around ist sicherzustellen das das http-equiv Metatag des Content-Types
  493. des Dokument auf das Zeichenset utf-8 gestellt wird, was mit folgendem Aufruf gemacht
  494. wird:
  495. </para>
  496. <programlisting role="php"><![CDATA[
  497. $view->headMeta()->appendHttpEquiv('Content-Type',
  498. 'text/html; charset=utf-8');
  499. ]]></programlisting>
  500. <para>
  501. Das bedeutet natürlich, das man sicherstellen muß das der <code>headMeta()</code>
  502. Platzhalter im Layout Skript ausgegeben wird.
  503. </para>
  504. </note>
  505. </listitem>
  506. <listitem>
  507. <para>
  508. <emphasis>DateTextBox</emphasis>: dijit.form.DateTextBox. Wird von ValidationTextBox
  509. abgeleitet, und bietet sowohl Client-seitige Prüfungen von Daten, als auch einen
  510. Dropdown Kalender für die Auswahl von Daten. Man kann jeden Dijit Parameter spezifizieren
  511. der für ValidationTextBox oder TextBox vorhanden ist.
  512. </para>
  513. <programlisting role="php"><![CDATA[
  514. echo $view->dateTextBox(
  515. 'foo',
  516. '2008-07-11',
  517. array('required' => true)
  518. );
  519. ]]></programlisting>
  520. </listitem>
  521. <listitem>
  522. <para>
  523. <emphasis>Editor</emphasis>: dijit.Editor. Bietet einen WYSIGYG Editor über den
  524. Benutzer Inhalte erstellen oder bearbieten können. <code>dijit.Editor</code> ist ein
  525. pluginfähiger, erweiterbarer Editor mit einer Vielzahl an Parametern die für
  526. die Anpassung verwendet werden können; siehe
  527. <ulink url="http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/advanced-editing-and-display/editor-rich-text">
  528. in die dijit.Editor Dokumentation</ulink> für weitere Details.
  529. </para>
  530. <programlisting role="php"><![CDATA[
  531. echo $view->editor('foo');
  532. ]]></programlisting>
  533. </listitem>
  534. <listitem>
  535. <para>
  536. <emphasis>FilteringSelect</emphasis>: dijit.form.FilteringSelect. Wie die ComboBox ist das
  537. ein Select/Text Hybrid der entweder eine angegebenen Liste von Optionen darstellen kann,
  538. oder jene vom dojo.data Datenspeicher. Anders als ComboBox, erlaubt FilteringSelect keine
  539. Eingabe einer Option die nicht in seiner Liste vorhanden ist. Zusätzlich funktioniert es
  540. Sie ein Standatrd Select in dem die Optionswerte, nicht die Label, zurückgegeben werden
  541. wenn das Formular übertragen wird.
  542. </para>
  543. <para>
  544. Bitte beachten Sie die obigen Informationen über die ComboBox für Beispiele und
  545. mögliche Optionen für die Definition von Datenspeichern.
  546. </para>
  547. </listitem>
  548. <listitem>
  549. <para>
  550. <emphasis>HorizontalSlider</emphasis> und <emphasis>VerticalSlider</emphasis>:
  551. dijit.form.HorizontalSlider und dijit.form.VerticalSlider. Schieber sind UI Widgets für
  552. die Auswahl von Zahlen in einem gegebenen Bereich; es gibt eine horizontale und eine
  553. vertikale Variante.
  554. </para>
  555. <para>
  556. Grundsätzlich benötigen Sie die Dijit Parameter 'minimum', 'maximum' und 'discreteValues'.
  557. Diese definieren den Bereich der Werte. Andere übliche Optionen sind:
  558. </para>
  559. <itemizedlist>
  560. <listitem><para>
  561. 'intermediateChanges' kann gesetzt werden um zu zeigen ob ein onChange Event ausgelöst
  562. wird wenn der Gleiter genommen wird.
  563. </para></listitem>
  564. <listitem><para>
  565. 'clickSelect' kann gesetzt werden um das Klicken an einem Platz im Schieber zu erlauben
  566. um den Wert zu setzen.
  567. </para></listitem>
  568. <listitem><para>
  569. 'pageIncrement' kann den Wert spezifizieren mit dem addiert/subtrahiert wird wenn
  570. pageUp und pageDown verwendet werden.
  571. </para></listitem>
  572. <listitem><para>
  573. 'showButtons' kann gesetzt werden um die Darstellung von Buttons auf beiden Seiten
  574. des Schiebers, für die Veränderung des Wertes, zu erlauben.
  575. </para></listitem>
  576. </itemizedlist>
  577. <para>
  578. Die Zend Framework Implementation erstellt ein verstecktes Element um den Wert des
  579. Schiebers zu speichern.
  580. </para>
  581. <para>
  582. Optional kann es gewünscht sein einen Maßstab oder ein Label für den Gleiter zu zeigen.
  583. Um das zu tun, muß ein oder mehrere der Dijit Parameter 'topDecoration' und/oder
  584. 'bottomDecoration' (HorizontalSlider) oder 'leftDecoration' und/oder
  585. 'rightDecoration' (VerticalSlider) hinzufügen. Jede von Ihnen erwartet die folgenden
  586. Optionen:
  587. </para>
  588. <itemizedlist>
  589. <listitem><para>
  590. <emphasis>container</emphasis>: Der Name des Containers.
  591. </para></listitem>
  592. <listitem><para>
  593. <emphasis>labels</emphasis> (Optional): Ein Array von Labels das verwendet wird. Leere
  594. Strings können an beiden Seiten verwendet werden um Labels nur für die inneren Werte
  595. anzugeben. Wird benötigt wenn eine der 'Labels' Dijitvarianten spezifiziert wird.
  596. </para></listitem>
  597. <listitem><para>
  598. <emphasis>dijit</emphasis> (Optional): Entweder HorizontalRule, HorizontalRuleLabels,
  599. VerticalRule, oder VerticalRuleLabels, standardmäßig einer der Rule Dijits.
  600. </para></listitem>
  601. <listitem>
  602. <para>
  603. <emphasis>params</emphasis> (optional): Dijit Parameter für die Konfiguration des
  604. Rule Dijits das verwendet wird. Spezifische Parameter für diese Dijits sind:
  605. </para>
  606. <itemizedlist>
  607. <listitem><para>
  608. <emphasis>container</emphasis> (Optional): Ein Array von Parametern und
  609. Attributen für den Rule Container.
  610. </para></listitem>
  611. <listitem><para>
  612. <emphasis>labels</emphasis> (Optional): Ein Array von Parametern und
  613. Attributen für die Labels des Containers.
  614. </para></listitem>
  615. </itemizedlist>
  616. </listitem>
  617. <listitem><para>
  618. <emphasis>attribs</emphasis> (Optional): HTML Attribute die mit den Maßstäben/Labels
  619. verwendet werden. Diese sollten dem Format der <code>params</code> Option folgen und
  620. können ein assoziatives Array mit den Schlüsseln 'container' und 'labels' sein.
  621. </para></listitem>
  622. </itemizedlist>
  623. <programlisting role="php"><![CDATA[
  624. echo $view->horizontalSlider(
  625. 'foo',
  626. 1,
  627. array(
  628. 'minimum' => -10,
  629. 'maximum' => 10,
  630. 'discreteValues' => 11,
  631. 'intermediateChanges' => true,
  632. 'showButtons' => true,
  633. 'topDecoration' => array(
  634. 'container' => 'topContainer'
  635. 'dijit' => 'HorizontalRuleLabels',
  636. 'labels' => array(
  637. ' ',
  638. '20%',
  639. '40%',
  640. '60%',
  641. '80%',
  642. ' ',
  643. ),
  644. 'params' => array(
  645. 'container' => array(
  646. 'style' => 'height:1.2em; font-size=75%;color:gray;',
  647. ),
  648. 'labels' => array(
  649. 'style' => 'height:1em; font-size=75%;color:gray;',
  650. ),
  651. ),
  652. ),
  653. 'bottomDecoration' => array(
  654. 'container' => 'bottomContainer'
  655. 'labels' => array(
  656. '0%',
  657. '50%',
  658. '100%',
  659. ),
  660. 'params' => array(
  661. 'container' => array(
  662. 'style' => 'height:1.2em; font-size=75%;color:gray;',
  663. ),
  664. 'labels' => array(
  665. 'style' => 'height:1em; font-size=75%;color:gray;',
  666. ),
  667. ),
  668. ),
  669. )
  670. );
  671. ]]></programlisting>
  672. </listitem>
  673. <listitem>
  674. <para>
  675. <emphasis>NumberSpinner</emphasis>: dijit.form.NumberSpinner. Eine Textbox für nummerische
  676. Eingaben mit Buttons für das Inkrementieren und Dekrementieren.
  677. </para>
  678. <para>
  679. Erwartet entweder ein Assoziatives Array für den Dijit Parameter 'constraints', oder
  680. einfach die Schlüssel 'min', 'max' und 'places' (das würden auch die erwarteten Einträge
  681. des Constraints Parameters sein). 'places' kann verwendet werden um anzugeben um wieviel
  682. der NumberSpinner erhöht oder erniedrigt wird.
  683. </para>
  684. <programlisting role="php"><![CDATA[
  685. echo $view->numberSpinner(
  686. 'foo',
  687. 5,
  688. array(
  689. 'min' => -10,
  690. 'max' => 10,
  691. 'places' => 2,
  692. ),
  693. array(
  694. 'maxlenth' => 3,
  695. )
  696. );
  697. ]]></programlisting>
  698. </listitem>
  699. <listitem>
  700. <para>
  701. <emphasis>NumberTextBox</emphasis>: dijit.form.NumberTextBox. NumberTextBox bietet die
  702. Möglichkeit die Nummerneinträge auf lokalisiertem Weg zu formatieren und anzuzeigen, optional
  703. gegen angegebene Abhängigkeiten.
  704. </para>
  705. <programlisting role="php"><![CDATA[
  706. echo $view->numberTextBox(
  707. 'foo',
  708. 5,
  709. array(
  710. 'places' => 4,
  711. 'type' => 'percent',
  712. ),
  713. array(
  714. 'maxlength' => 20,
  715. )
  716. );
  717. ]]></programlisting>
  718. </listitem>
  719. <listitem>
  720. <para>
  721. <emphasis>PasswordTextBox</emphasis>: dijit.form.ValidationTextBox bindet eine
  722. Passworteingabe. PasswordTextBox bietet die Möglichkeit Passworteingaben zu erstellen
  723. die das aktuelle Dijitthema verwenden, sowie Clientseitige Prüfungen erlauben.
  724. </para>
  725. <programlisting role="php"><![CDATA[
  726. echo $view->passwordTextBox(
  727. 'foo',
  728. '',
  729. array(
  730. 'required' => true,
  731. ),
  732. array(
  733. 'maxlength' => 20,
  734. )
  735. );
  736. ]]></programlisting>
  737. </listitem>
  738. <listitem>
  739. <para>
  740. <emphasis>RadioButton</emphasis>: dijit.form.RadioButton. Ein Set von Optionen von denen
  741. nur eine ausgewählt werden kann. Dieses Verhalten entspricht auf jedem Tall dem normaler
  742. Radio Buttons, hat aber das Look-and-Feel das mit dem anderer Dijit konsistent ist.
  743. </para>
  744. <para>
  745. RadioButton akzeptiert ein optionales viertes Argument, <code>$options</code>, ein
  746. assoziatives Array von Werte/Label Paaren das als Radiooptionen verwendet wird. Diese
  747. können auch als <code>$attribs</code> Schlüssel <code>Optionen</code> angegeben werden.
  748. </para>
  749. <programlisting role="php"><![CDATA[
  750. echo $view->radioButton(
  751. 'foo',
  752. 'bar',
  753. array(),
  754. array(),
  755. array(
  756. 'foo' => 'Foo',
  757. 'bar' => 'Bar',
  758. 'baz' => 'Baz',
  759. )
  760. );
  761. ]]></programlisting>
  762. </listitem>
  763. <listitem>
  764. <para>
  765. <emphasis>SimpleTextarea</emphasis>: dijit.form.SimpleTextarea. Diese funktionieren
  766. wie normale Textareas, werden aber gestylt indem das aktuelle dijit Thema verwendet
  767. wird. Es müssen weder die rows noch die columns Attribute spezifiziert werden;
  768. verwende stattdessen <code>ems</code> oder Prozente für die Breite und Höhe.
  769. </para>
  770. <programlisting role="php"><![CDATA[
  771. echo $view->simpleTextarea(
  772. 'foo',
  773. 'Bitte ab hier schreiben...',
  774. array(),
  775. array('style' => 'width: 90%; height: 5ems;')
  776. );
  777. ]]></programlisting>
  778. </listitem>
  779. <listitem>
  780. <para>
  781. <emphasis>SubmitButton</emphasis>: Ein dijit.form.Button bindet ein Submit Eingabeelement.
  782. Siehe den Button Viewhelfer für weitere Details; der grundsätzliche Unterschied ist der,
  783. das dieser Button ein Formular übertragen kann.
  784. </para>
  785. </listitem>
  786. <listitem>
  787. <para>
  788. <emphasis>Textarea</emphasis>: dijit.form.Textarea. Diese funktionieren wie normale
  789. Textareas, ausgenommen das Sie statt dem Setzen einer Anzahl von Reihen als Benutzertypen
  790. expandieren. Die Breite sollte über Styleeinstellungen spezifiziert werden.
  791. </para>
  792. <programlisting role="php"><![CDATA[
  793. echo $view->textarea(
  794. 'foo',
  795. 'Start writing here...',
  796. array(),
  797. array('style' => 'width: 300px;')
  798. );
  799. ]]></programlisting>
  800. </listitem>
  801. <listitem>
  802. <para>
  803. <emphasis>TextBox</emphasis>: dijit.form.TextBox. Diese Element ist primär vorhanden um das
  804. übliche Look-and-Feel zwischen den verschiedenen Dijit Elementen zu bieten, und um
  805. die Basisfunktionalität der anderen von TextBox abgeleiteten Klassen (ValidationTextBox,
  806. NumberTextBox, CurrencyTextBox, DateTextBox, und TimeTextBox) zu bieten.
  807. </para>
  808. <para>
  809. Übliche Dijitparameter enthalten 'lowercase' (Casten auf kleinschreibung), 'uppercase'
  810. (Casten auf GROßSCHREIBUNG), 'propercase' (Casten auf ProperCase), und 'trim' (entferne
  811. führende und schließende Leerezeichen); alle akzeptieren boolsche Werte. Zusätzlich kann
  812. es gewünscht sein die Parameter 'size' und 'maxLength' zu spezifizieren.
  813. </para>
  814. <programlisting role="php"><![CDATA[
  815. echo $view->textBox(
  816. 'foo',
  817. 'Irgendein Text',
  818. array(
  819. 'trim' => true,
  820. 'propercase' => true,
  821. 'maxLength' => 20,
  822. ),
  823. array(
  824. 'size' => 20,
  825. )
  826. );
  827. ]]></programlisting>
  828. </listitem>
  829. <listitem>
  830. <para>
  831. <emphasis>TimeTextBox</emphasis>: dijit.form.TimeTextBox. Auch aus der TextBox Familie,
  832. bietet TimeTextBox eine Drop Down Auswahl für Zeiten die verschiebbar ist und die vom
  833. Benutzer ausgewählt werden kann. Dijit Parameter erlaubes es die Zeit zu spezifizieren
  834. die im Select vorhanden ist sowie auch den sichtbaren Bereich der Zeiten.
  835. </para>
  836. <programlisting role="php"><![CDATA[
  837. echo $view->timeTextBox(
  838. 'foo',
  839. '',
  840. array(
  841. 'am.pm' => true,
  842. 'visibleIncrement' => 'T00:05:00', // 5-Minuten addieren
  843. 'visibleRange' => 'T02:00:00', // Zeigt 2 Stunden die hinzugefügt werden können
  844. ),
  845. array(
  846. 'size' => 20,
  847. )
  848. );
  849. ]]></programlisting>
  850. </listitem>
  851. <listitem>
  852. <para>
  853. <emphasis>ValidationTextBox</emphasis>: dijit.form.ValidateTextBox. Bietet Client-seitige
  854. Prüfungen für Textelemente. Ist von TextBox abgeleitet.
  855. </para>
  856. <para>
  857. Übliche Dijit Parameter enthalten:
  858. </para>
  859. <itemizedlist>
  860. <listitem><para>
  861. <emphasis>invalidMessage</emphasis>: Eine Nachricht die angezeigt wird wenn eine
  862. ungültige Eingabe erkannt wurde.
  863. </para></listitem>
  864. <listitem><para>
  865. <emphasis>promptMessage</emphasis>: Eine Tooltip Hilfenachricht die verwendet wird.
  866. </para></listitem>
  867. <listitem><para>
  868. <emphasis>regExp</emphasis>: Ein regulärer Ausdruck der für die Prüfung des Textes
  869. verwendet wird. Reguläre Ausdrücke benötigen keine Begrenzungen.
  870. </para></listitem>
  871. <listitem><para>
  872. <emphasis>required</emphasis>: Ob das Element benötigt wird oder nicht. Wenn das der
  873. Fall ist, und das Element in einem dijit.form.Form eingebettet ist, wird es als
  874. ungültig markiert und die Übertragung verhindert.
  875. </para></listitem>
  876. </itemizedlist>
  877. <programlisting role="php"><![CDATA[
  878. echo $view->validationTextBox(
  879. 'foo',
  880. '',
  881. array(
  882. 'required' => true,
  883. 'regExp' => '[\w]+',
  884. 'invalidMessage' => 'Keine Leerzeichen oder nicht-Wort Zeichen erlaubt',
  885. 'promptMessage' => 'Nur ein einzelnes Wort das aus ' .
  886. 'alphanummerischen Zeichen und Unterstrichen besteht',
  887. ),
  888. array(
  889. 'maxlength' => 20,
  890. )
  891. );
  892. ]]></programlisting>
  893. </listitem>
  894. </itemizedlist>
  895. </sect3>
  896. <sect3 id="zend.dojo.view.dijit.custom">
  897. <title>Eigene Dijits</title>
  898. <para>
  899. Wenn man viel in Dojo herumtaucht, wird man sehr bald selbst eigene Dijits schreiben,
  900. oder experimentelle Dijits von Dojox verwenden. Wärend Zend Framework nicht jeden Dijit
  901. direkt unterstützen kann, bietet es einiges an direkter rudimentärer Unterstützung für
  902. jeden Dijit, und es bietet einiges an rudimentärer Unterstützung für beliebige Dijit
  903. Typen über den <code>CustomDijit</code> View Helfer.
  904. </para>
  905. <para>
  906. Die API des <code>CustomDijit</code> View Helfers ist genauso wie die jedes anderen
  907. Dijits, mit einem grundsätzlichen Unterschied: Das dritten "params" Argument
  908. <emphasis>muss</emphasis> das Attribut "dojotype" enthalten. Der Wert dieses Attributs
  909. sollte die Dijit Klasse sein die man verwenden will.
  910. </para>
  911. <para>
  912. <code>CustomDijit</code> erweitert den Basis <code>DijitContainer</code> View Helfer,
  913. welches er erlaubt Inhalte zu fangen (durch Verwendung der
  914. <code>captureStart()</code>/<code>captureEnd()</code> Methodenpaare).
  915. <code>captureStart()</code> erwartet auch das man das "dojoType" Attribut als sein
  916. "params" Argument übergibt.
  917. </para>
  918. <example id="zend.dojo.view.dijit.custom.example">
  919. <title>Verwendung von CustomDijit um ein dojox.layout.ContentPane darzustellen</title>
  920. <para>
  921. <code>dojox.layout.ContentPane</code> ist eine Next-Generation Erweiterung von
  922. <code>dijit.layout.ContentPane</code> und bietet ein Superset der Möglichkeiten
  923. dieser Klasse. Bis seine Funktionalitäten stabil sind, wird es weiterhin in Dojox
  924. leben. Wenn man es trotzdem im heutigen Zend Framework verwenden will, kann man
  925. den <code>CustomDijit</code> View Helfer verwenden.
  926. is a next-generation
  927. iteration of <code>dijit.layout.ContentPane</code>, and provides
  928. a superset of that class's capabilities. Until it's
  929. functionality stabilizes, it will continue to live in Dojox.
  930. However, if you want to use it in Zend Framework today, you can,
  931. using the <code>CustomDijit</code> view helper.
  932. </para>
  933. <para>
  934. Grundsätzlich kann man das folgende tun:
  935. </para>
  936. <programlisting role="php"><![CDATA[
  937. <?php echo $this->customDijit(
  938. 'foo',
  939. $content,
  940. array(
  941. 'dojoType' => 'dojox.layout.ContentPane',
  942. 'title' => 'Eigene Ebene',
  943. 'region' => 'center'
  944. )
  945. ); ?>
  946. ]]></programlisting>
  947. <para>
  948. Wenn man stattdessen Inhalte fangen will, sollte einfach die
  949. <code>captureStart()</code> Methode verwendet, und der "dojoType" als "params"
  950. Argument übergeben werden:
  951. </para>
  952. <programlisting role="php"><![CDATA[
  953. <?php $this->customDijit()->captureStart(
  954. 'foo',
  955. array(
  956. 'dojoType' => 'dojox.layout.ContentPane',
  957. 'title' => 'Eigene Ebene',
  958. 'region' => 'center'
  959. )
  960. ); ?>
  961. Das ist der Inhalt der Ebene
  962. <?php echo $this->customDijit()->captureEnd('foo'); ?>
  963. ]]></programlisting>
  964. <para>
  965. Man kann <code>CustomDijit</code> auch einfach erweitern um Unterstützung für
  966. eigene Dijits zu bieten. Wenn man, als Beispiel,
  967. <code>dijit.layout.ContentPane</code> erweitern will um eine eigene
  968. <code>foo.ContentPane</code> Klasse zu erstellen, kann man den folgenden Helfer
  969. erstellen um Ihn zu unterstützen:
  970. </para>
  971. <programlisting role="php"><![CDATA[
  972. class My_View_Helper_FooContentPane
  973. extends Zend_Dojo_View_Helper_CustomDijit
  974. {
  975. protected $_defaultDojoType = 'foo.ContentPane';
  976. public function fooContentPane(
  977. $id = null, $value = null,
  978. array $params = array(), array $attribs = array()
  979. ) {
  980. return $this->customDijit($id, $value, $params, $attribs);
  981. }
  982. }
  983. ]]></programlisting>
  984. <para>
  985. Solange der eigene Dijit der gleichen grundsätzlichen API wie offizielle Dijits
  986. folgt, sollte die Verwendung oder Erweiterung von <code>CustomDijit</code> korrekt
  987. funktionieren.
  988. </para>
  989. </example>
  990. </sect3>
  991. </sect2>
  992. <!--
  993. vim:se ts=4 sw=4 et:
  994. -->