Zend_Dojo-View-Helpers.xml 45 KB

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