Zend_Dojo-Form-Elements.xml 65 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 20176 -->
  3. <!-- Reviewed: no -->
  4. <sect2 id="zend.dojo.form.elements">
  5. <title>Dijit-Specifische Fomularelemente</title>
  6. <para>
  7. Jedes Formular-Dijit für welches ein Viewhelfer vorhanden ist hat ein korrespondierendes
  8. <classname>Zend_Form</classname> Element. Alle von Ihnen bieten die folgenden Methoden für
  9. die Manipulation von Dijit Parametern an:
  10. </para>
  11. <itemizedlist>
  12. <listitem>
  13. <para>
  14. <methodname>setDijitParam($key, $value)</methodname>: Setzt einen einzelnen Dijit
  15. Parameter. Wenn der Dijit Parmeter bereits existiert wird er überschrieben.
  16. </para>
  17. </listitem>
  18. <listitem>
  19. <para>
  20. <methodname>setDijitParams(array $params)</methodname>: Setzt mehrere Dijit
  21. Parameter auf einmal. Jeder übergebene Parameter der bereits existierenden
  22. entspricht wird überschrieben.
  23. </para>
  24. </listitem>
  25. <listitem>
  26. <para>
  27. <methodname>hasDijitParam($key)</methodname>: Wenn ein angegebener Dijit Parameter
  28. definiert und vorhanden ist, wird <constant>TRUE</constant> zurückgegeben,
  29. andernfalls <constant>FALSE</constant>.
  30. </para>
  31. </listitem>
  32. <listitem>
  33. <para>
  34. <methodname>getDijitParam($key)</methodname>: Gibt den angegebenen Dijit Parameter.
  35. Wenn er nicht vorhanden ist, wird ein <constant>NULL</constant> Wert zurückgegeben.
  36. </para>
  37. </listitem>
  38. <listitem>
  39. <para>
  40. <methodname>getDijitParams()</methodname>: Gibt alle Dijit Parameter zurück.
  41. </para>
  42. </listitem>
  43. <listitem>
  44. <para>
  45. <methodname>removeDijitParam($key)</methodname>: Entfernt den angegebenen Dijit
  46. Parameter.
  47. </para>
  48. </listitem>
  49. <listitem>
  50. <para>
  51. <methodname>clearDijitParams()</methodname>: Löscht alle aktuell definierten Dijit
  52. Parameter.
  53. </para>
  54. </listitem>
  55. </itemizedlist>
  56. <para>
  57. Dijit Parameter werden in der öffentlichen <property>dijitParams</property> Eigenschaft
  58. gespeichert. Deshalb kann ein existierendes Formularelement einfach dijit-aktiviert werden
  59. indem diese Eigenschaft auf dem Element gesetzt wird; man hat in diesem Fall nur nicht die
  60. Zugriffsmethoden um die Parameter zu manipulieren.
  61. </para>
  62. <para>
  63. Zusätzlich implementieren Dijit-spezifische Element eine andere Liste von Dekoratoren, die
  64. dem folgenden entsprechen:
  65. </para>
  66. <programlisting language="php"><![CDATA[
  67. $element->addDecorator('DijitElement')
  68. ->addDecorator('Errors')
  69. ->addDecorator('HtmlTag', array('tag' => 'dd'))
  70. ->addDecorator('Label', array('tag' => 'dt'));
  71. ]]></programlisting>
  72. <para>
  73. Effektiv wird der DijitElement Dekorator statt dem standardmäßigen ViewHelper Dekorator
  74. verwendet.
  75. </para>
  76. <para>
  77. Letztendlich stellt das Basis-Dijitelement sicher das der Dojo Viewhelfer Pfad in der View
  78. gesetzt ist.
  79. </para>
  80. <para>
  81. Eine Variante von DijitElement, DijitMulti, bietet die Funktionalität des abstrakten
  82. <classname>Multi</classname> Formularelements, das es Entwicklern erlaubt 'multiOptions' zu
  83. spezifizieren -- typischerweise Select-Optionen oder Radio-Optionen.
  84. </para>
  85. <para>
  86. Die folgenden Dijitelemente werden in der standardmäßigen Zend Framework Distribution
  87. ausgeliefert.
  88. </para>
  89. <sect3 id="zend.dojo.form.elements.button">
  90. <title>Button</title>
  91. <para>
  92. Wärend es nicht vom <link linkend="zend.form.standardElements.button">standardmäßigen
  93. Button Element</link> abgeleitet ist, implementiert es die gleiche Funktionalität, und
  94. kann als Drop-In Ersatz hierfür verwendet werden. Die folgende Funktionalität wird zur
  95. Verfügung gestellt:
  96. </para>
  97. <itemizedlist>
  98. <listitem>
  99. <para>
  100. <methodname>getLabel()</methodname> verwendet den Elementnamen als Label für
  101. den Button wenn kein Name angegeben wurde. Zusätzlich übersetzt es den Namen
  102. wenn ein Übersetzungsadapter mit einer passenden übersetzten Meldung vorhanden
  103. ist.
  104. </para>
  105. </listitem>
  106. <listitem>
  107. <para>
  108. <methodname>isChecked()</methodname> ermittelt ob der übermittelte Wert zum
  109. Label passt; wenn das der Fall ist wird <constant>TRUE</constant>
  110. zurückgegeben. Das ist für die Erkennung, welcher Button verwendet wurde als
  111. das Formular übermittelt wurde, nützlich.
  112. </para>
  113. </listitem>
  114. </itemizedlist>
  115. <para>
  116. Zusätzlich werden nur die Dekoratore <classname>DijitElement</classname> und
  117. <classname>DtDdWrapper</classname> für Buttonelemente benutzt.
  118. </para>
  119. <example id="zend.dojo.form.elements.button.example">
  120. <title>Beispiel für die Verwendung des Button Dijit Elements</title>
  121. <programlisting language="php"><![CDATA[
  122. $form->addElement(
  123. 'Button',
  124. 'foo',
  125. array(
  126. 'label' => 'Button Label',
  127. )
  128. );
  129. ]]></programlisting>
  130. </example>
  131. </sect3>
  132. <sect3 id="zend.dojo.form.elements.checkBox">
  133. <title>CheckBox</title>
  134. <para>
  135. Wärend es nicht vom <link linkend="zend.form.standardElements.checkbox">standardmäßigen
  136. Checkbox Element</link> abgeleitet ist, implementiert es die gleiche Funktionalität. Das
  137. bedeutet das die folgenden Methoden zur Verfügung gestellt werden:
  138. </para>
  139. <itemizedlist>
  140. <listitem>
  141. <para>
  142. <methodname>setCheckedValue($value)</methodname>: Setzt den Wert der verwendet
  143. werden soll wenn das Element angehakt ist.
  144. </para>
  145. </listitem>
  146. <listitem>
  147. <para>
  148. <methodname>getCheckedValue()</methodname>: Gibt den Wert des Elements zurück
  149. der verwendet wird wenn das Element angehakt ist.
  150. </para>
  151. </listitem>
  152. <listitem>
  153. <para>
  154. <methodname>setUncheckedValue($value)</methodname>: Setzt den Wert des Elements
  155. der verwendet wird wenn das Element nicht angehakt ist.
  156. </para>
  157. </listitem>
  158. <listitem>
  159. <para>
  160. <methodname>getUncheckedValue()</methodname>: Gibt den Wert des Elements zurück
  161. der verwendet wird wenn das Element nicht angehakt ist.
  162. </para>
  163. </listitem>
  164. <listitem>
  165. <para>
  166. <methodname>setChecked($flag)</methodname>: Markiert das Element als angehakt
  167. oder nicht angehakt.
  168. </para>
  169. </listitem>
  170. <listitem>
  171. <para>
  172. <methodname>isChecked()</methodname>: Ermittelt ob das Element aktuell angehakt
  173. ist.
  174. </para>
  175. </listitem>
  176. </itemizedlist>
  177. <example id="zend.dojo.form.elements.checkBox.example">
  178. <title>Beispiel für die Verwendung des CheckBox Dijit Elements</title>
  179. <programlisting language="php"><![CDATA[
  180. $form->addElement(
  181. 'CheckBox',
  182. 'foo',
  183. array(
  184. 'label' => 'Eine Checkbox',
  185. 'checkedValue' => 'foo',
  186. 'uncheckedValue' => 'bar',
  187. 'checked' => true,
  188. )
  189. );
  190. ]]></programlisting>
  191. </example>
  192. </sect3>
  193. <sect3 id="zend.dojo.form.elements.comboBox">
  194. <title>ComboBox und FilteringSelect</title>
  195. <para>
  196. Wie in der ComboBox
  197. <link linkend="zend.dojo.view.dijit.form">Dijit Viewhelfer Dokumentation</link>
  198. beschrieben, sind Comboboxen ein Hybrid zwischen Select und Texteingaben, erlauben
  199. automatische Vervollständigung und die Fähigkeit eine Alternative zu den angebotenen
  200. Optionen zu spezifizieren. FilteringSelects sind genauso, nur erlauben Sie keine eigenen
  201. Eingaben.
  202. </para>
  203. <note>
  204. <title>ComboBoxen geben die Labelwerte zurück</title>
  205. <para>
  206. ComboBoxen geben die Labelwerte, und nicht die Werte der Option zurück, was zu einem
  207. Problem bei den Annahmen führen kann. Aus diesem Grund registieren Sie die
  208. <classname>InArray</classname> Prüfung nicht automatisch (obwohl FilteringSelects
  209. das macht).
  210. </para>
  211. </note>
  212. <para>
  213. Das ComboBox und FilteringSelect Formularelemente bietet Zugriffsmethoden und Mutatoren
  214. für das Ermitteln und Setzen von Selectoptionen sowie das Spezifizieren des dojo.data
  215. Datenspeichers (wenn er verwendet wird). Sie erweitern DijitMulti, welches es erlaubt
  216. Selectoptionen über die Methoden <methodname>setMultiOptions()</methodname> und
  217. <methodname>setMultiOption()</methodname> zu spezifizieren. Zusätzlich stehen die
  218. folgenden Methoden zur Verfügung:
  219. </para>
  220. <itemizedlist>
  221. <listitem>
  222. <para>
  223. <methodname>getStoreInfo()</methodname>: Gibt alle aktuell gesetzten
  224. Informationen des Datenspeichers zurück. Gibt ein leeres Array zurück wenn
  225. aktuell keine Daten gesetzt sind.
  226. </para>
  227. </listitem>
  228. <listitem>
  229. <para>
  230. <methodname>setStoreId($identifier)</methodname>: Setzt die
  231. Identifikatorvariable des Speichers (normalerweise wird darauf durch das
  232. Attribut 'jsId' in Dojo referiert). Das sollte ein gültiger Name für eine
  233. Javascriptvariable sein.
  234. </para>
  235. </listitem>
  236. <listitem>
  237. <para>
  238. <methodname>getStoreId()</methodname>: Gibt den Namen der Identifikatorvariable
  239. des Speichers zurück.
  240. </para>
  241. </listitem>
  242. <listitem>
  243. <para>
  244. <methodname>setStoreType($dojoType)</methodname>: Setzt die Datenspeicherklasse
  245. die verwendet werden soll; z.B., "dojo.data.ItemFileReadStore".
  246. </para>
  247. </listitem>
  248. <listitem>
  249. <para>
  250. <methodname>getStoreType()</methodname>: Gibt die Dojo Datenspeicherklasse
  251. zurück die verwendet werden soll.
  252. </para>
  253. </listitem>
  254. <listitem>
  255. <para>
  256. <methodname>setStoreParams(array $params)</methodname>: Setzt jeden verwendeten
  257. Parameter um das Datenspeicherobjekt zu konfigurieren. Als Beispiel würde der
  258. dojo.data.ItemFileReadStore Datenspeicher einen 'url' Parameter erwarten der
  259. auf einen Ort zeigt der das dojo.data Objekt zurückgibt.
  260. </para>
  261. </listitem>
  262. <listitem>
  263. <para>
  264. <methodname>getStoreParams()</methodname>: Gibt alle aktuell gesetzten
  265. Datenspeicher Parameter zurück; wenn keiner gesetzt ist, wird ein leeres Array
  266. zurückgegeben.
  267. </para>
  268. </listitem>
  269. <listitem>
  270. <para>
  271. <methodname>setAutocomplete($flag)</methodname>: Zeigt ob das selektierte
  272. Element verwendet wird oder nicht wenn der Benutzer das Element verlässt.
  273. </para>
  274. </listitem>
  275. <listitem>
  276. <para>
  277. <methodname>getAutocomplete()</methodname>: Gibt den Wert des autocomplete
  278. Flags zurück.
  279. </para>
  280. </listitem>
  281. </itemizedlist>
  282. <para>
  283. Standardmäßig, wenn kein dojo.data Speicher im Element registriert wurde, registriert
  284. dieses Element eine <classname>InArray</classname> Prüfung welche die Arrayschlüssel
  285. gegen registrierte Optionen prüft. Dieses Verhalten kann deaktiviert werden indem
  286. entweder <methodname>setRegisterInArrayValidator(false)</methodname> ausgerufen, oder
  287. ein <constant>FALSE</constant> Wert an den Registrierungsschlüssel
  288. <property>registerInArrayValidator</property> übergeben wird.
  289. </para>
  290. <example id="zend.dojo.form.elements.comboBox.selectExample">
  291. <title>Das ComboBox Dijit Element als Select Eingabe verwenden</title>
  292. <programlisting language="php"><![CDATA[
  293. $form->addElement(
  294. 'ComboBox',
  295. 'foo',
  296. array(
  297. 'label' => 'ComboBox (select)',
  298. 'value' => 'blue',
  299. 'autocomplete' => false,
  300. 'multiOptions' => array(
  301. 'red' => 'Rouge',
  302. 'blue' => 'Bleu',
  303. 'white' => 'Blanc',
  304. 'orange' => 'Orange',
  305. 'black' => 'Noir',
  306. 'green' => 'Vert',
  307. ),
  308. )
  309. );
  310. ]]></programlisting>
  311. </example>
  312. <example id="zend.dojo.form.elements.comboBox.datastoreExample">
  313. <title>Das ComboBox Dijit Element mit einem Datenspeicher verwenden</title>
  314. <programlisting language="php"><![CDATA[
  315. $form->addElement(
  316. 'ComboBox',
  317. 'foo',
  318. array(
  319. 'label' => 'ComboBox (datastore)',
  320. 'storeId' => 'stateStore',
  321. 'storeType' => 'dojo.data.ItemFileReadStore',
  322. 'storeParams' => array(
  323. 'url' => '/js/states.txt',
  324. ),
  325. 'dijitParams' => array(
  326. 'searchAttr' => 'name',
  327. ),
  328. )
  329. );
  330. ]]></programlisting>
  331. </example>
  332. <para>
  333. Das obige Beispiel könnte auch <classname>FilteringSelect</classname> statt
  334. <classname>ComboBox</classname> verwenden.
  335. </para>
  336. </sect3>
  337. <sect3 id="zend.dojo.form.elements.currencyTextBox">
  338. <title>CurrencyTextBox</title>
  339. <para>
  340. Die CurrencyTextBox ist primär für die Unterstützung von Währungseingaben. Die Währung
  341. kann lokalisiert werden, und unterstützt sowohl Kommazahlen als auch ganze Zahlen.
  342. </para>
  343. <para>
  344. Intern ist die CurrencyTextBox abgeleitet von
  345. <link linkend="zend.dojo.form.elements.numberTextBox">NumberTextBox</link>,
  346. <link linkend="zend.dojo.form.elements.validationTextBox">ValidationTextBox</link>,
  347. und <link linkend="zend.dojo.form.elements.textBox">TextBox</link>; alle vorhandenen
  348. Methoden dieser Klassen sind vorhanden. Zusätzlich können die folgenden bedingten
  349. Methoden verwendet werden:
  350. </para>
  351. <itemizedlist>
  352. <listitem>
  353. <para>
  354. <methodname>setCurrency($currency)</methodname>: Setzt den Typ der Währung die
  355. verwendet werden soll; sollte der
  356. <ulink url="http://en.wikipedia.org/wiki/ISO_4217">ISO-4217</ulink>
  357. Spezifikation folgen.
  358. </para>
  359. </listitem>
  360. <listitem>
  361. <para>
  362. <methodname>getCurrency()</methodname>: Gibt den aktuellen Währungstyp zurück.
  363. </para>
  364. </listitem>
  365. <listitem>
  366. <para>
  367. <methodname>setSymbol($symbol)</methodname>: Setzt das 3-buchstabige
  368. <ulink url="http://en.wikipedia.org/wiki/ISO_4217">ISO-4217</ulink> Symbol der
  369. Währung das verwendet werden soll.
  370. </para>
  371. </listitem>
  372. <listitem>
  373. <para>
  374. <methodname>getSymbol()</methodname>: Gibt das aktuelle Währungssymbol zurück.
  375. </para>
  376. </listitem>
  377. <listitem>
  378. <para>
  379. <methodname>setFractional($flag)</methodname>: Setzt ob für die Währung
  380. Kommazahlen oder ganze Zahlen verwendet werden dürfen.
  381. </para>
  382. </listitem>
  383. <listitem>
  384. <para>
  385. <methodname>getFractional()</methodname>: Gibt den Status des Kommazahlen Flags
  386. zurück.
  387. </para>
  388. </listitem>
  389. </itemizedlist>
  390. <example id="zend.dojo.form.elements.currencyTextBox.example">
  391. <title>Beispiel für die Verwendung des CurrencyTextBox Dijit Elements</title>
  392. <programlisting language="php"><![CDATA[
  393. $form->addElement(
  394. 'CurrencyTextBox',
  395. 'foo',
  396. array(
  397. 'label' => 'Währung:',
  398. 'required' => true,
  399. 'currency' => 'USD',
  400. 'invalidMessage' => 'Ungültiger Wert. Es müssen das Dollarzeichen, ' .
  401. 'ein Komma und Cents enthalten sein.',
  402. 'fractional' => false,
  403. )
  404. );
  405. ]]></programlisting>
  406. </example>
  407. </sect3>
  408. <sect3 id="zend.dojo.form.elements.dateTextBox">
  409. <title>DateTextBox</title>
  410. <para>
  411. DateTextBox bietet einen Kalender Drop-Down für die Auswahl eines Datums, sowie einer
  412. Clientseitigen Überprüfung und Formatierung.
  413. </para>
  414. <para>
  415. Intern ist DateTextBox abgeleitet von
  416. <link linkend="zend.dojo.form.elements.validationTextBox">ValidationTextBox</link> und
  417. <link linkend="zend.dojo.form.elements.textBox">TextBox</link>; alle vorhandenen
  418. Methoden dieser Klassen sind vorhanden. Zusätzlich können die folgenden Methoden
  419. verwendet werden um individuelle Abhängigkeiten zu setzen:
  420. </para>
  421. <itemizedlist>
  422. <listitem>
  423. <para>
  424. <methodname>setAmPm($flag)</methodname> and <methodname>getAmPm()</methodname>:
  425. Ob in der Zeit AM/PM Strings verwendet werden sollen oder nicht.
  426. </para>
  427. </listitem>
  428. <listitem>
  429. <para>
  430. <methodname>setStrict($flag)</methodname> und
  431. <methodname>getStrict()</methodname>: Ob Reguläre Ausdrücke strikt passen
  432. müssen oder nicht. Wenn es <constant>FALSE</constant> ist, was der Standardwert
  433. ist, wird es nicht über Leerzeichen und einige Abkürzungen lamentieren.
  434. </para>
  435. </listitem>
  436. <listitem>
  437. <para>
  438. <methodname>setLocale($locale)</methodname> und
  439. <methodname>getLocale()</methodname>: Setzt und gibt die
  440. Locale zurück die mit diesem speziellen Element verwendet werden soll.
  441. </para>
  442. </listitem>
  443. <listitem>
  444. <para>
  445. <methodname>setDatePattern($pattern)</methodname> und
  446. <methodname>getDatePattern()</methodname>: Bietet und gibt den
  447. <ulink url="http://www.unicode.org/reports/tr35/#Date_Format_Patterns">Unicode
  448. Pattern des Datumsformats</ulink> für die Formatierung des Datums zurück.
  449. </para>
  450. </listitem>
  451. <listitem>
  452. <para>
  453. <methodname>setFormatLength($formatLength)</methodname> und
  454. <methodname>getFormatLength()</methodname>: Bietet und gibt den Formatlänge Typ
  455. der verwendet werden soll zurück; sollte "long", "short", "medium" oder "full"
  456. sein.
  457. </para>
  458. </listitem>
  459. <listitem>
  460. <para>
  461. <methodname>setSelector($selector)</methodname> und
  462. <methodname>getSelector()</methodname>: Bietet und gibt den Stil des Selektors
  463. zurück; sollte entweder "date" oder "time" sein.
  464. </para>
  465. </listitem>
  466. </itemizedlist>
  467. <example id="zend.dojo.form.elements.dateTextBox.example">
  468. <title>Beispiel der Verwendung des DateTextBox Dijit Elements</title>
  469. <programlisting language="php"><![CDATA[
  470. $form->addElement(
  471. 'DateTextBox',
  472. 'foo',
  473. array(
  474. 'label' => 'Datum:',
  475. 'required' => true,
  476. 'invalidMessage' => 'Ungültiges Datum spezifiziert.',
  477. 'formatLength' => 'long',
  478. )
  479. );
  480. ]]></programlisting>
  481. </example>
  482. </sect3>
  483. <sect3 id="zend.dojo.form.elements.editor">
  484. <title>Editor</title>
  485. <para>
  486. Editor bietet einen WYSIWYG Editor der verwendet werden kann um Rich HTML Inhalte sowohl
  487. zu erstellen als auch zu bearbeiten. dijit.Editor ist pluggable und kann mit eigenen
  488. Plugins erweitert werden wenn das gewünscht ist; siehe
  489. <ulink url="http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/advanced-editing-and-display/editor-rich-text">
  490. die dijit.Editor Dokumentation</ulink> für weitere Details.
  491. </para>
  492. <para>
  493. Das Editor Form Element bietet eine Anzahl an Zugriffsmethoden und Mutatoren für die
  494. Manipulation der verschiedenen dijit Paramter, wie folgt:
  495. </para>
  496. <itemizedlist>
  497. <listitem>
  498. <para>
  499. <emphasis>captureEvents</emphasis> sind Events die auf die Bearbeitungsfläche
  500. selbst verbinden. Die folgenden Zugriffsmethoden und Mutatoren sind für die
  501. Manipulation von Capture Events vorhanden:
  502. </para>
  503. <itemizedlist>
  504. <listitem>
  505. <para><methodname>addCaptureEvent($event)</methodname></para>
  506. </listitem>
  507. <listitem>
  508. <para><methodname>addCaptureEvents(array $events)</methodname></para>
  509. </listitem>
  510. <listitem>
  511. <para><methodname>setCaptureEvents(array $events)</methodname></para>
  512. </listitem>
  513. <listitem><para><methodname>getCaptureEvents()</methodname></para></listitem>
  514. <listitem>
  515. <para><methodname>hasCaptureEvent($event)</methodname></para>
  516. </listitem>
  517. <listitem>
  518. <para><methodname>removeCaptureEvent($event)</methodname></para>
  519. </listitem>
  520. <listitem>
  521. <para><methodname>clearCaptureEvents()</methodname></para>
  522. </listitem>
  523. </itemizedlist>
  524. </listitem>
  525. <listitem>
  526. <para>
  527. <emphasis>events</emphasis> sind Standard DOM Events, wie onClick, onKeyUp, usw.
  528. Die folgenden Zugriffsmethoden und Mutatoren sind für die Manipulation von
  529. Events vorhanden:
  530. </para>
  531. <itemizedlist>
  532. <listitem>
  533. <para><methodname>addEvent($event)</methodname></para>
  534. </listitem>
  535. <listitem>
  536. <para><methodname>addEvents(array $events)</methodname></para>
  537. </listitem>
  538. <listitem>
  539. <para><methodname>setEvents(array $events)</methodname></para>
  540. </listitem>
  541. <listitem><para><methodname>getEvents()</methodname></para></listitem>
  542. <listitem>
  543. <para><methodname>hasEvent($event)</methodname></para>
  544. </listitem>
  545. <listitem><para><methodname>removeEvent($event)</methodname></para></listitem>
  546. <listitem>
  547. <para><methodname>clearEvents()</methodname></para>
  548. </listitem>
  549. </itemizedlist>
  550. </listitem>
  551. <listitem>
  552. <para>
  553. <emphasis>plugins</emphasis> fügen dem Editor Funktionalitäten hinzu --
  554. zusätzliche Tools für die Toolbar, zusätzliche erlaubte Stile, usw. Die
  555. folgenden Zugriffsmethoden und Mutatoren sind für die Manipulation von Plugins
  556. vorhanden:
  557. </para>
  558. <itemizedlist>
  559. <listitem>
  560. <para><methodname>addPlugin($plugin)</methodname></para>
  561. </listitem>
  562. <listitem>
  563. <para><methodname>addPlugins(array $plugins)</methodname></para>
  564. </listitem>
  565. <listitem>
  566. <para><methodname>setPlugins(array $plugins)</methodname></para>
  567. </listitem>
  568. <listitem><para><methodname>getPlugins()</methodname></para></listitem>
  569. <listitem>
  570. <para><methodname>hasPlugin($plugin)</methodname></para>
  571. </listitem>
  572. <listitem>
  573. <para><methodname>removePlugin($plugin)</methodname></para>
  574. </listitem>
  575. <listitem>
  576. <para><methodname>clearPlugins()</methodname></para>
  577. </listitem>
  578. </itemizedlist>
  579. </listitem>
  580. <listitem>
  581. <para>
  582. <emphasis>editActionInterval</emphasis> wird verwendet um Events für die Undo
  583. Operationen zu gruppieren. Standardmäßig ist dieser Wert 3 Sekunden. Die
  584. Methode <methodname>setEditActionInterval($interval)</methodname> kann
  585. verwendet werden um den Wert zu setzen, wärend
  586. <methodname>getEditActionInterval()</methodname> ihn zurückgibt.
  587. </para>
  588. </listitem>
  589. <listitem>
  590. <para>
  591. <emphasis>focusOnLoad</emphasis> wird verwendet um zu erkennen ob dieser
  592. spezielle Editor den Fokus erhält wenn die Seite geladen wurde. Standardmäßig
  593. ist er <constant>FALSE</constant>. Die Methode
  594. <methodname>setFocusOnLoad($flag)</methodname> kann verwendet werden um den
  595. Wert zu setzen, wärend <methodname>getFocusOnLoad()</methodname> ihn empfängt.
  596. </para>
  597. </listitem>
  598. <listitem>
  599. <para>
  600. <emphasis>height</emphasis> spezifiziert die Höhe des Editors; standardmäßig
  601. ist sie 300px. Die Methode <methodname>setHeight($height)</methodname> kann
  602. verwendet werden um den Wert zu setzen, wärend
  603. <methodname>getHeight()</methodname> ihn zurückgibt.
  604. </para>
  605. </listitem>
  606. <listitem>
  607. <para>
  608. <emphasis>inheritWidth</emphasis> wird verwendet um zu erkennen ob der Editor
  609. die Breite des Parent Containers verwendet, oder einfach auf 100% Höhe.
  610. Standardmäßig ist er <constant>FALSE</constant> (im Normalfall wird der die
  611. Breite des Fensters ausfüllen). Die Methode
  612. <methodname>setInheritWidth($flag)</methodname> kann verwendet werden um den
  613. Wert zu setzen, wärend <methodname>getInheritWidth()</methodname> ihn
  614. zurückgibt.
  615. </para>
  616. </listitem>
  617. <listitem>
  618. <para>
  619. <emphasis>minHeight</emphasis> zeigt die Mindesthöhe des Editors an;
  620. standardmäßig ist sie 1em. Die Methode
  621. <methodname>setMinHeight($height)</methodname> kann verwendet werden um den
  622. Wert zu setzen, wärend <methodname>getMinHeight()</methodname> ihn empfängt.
  623. </para>
  624. </listitem>
  625. <listitem>
  626. <para>
  627. <emphasis>styleSheets</emphasis> zeigt an welche zusätzlichen
  628. <acronym>CSS</acronym> Stylesheets verwendet werden sollen um die Anzeige des
  629. Editors zu beeinflussen. Standardmäßig sind keine registriert, und es verwendet
  630. die Seitenstile. Die folgenden Zugriffsmethoden und Mutatoren sind für die
  631. Manipulation von Editor Stylesheets vorhanden:
  632. </para>
  633. <itemizedlist>
  634. <listitem>
  635. <para><methodname>addStyleSheet($styleSheet)</methodname></para>
  636. </listitem>
  637. <listitem>
  638. <para><methodname>addStyleSheets(array $styleSheets)</methodname></para>
  639. </listitem>
  640. <listitem>
  641. <para><methodname>setStyleSheets(array $styleSheets)</methodname></para>
  642. </listitem>
  643. <listitem><para><methodname>getStyleSheets()</methodname></para></listitem>
  644. <listitem>
  645. <para><methodname>hasStyleSheet($styleSheet)</methodname></para>
  646. </listitem>
  647. <listitem>
  648. <para><methodname>removeStyleSheet($styleSheet)</methodname></para>
  649. </listitem>
  650. <listitem>
  651. <para><methodname>clearStyleSheets()</methodname></para>
  652. </listitem>
  653. </itemizedlist>
  654. </listitem>
  655. </itemizedlist>
  656. <example id="zend.dojo.form.elements.editor.example">
  657. <title>Beispiel der Verwendung des Editor dijit Elements</title>
  658. <programlisting language="php"><![CDATA[
  659. $form->addElement('editor', 'content', array(
  660. 'plugins' => array('undo', '|', 'bold', 'italic'),
  661. 'editActionInterval' => 2,
  662. 'focusOnLoad' => true,
  663. 'height' => '250px',
  664. 'inheritWidth' => true,
  665. 'styleSheets' => array('/js/custom/editor.css'),
  666. ));
  667. ]]></programlisting>
  668. </example>
  669. <note>
  670. <title>Das Editor Dijit verwendet standardmäßig div</title>
  671. <para>
  672. Das Editor dijit verwendet standardmäßig ein <acronym>HTML</acronym>
  673. <acronym>DIV</acronym>. Die Dokumentation für
  674. <classname>dijit._editor.RichText</classname> zeigt dass es potentielle Sicherheits
  675. Probleme bereiten kann wenn man es auf ein HTML <acronym>TEXTAREA</acronym>
  676. erstellt.
  677. </para>
  678. <para>
  679. Deshalb kann es Zeiten geben in denen man ein Editor Widget benötigt das korrekt zu
  680. einer <acronym>TEXTAREA</acronym> degradiert. In solchen Situationen kann man dass
  681. durchführen indem die Eigenschaft <varname>degrade</varname> auf
  682. <constant>TRUE</constant> gesetzt wird:
  683. </para>
  684. <programlisting language="php"><![CDATA[
  685. // Bei der Instanzierung:
  686. $editor = new Zend_Dojo_Form_Element_Editor('foo', array(
  687. 'degrade' => true,
  688. ));
  689. // Erstellung über die Form:
  690. $form->addElement('editor', 'content', array(
  691. 'degrade' => true,
  692. ));
  693. // Oder nach der Instanzierung:
  694. $editor->degrade = true;
  695. ]]></programlisting>
  696. </note>
  697. </sect3>
  698. <sect3 id="zend.dojo.form.elements.horizontalSlider">
  699. <title>HorizontalSlider</title>
  700. <para>
  701. HorizontalSlider bietet ein Schieber UI Widget für die Auswahl eines nummerischen Wertes
  702. in einem Bereich. Intern, setzt es den Wert eines versteckten Elements welches vom
  703. Formular übermittelt wird.
  704. </para>
  705. <para>
  706. HorizontalSlider ist vom <link linkend="zend.dojo.form.elements.slider">abstrakten
  707. Slider Dijit Element</link> abgeleitet. Zusätzlich hat es eine Vielzahl von Methoden
  708. für das Setzen und Konfigurieren der Schieberregeln und Regel Labels.
  709. </para>
  710. <itemizedlist>
  711. <listitem>
  712. <para>
  713. <methodname>setTopDecorationDijit($dijit)</methodname> und
  714. <methodname>setBottomDecorationDijit($dijit)</methodname>: Setzt den Namen des
  715. Dijits das entweder oberhalb oder unterhalb des Schiebers verwendet werden
  716. soll. Es darf nicht den "dijit.form." Präfix enthalten, sondern nur den
  717. endgültigen Namen -- entweder "HorizontalRule" oder "HorizontalRuleLabels".
  718. </para>
  719. </listitem>
  720. <listitem>
  721. <para>
  722. <methodname>setTopDecorationContainer($container)</methodname> und
  723. <methodname>setBottomDecorationContainer($container)</methodname>: Spezifiziert
  724. den Namen der für das Containerelement der Regeln verwendet werden soll; z.B.
  725. 'topRule', 'topContainer', usw.
  726. </para>
  727. </listitem>
  728. <listitem>
  729. <para>
  730. <methodname>setTopDecorationLabels(array $labels)</methodname> und
  731. <methodname>setBottomDecorationLabels(array $labels)</methodname>: Setzt die
  732. Labels die für eine der RuleLabel Dijit Typen verwendet werden sollen. Diese
  733. sollten ein indiziertes Array sein; spezifiziere eine einzelnes Leerzeichen um
  734. eine gegebene Labelposition zu überspringen (wie beim Beginn oder dem Ende).
  735. </para>
  736. </listitem>
  737. <listitem>
  738. <para>
  739. <methodname>setTopDecorationParams(array $params)</methodname> und
  740. <methodname>setBottomDecorationParams(array $params)</methodname>: Dijit
  741. Parameter die verwendet werden sollen wenn die gegebene Rule oder RuleLabels
  742. Dijits konfiguriert werden
  743. </para>
  744. </listitem>
  745. <listitem>
  746. <para>
  747. <methodname>setTopDecorationAttribs(array $attribs)</methodname> und
  748. <methodname>setBottomDecorationAttribs(array $attribs)</methodname>: HTML
  749. Attribute die für die gegebene Rule oder RuleLabels HTML Elementcontainer
  750. spezifiziert werden.
  751. </para>
  752. </listitem>
  753. <listitem>
  754. <para>
  755. <methodname>getTopDecoration()</methodname> und
  756. <methodname>getBottomDecoration()</methodname>: Geben alle Metadaten für eine
  757. gegebene Rule oder RuleLabels Definition zurück, wie von den obigen Mutatoren
  758. geliefert.
  759. </para>
  760. </listitem>
  761. </itemizedlist>
  762. <example id="zend.dojo.form.elements.horizontalSlider.example">
  763. <title>Beispiel der Verwendung des HorizontalSlider Dijit Elements</title>
  764. <para>
  765. Das folgende erzeugt eine horizontale Schieberauswahl mit Integerwerten die von -10
  766. bis 10 reichen. Oben sind Labels bei den 20%, 40%, 60% und 80% Marken. Unten sind
  767. Regeln bei 0, 50% und 100%. Jedesmal wenn der Wert geändert wird, wird das
  768. versteckte Element das den Wert speichert aktualisiert.
  769. </para>
  770. <programlisting language="php"><![CDATA[
  771. $form->addElement(
  772. 'HorizontalSlider',
  773. 'horizontal',
  774. array(
  775. 'label' => 'HorizontalSlider',
  776. 'value' => 5,
  777. 'minimum' => -10,
  778. 'maximum' => 10,
  779. 'discreteValues' => 11,
  780. 'intermediateChanges' => true,
  781. 'showButtons' => true,
  782. 'topDecorationDijit' => 'HorizontalRuleLabels',
  783. 'topDecorationContainer' => 'topContainer',
  784. 'topDecorationLabels' => array(
  785. ' ',
  786. '20%',
  787. '40%',
  788. '60%',
  789. '80%',
  790. ' ',
  791. ),
  792. 'topDecorationParams' => array(
  793. 'container' => array(
  794. 'style' => 'height:1.2em; font-size=75%;color:gray;',
  795. ),
  796. 'list' => array(
  797. 'style' => 'height:1em; font-size=75%;color:gray;',
  798. ),
  799. ),
  800. 'bottomDecorationDijit' => 'HorizontalRule',
  801. 'bottomDecorationContainer' => 'bottomContainer',
  802. 'bottomDecorationLabels' => array(
  803. '0%',
  804. '50%',
  805. '100%',
  806. ),
  807. 'bottomDecorationParams' => array(
  808. 'list' => array(
  809. 'style' => 'height:1em; font-size=75%;color:gray;',
  810. ),
  811. ),
  812. )
  813. );
  814. ]]></programlisting>
  815. </example>
  816. </sect3>
  817. <sect3 id="zend.dojo.form.elements.numberSpinner">
  818. <title>NumberSpinner</title>
  819. <para>
  820. Ein Nummernkreisel (Number Spinner) ist ein Textelement für die Eingabe von nummerischen
  821. Werten; es enthält auch Elemente für das inkrementieren und dekrementieren des Wertes
  822. mit einer gesetzten Anzahl.
  823. </para>
  824. <para>
  825. Die folgenden Methoden sind vorhanden:
  826. </para>
  827. <itemizedlist>
  828. <listitem>
  829. <para>
  830. <methodname>setDefaultTimeout($timeout)</methodname> und
  831. <methodname>getDefaultTimeout()</methodname>: Setzt und gibt den
  832. Standardtimeout, in Millisekunden, zurück der zwischen dem gedrückt halten des
  833. Buttons und der Änderung des Wertes ist.
  834. </para>
  835. </listitem>
  836. <listitem>
  837. <para>
  838. <methodname>setTimeoutChangeRate($rate)</methodname> und
  839. <methodname>getTimeoutChangeRate()</methodname>: Setzt und gibe die Rate, in
  840. Millisekunden, zurück mit der Änderungen durchgeführt werden wenn ein Button
  841. gedrückt gehalten wird.
  842. </para>
  843. </listitem>
  844. <listitem>
  845. <para>
  846. <methodname>setLargeDelta($delta)</methodname> und
  847. <methodname>getLargeDelta()</methodname>: Setzt und gibt die Menge zurück mit
  848. welcher der nummerische Wert geändert werden soll wenn ein Button gedrückt
  849. gehalten wird.
  850. </para>
  851. </listitem>
  852. <listitem>
  853. <para>
  854. <methodname>setSmallDelta($delta)</methodname> und
  855. <methodname>getSmallDelta()</methodname>: Setzt und gibt das Delta zurück mit
  856. dem die Nummer geändert werden soll wenn ein Button einmal gedrückt wird.
  857. </para>
  858. </listitem>
  859. <listitem>
  860. <para>
  861. <methodname>setIntermediateChanges($flag)</methodname> und
  862. <methodname>getIntermediateChanges()</methodname>: Setzt un gibt das Flag
  863. zurück das anzeigt ob jede Änderung des Werte angezeigt werden soll wenn der
  864. Button gedrückt gehalten wird, oder nicht.
  865. </para>
  866. </listitem>
  867. <listitem>
  868. <para>
  869. <methodname>setRangeMessage($message)</methodname> und
  870. <methodname>getRangeMessage()</methodname>: Setzt und gibt die Nachricht zurück
  871. die den Bereich der möglichen Werte anzeigt.
  872. </para>
  873. </listitem>
  874. <listitem>
  875. <para>
  876. <methodname>setMin($value)</methodname> und <methodname>getMin()</methodname>:
  877. Setzt und gibt den mindesten möglichen Wert zurück.
  878. </para>
  879. </listitem>
  880. <listitem>
  881. <para>
  882. <methodname>setMax($value)</methodname> und <methodname>getMax()</methodname>:
  883. Setzt und gibt den maximalen möglichen Wert zurück.
  884. </para>
  885. </listitem>
  886. </itemizedlist>
  887. <example id="zend.dojo.form.elements.numberSpinner.example">
  888. <title>Beispiel der Verwendung des NumberSpinner Dijit Elements</title>
  889. <programlisting language="php"><![CDATA[
  890. $form->addElement(
  891. 'NumberSpinner',
  892. 'foo',
  893. array(
  894. 'value' => '7',
  895. 'label' => 'NumberSpinner',
  896. 'smallDelta' => 5,
  897. 'largeDelta' => 25,
  898. 'defaultTimeout' => 500,
  899. 'timeoutChangeRate' => 100,
  900. 'min' => 9,
  901. 'max' => 1550,
  902. 'places' => 0,
  903. 'maxlength' => 20,
  904. )
  905. );
  906. ]]></programlisting>
  907. </example>
  908. </sect3>
  909. <sect3 id="zend.dojo.form.elements.numberTextBox">
  910. <title>NumberTextBox</title>
  911. <para>
  912. Eine NumberTextBox ist ein Textelement für die Eingabe von nummerischen Werten; anders
  913. als beim NummerSpinner, werden Nummern manuell eingegeben. Prüfungen und Abhängigkeiten
  914. können angegeben werden um sicherzustellen das die Nummer immer in einem bestimmten
  915. Bereich oder Format ist.
  916. </para>
  917. <para>
  918. Intern wird NumberTextBox abgeleitet von
  919. <link linkend="zend.dojo.form.elements.validationTextBox">ValidationTextBox</link> und
  920. <link linkend="zend.dojo.form.elements.textBox">TextBox</link>; alle in diesen Klassen
  921. vorhandenen Methoden sind vorhanden. Zusätzlich können die folgenden Methoden verwendet
  922. werden um individuelle Abhängigkeiten zu setzen:
  923. </para>
  924. <itemizedlist>
  925. <listitem>
  926. <para>
  927. <methodname>setLocale($locale)</methodname> und
  928. <methodname>getLocale()</methodname>: Spezifiziert und gibt ein spezifisches
  929. oder alternatives Gebietsschema zurück das mit diesem Dijit verwendet werden
  930. soll.
  931. </para>
  932. </listitem>
  933. <listitem>
  934. <para>
  935. <methodname>setPattern($pattern)</methodname> und
  936. <methodname>getPattern()</methodname>: Setzt und gibt ein <ulink
  937. url="http://www.unicode.org/reports/tr35/#Number_Format_Patterns">Nummern
  938. Patternformat</ulink> zurück das verwendet wird um eine Nummer zu
  939. formatieren.
  940. </para>
  941. </listitem>
  942. <listitem>
  943. <para>
  944. <methodname>setType($type)</methodname> und <methodname>getType()</methodname>:
  945. Setzt und gibt eine nummerischen Formattyp zurück der verwendet wird (sollte
  946. 'decimal', 'percent' oder 'currency' sein).
  947. </para>
  948. </listitem>
  949. <listitem>
  950. <para>
  951. <methodname>setPlaces($places)</methodname> und
  952. <methodname>getPlaces()</methodname>: Setzt und gibt die Anzahl der
  953. Dezimalstellen die unterstützt werden sollen zurück.
  954. </para>
  955. </listitem>
  956. <listitem>
  957. <para>
  958. <methodname>setStrict($flag)</methodname> und
  959. <methodname>getStrict()</methodname>: Setzt und gibt den Wert des Strictflags
  960. zurück, welches anzeigt wieviel Ungenauigkeit in Bezug auf Leerzeichen und
  961. nicht-nummerische Zeichen erlaubt ist.
  962. </para>
  963. </listitem>
  964. </itemizedlist>
  965. <example id="zend.dojo.form.elements.numberTextBox.example">
  966. <title>Beispiel der Verwendung des NumberTextBox Dijit Elements</title>
  967. <programlisting language="php"><![CDATA[
  968. $form->addElement(
  969. 'NumberTextBox',
  970. 'elevation',
  971. array(
  972. 'label' => 'NumberTextBox',
  973. 'required' => true,
  974. 'invalidMessage' => 'Ungültige Eingabe.',
  975. 'places' => 0,
  976. 'constraints' => array(
  977. 'min' => -20000,
  978. 'max' => 20000,
  979. ),
  980. )
  981. );
  982. ]]></programlisting>
  983. </example>
  984. </sect3>
  985. <sect3 id="zend.dojo.form.elements.passwordTextBox">
  986. <title>PasswordTextBox</title>
  987. <para>
  988. PasswordTextBox ist einfach eine ValidationTextBox die an eine Passworteingabe gebunden
  989. ist; Ihre primäre Aufgabe ist es eine Dijit-bezogene Texteingabe für Passwörter zu
  990. erlauben die Client-seitige Prüfungen erlaubt.
  991. </para>
  992. <para>
  993. Intern wird PasswordTextBox abgeleitet von
  994. <link linkend="zend.dojo.form.elements.validationTextBox">ValidationTextBox</link> und
  995. <link linkend="zend.dojo.form.elements.textBox">TextBox</link>; alle in diesen Klassen
  996. vorhandenen Methoden sind vorhanden.
  997. </para>
  998. <example id="zend.dojo.form.elements.passwordTextBox.example">
  999. <title>Beispiel für die Verwendung des PasswordTextBox Dijit Elements</title>
  1000. <programlisting language="php"><![CDATA[
  1001. $form->addElement(
  1002. 'PasswordTextBox',
  1003. 'password',
  1004. array(
  1005. 'label' => 'Passwort',
  1006. 'required' => true,
  1007. 'trim' => true,
  1008. 'lowercase' => true,
  1009. 'regExp' => '^[a-z0-9]{6,}$',
  1010. 'invalidMessage' => 'Ungültiges Passwort; muß mindestens 6 '
  1011. . 'alphanummerische Zeichen lang sein',
  1012. )
  1013. );
  1014. ]]></programlisting>
  1015. </example>
  1016. </sect3>
  1017. <sect3 id="zend.dojo.form.elements.radioButton">
  1018. <title>RadioButton</title>
  1019. <para>
  1020. RadioButton umschließt ein standard Radio-Input Element um ein konsistentes Look and
  1021. Feel mit den anderen Dojo Dijits zu bieten.
  1022. </para>
  1023. <para>
  1024. RadioButton erweitert DijitMulti, welches es erlaubt Selectoptionen über die
  1025. <methodname>setMultiOptions()</methodname> und
  1026. <methodname>setMultiOption()</methodname> Methoden zu spezifizieren.
  1027. </para>
  1028. <para>
  1029. Standardmäßig registriert dieses Element eine <classname>InArray</classname> Prüfung
  1030. welche die Arrayschlüssel gegen registrierte Optionen prüft. Dieses Verhalten kann
  1031. deaktiviert werden indem entweder
  1032. <methodname>setRegisterInArrayValidator(false)</methodname> ausgerufen, oder ein
  1033. <constant>FALSE</constant> Wert an den Registrierungsschlüssel
  1034. <property>registerInArrayValidator</property> übergeben wird.
  1035. </para>
  1036. <example id="zend.dojo.form.elements.radioButton.example">
  1037. <title>Beispiel der Verwendung des RadioButton Dijit Elements</title>
  1038. <programlisting language="php"><![CDATA[
  1039. $form->addElement(
  1040. 'RadioButton',
  1041. 'foo',
  1042. array(
  1043. 'label' => 'RadioButton',
  1044. 'multiOptions' => array(
  1045. 'foo' => 'Foo',
  1046. 'bar' => 'Bar',
  1047. 'baz' => 'Baz',
  1048. ),
  1049. 'value' => 'bar',
  1050. )
  1051. );
  1052. ]]></programlisting>
  1053. </example>
  1054. </sect3>
  1055. <sect3 id="zend.dojo.form.elements.simpletextarea">
  1056. <title>SimpleTextarea</title>
  1057. <para>
  1058. SimpleTextarea arbeitet primär wie ein Standard HTML Textarea. Trotzdem unterstützt es
  1059. weder die rows noch die cols Einstellung. Stattdessen, sollte die Breite von Textarea
  1060. durch die Verwendung von standard <acronym>CSS</acronym> Maßeinheiten definiert werden.
  1061. Anders als Textarea wird er nicht automatisch wachsen
  1062. </para>
  1063. <example id="zend.dojo.form.elements.simpletextarea.example">
  1064. <title>Beispiel der Verwendung des SimpleTextarea Dijit Elements</title>
  1065. <programlisting language="php"><![CDATA[
  1066. $form->addElement(
  1067. 'SimpleTextarea',
  1068. 'simpletextarea',
  1069. array(
  1070. 'label' => 'SimpleTextarea',
  1071. 'required' => true,
  1072. 'style' => 'width: 80em; height: 25em;',
  1073. )
  1074. );
  1075. ]]></programlisting>
  1076. </example>
  1077. </sect3>
  1078. <sect3 id="zend.dojo.form.elements.slider">
  1079. <title>Abstraktes Slider Element</title>
  1080. <para>
  1081. Slider ist ein abstraktes Element welches abgeleitet ist von
  1082. <link linkend="zend.dojo.form.elements.horizontalSlider">HorizontalSlider</link> und
  1083. <link linkend="zend.dojo.form.elements.verticalSlider">VerticalSlider</link>. Es bietet
  1084. eine Anzahl von üblichen Methoden für die Konfiguration von Slidern an, inklusive:
  1085. </para>
  1086. <itemizedlist>
  1087. <listitem>
  1088. <para>
  1089. <methodname>setClickSelect($flag)</methodname> und
  1090. <methodname>getClickSelect()</methodname>: Setzt und gibt das Flag zurück das
  1091. anzeigt ob das Klicken auf den Slider den Wert ändert oder nicht.
  1092. </para>
  1093. </listitem>
  1094. <listitem>
  1095. <para>
  1096. <methodname>setIntermediateChanges($flag)</methodname> und
  1097. <methodname>getIntermediateChanges()</methodname>: Setzt und gibt das Flag
  1098. zurück das anzeigt ob das Dijit eine Benachrichtigung bei jedem Slider-Event
  1099. schickt oder nicht.
  1100. </para>
  1101. </listitem>
  1102. <listitem>
  1103. <para>
  1104. <methodname>setShowButtons($flag)</methodname> und
  1105. <methodname>getShowButtons()</methodname>: Setzt und gibt das Flag zurück das
  1106. anzeigt ob Buttons an den Enden angezeigt werden oder nicht; wenn ja, dann kann
  1107. der Benutzer diese anklicken und damit den Wert des Sliders ändern.
  1108. </para>
  1109. </listitem>
  1110. <listitem>
  1111. <para>
  1112. <methodname>setDiscreteValues($value)</methodname> und
  1113. <methodname>getDiscreteValues()</methodname>: Setzt und gibt die Anzahl an
  1114. diskreten Werte zurück die vom Slider repräsentiert werden.
  1115. </para>
  1116. </listitem>
  1117. <listitem>
  1118. <para>
  1119. <methodname>setMaximum($value)</methodname> und
  1120. <methodname>getMaximum()</methodname>: Setzt den maximalen Wert des Sliders.
  1121. </para>
  1122. </listitem>
  1123. <listitem>
  1124. <para>
  1125. <methodname>setMinimum($value)</methodname> und
  1126. <methodname>getMinimum()</methodname>: Setzt den minimalen Wert des Sliders.
  1127. </para>
  1128. </listitem>
  1129. <listitem>
  1130. <para>
  1131. <methodname>setPageIncrement($value)</methodname> und
  1132. <methodname>getPageIncrement()</methodname>: Setzt den Wert um den sich der
  1133. Slider auf Tastaturereignisse ändert.
  1134. </para>
  1135. </listitem>
  1136. </itemizedlist>
  1137. <para>
  1138. Ein Beispiel der Verwendung wird mit jeder konkreten Klasse angegeben die diese Klasse
  1139. erweitert.
  1140. </para>
  1141. </sect3>
  1142. <sect3 id="zend.dojo.form.elements.submitButton">
  1143. <title>SubmitButton</title>
  1144. <para>
  1145. Wärend es kein Dijit gibt das SubmitButton heißt, wurde dieses inkludiert um ein Button
  1146. Dijit anzubieten das fähig ist ein Formular zu übertragen ohne das irgendeine
  1147. zusätzliche Javascript Verknüpfung benötigt wird. Es funktioniert exakt wie das
  1148. <link linkend="zend.dojo.form.elements.button">Button Dijit</link>.
  1149. </para>
  1150. <example id="zend.dojo.form.elements.submitButton.example">
  1151. <title>Beispiel der Verwendung des SubmitButton Dijit Elements</title>
  1152. <programlisting language="php"><![CDATA[
  1153. $form->addElement(
  1154. 'SubmitButton',
  1155. 'foo',
  1156. array(
  1157. 'required' => false,
  1158. 'ignore' => true,
  1159. 'label' => 'Submit Button!',
  1160. )
  1161. );
  1162. ]]></programlisting>
  1163. </example>
  1164. </sect3>
  1165. <sect3 id="zend.dojo.form.elements.textBox">
  1166. <title>TextBox</title>
  1167. <para>
  1168. TextBox wurde primär inkludiert um eine Text Eingabe anzubieten die das gleiche
  1169. Look-and-Feel wie die anderen Dijits hat. Trotzdem enthält es einige Filter- und
  1170. Prüfmöglichkeiten, die in den folgenden Methoden repräsentiert sind:
  1171. </para>
  1172. <itemizedlist>
  1173. <listitem>
  1174. <para>
  1175. <methodname>setLowercase($flag)</methodname> und
  1176. <methodname>getLowercase()</methodname>: Setzt und gibt das Tag zurück das
  1177. anzeigt ob die Eingabe auf Kleinschreibung (lowercase) geändert wird oder nicht.
  1178. </para>
  1179. </listitem>
  1180. <listitem>
  1181. <para>
  1182. <methodname>setPropercase($flag)</methodname> und
  1183. <methodname>getPropercase()</methodname>: Setzt und gibt das Tag zurück das
  1184. anzeigt ob die Eingabe auf Proper Case geändert wird oder nicht.
  1185. </para>
  1186. </listitem>
  1187. <listitem>
  1188. <para>
  1189. <methodname>setUppercase($flag)</methodname> und
  1190. <methodname>getUppercase()</methodname>: Setzt und retourniert das Flag das
  1191. anzeigt ob die Eingabe auf Großschreibung (UPPERCASE) geändert wird oder nicht.
  1192. </para>
  1193. </listitem>
  1194. <listitem>
  1195. <para>
  1196. <methodname>setTrim($flag)</methodname> und <methodname>getTrim()</methodname>:
  1197. Setzt und retourniert das Flag das anzeigt ob führende Leerzeichen entfernt
  1198. werden oder nicht.
  1199. </para>
  1200. </listitem>
  1201. <listitem>
  1202. <para>
  1203. <methodname>setMaxLength($length)</methodname> und
  1204. <methodname>getMaxLength()</methodname>: Setzt und retourniert die maximale
  1205. Länge der Eingabe.
  1206. </para>
  1207. </listitem>
  1208. </itemizedlist>
  1209. <example id="zend.dojo.form.elements.textBox.example">
  1210. <title>Beispiel der Verwendung des TextBox Dijit Elements</title>
  1211. <programlisting language="php"><![CDATA[
  1212. $form->addElement(
  1213. 'TextBox',
  1214. 'foo',
  1215. array(
  1216. 'value' => 'irgendein Text',
  1217. 'label' => 'TextBox',
  1218. 'trim' => true,
  1219. 'propercase' => true,
  1220. )
  1221. );
  1222. ]]></programlisting>
  1223. </example>
  1224. </sect3>
  1225. <sect3 id="zend.dojo.form.elements.textarea">
  1226. <title>Textarea</title>
  1227. <para>
  1228. Textarea funktioniert primär wie eine standard HTML Textarea. Trotzdem unterstützt es
  1229. weder die Zeilen- noch die Spalteneinstellungen. Stattdessen sollte die Breite von
  1230. Textarea durch Verwendung von <acronym>CSS</acronym> Maßeinheiten spezifiziert werden;
  1231. Zeilen sollten komplett vermieden werden. Die Textarea wird dann vertikal wachsen wenn
  1232. Text hinzugefügt wird.
  1233. </para>
  1234. <example id="zend.dojo.form.elements.textarea.example">
  1235. <title>Beispiel der Verwendung des Textarea Dijit Elements</title>
  1236. <programlisting language="php"><![CDATA[
  1237. $form->addElement(
  1238. 'Textarea',
  1239. 'textarea',
  1240. array(
  1241. 'label' => 'Textarea',
  1242. 'required' => true,
  1243. 'style' => 'width: 200px;',
  1244. )
  1245. );
  1246. ]]></programlisting>
  1247. </example>
  1248. </sect3>
  1249. <sect3 id="zend.dojo.form.elements.timeTextBox">
  1250. <title>TimeTextBox</title>
  1251. <para>
  1252. TimeTextBox ist eine Texteingabe die einen Drop-Down für die Auswahl einer Zeit bietet.
  1253. Der Drop-Down kann so konfiguriert werden das ein bestimmtes Zeitfenster, mit speziellen
  1254. Inkrementierungen, angezeigt wird.
  1255. </para>
  1256. <para>
  1257. Intern wird die TimeTextBox von
  1258. <link linkend="zend.dojo.form.elements.dateTextBox">DateTextBox</link>,
  1259. <link linkend="zend.dojo.form.elements.validationTextBox">ValidationTextBox</link> und
  1260. <link linkend="zend.dojo.form.elements.textBox">TextBox</link> abgeleitet; alle
  1261. vorhandenen Methoden dieser Klassen sind vorhanden. Zusätzlich können die folgenden
  1262. Methoden verwendet werden um individuelle Abhängigkeiten einzustellen:
  1263. </para>
  1264. <itemizedlist>
  1265. <listitem>
  1266. <para>
  1267. <methodname>setTimePattern($pattern)</methodname> und
  1268. <methodname>getTimePattern()</methodname>: Setzt und retourniert den
  1269. <ulink url="http://www.unicode.org/reports/tr35/#Date_Format_Patterns">Unicode
  1270. Zeitformat Pattern</ulink> für die Formatierung der Zeit.
  1271. </para>
  1272. </listitem>
  1273. <listitem>
  1274. <para>
  1275. <methodname>setClickableIncrement($format)</methodname> und
  1276. <methodname>getClickableIncrement()</methodname>: Setzt den <ulink
  1277. url="http://en.wikipedia.org/wiki/ISO_8601">ISO-8601</ulink>
  1278. String der die Anzahl repräsentiert mit dem jedes anklickbare Element der
  1279. Zeitauswahl inkrementiert wird.
  1280. </para>
  1281. </listitem>
  1282. <listitem>
  1283. <para>
  1284. <methodname>setVisibleIncrement($format)</methodname> und
  1285. <methodname>getVisibleIncrement()</methodname>: Definiert das der Inkrement in
  1286. der Zeitauswahl sichtbar ist; muß dem ISO-8601 Format
  1287. entsprechen.
  1288. </para>
  1289. </listitem>
  1290. <listitem>
  1291. <para>
  1292. <methodname>setVisibleRange($format)</methodname> und
  1293. <methodname>getVisibleRange()</methodname>: Setzt und retorniert den
  1294. Zeitbereich der in der Zeitauswahl zu jedem Zeitpunkt sichtbar ist; muß dem
  1295. ISO-8601 Format entsprechen.
  1296. </para>
  1297. </listitem>
  1298. </itemizedlist>
  1299. <example id="zend.dojo.form.elements.timeTextBox.example">
  1300. <title>Beispiel der Verwendung des TimeTextBox Dijit Elements</title>
  1301. <para>
  1302. Das folgende erstellt eine TimeTextBox die 2 Stunden zugleich anzeigt und um 10
  1303. Minuten inkrementiert.
  1304. </para>
  1305. <programlisting language="php"><![CDATA[
  1306. $form->addElement(
  1307. 'TimeTextBox',
  1308. 'foo',
  1309. array(
  1310. 'label' => 'TimeTextBox',
  1311. 'required' => true,
  1312. 'visibleRange' => 'T04:00:00',
  1313. 'visibleIncrement' => 'T00:10:00',
  1314. 'clickableIncrement' => 'T00:10:00',
  1315. )
  1316. );
  1317. ]]></programlisting>
  1318. </example>
  1319. </sect3>
  1320. <sect3 id="zend.dojo.form.elements.validationTextBox">
  1321. <title>ValidationTextBox</title>
  1322. <para>
  1323. ValidationTextBox bietet die Möglichkeit Prüfungen und Abhängigkeiten zu einer
  1324. Texteingabe hinzuzufügen. Intern ist Sie von
  1325. <link linkend="zend.dojo.form.elements.textBox">TextBox</link> abgeleitet, und fügt die
  1326. folgenden Zugriffsmethoden und Mutatoren für die Manipulation der Dijit Parameter hinzu:
  1327. </para>
  1328. <itemizedlist>
  1329. <listitem>
  1330. <para>
  1331. <methodname>setInvalidMessage($message)</methodname> und
  1332. <methodname>getInvalidMessage()</methodname>: Setzt und retourniert die
  1333. Tooltipnachricht die angezeigt werden soll wenn der Wert nicht gültig ist.
  1334. </para>
  1335. </listitem>
  1336. <listitem>
  1337. <para>
  1338. <methodname>setPromptMessage($message)</methodname> und
  1339. <methodname>getPromptMessage()</methodname>: Setzt und retourniert die
  1340. Tooltipnachricht die angezeigt werden soll wenn das Element verwendet wird.
  1341. </para>
  1342. </listitem>
  1343. <listitem>
  1344. <para>
  1345. <methodname>setRegExp($regexp)</methodname> und
  1346. <methodname>getRegExp()</methodname>: Setzt und retourniert den regulären
  1347. Ausdruck der für die Prüfung des Elements verwendet wird. Der reguläre Ausdruck
  1348. benötigt keine Begrenzungen (anders als <acronym>PHP</acronym>'s
  1349. Funktionsfamilie preg*).
  1350. </para>
  1351. </listitem>
  1352. <listitem>
  1353. <para>
  1354. <methodname>setConstraint($key, $value)</methodname> und
  1355. <methodname>getConstraint($key)</methodname>: Setzt und retourniert zusätzliche
  1356. Abhängigkeiten die für die Prüfung des Elements verwendet werden; wird primär
  1357. mit Unterklassen verwendet. Abhängigkeiten werden im 'constraints' Schlüssel
  1358. der Dijit Parameter abgespeichert.
  1359. </para>
  1360. </listitem>
  1361. <listitem>
  1362. <para>
  1363. <methodname>setConstraints(array $constraints)</methodname> und
  1364. <methodname>getConstraints()</methodname>: Setzt und retourniert individuelle
  1365. Abhängigkeiten die bei der Prüfung eines Elements verwendet werden; wird primär
  1366. mit Unterklassen verwendet.
  1367. </para>
  1368. </listitem>
  1369. <listitem>
  1370. <para>
  1371. <methodname>hasConstraint($key)</methodname>: Testet ob eine angegebene
  1372. Abhängigkeit existiert.
  1373. </para>
  1374. </listitem>
  1375. <listitem>
  1376. <para>
  1377. <methodname>removeConstraint($key)</methodname> und
  1378. <methodname>clearConstraints()</methodname>: Entfernt eine einzelne oder alle
  1379. Abhängigkeiten des Elements.
  1380. </para>
  1381. </listitem>
  1382. </itemizedlist>
  1383. <example id="zend.dojo.form.elements.validationTextBox.example">
  1384. <title>Beispiel für die Verwendung des ValidationTextBox Dijit Elements</title>
  1385. <para>
  1386. Das folgende erstellt eine ValidationTextBox die einen einzelnen String benötigt der
  1387. nur aus Buchstaben besteht (z.B, keine Leerzeichen, die meisten Trennungen sind
  1388. ungültig).
  1389. </para>
  1390. <programlisting language="php"><![CDATA[
  1391. $form->addElement(
  1392. 'ValidationTextBox',
  1393. 'foo',
  1394. array(
  1395. 'label' => 'ValidationTextBox',
  1396. 'required' => true,
  1397. 'regExp' => '[\w]+',
  1398. 'invalidMessage' => 'Ungültige Buchstaben.',
  1399. )
  1400. );
  1401. ]]></programlisting>
  1402. </example>
  1403. </sect3>
  1404. <sect3 id="zend.dojo.form.elements.verticalSlider">
  1405. <title>VerticalSlider</title>
  1406. <para>
  1407. VerticalSlider ist der Schwager von
  1408. <link linkend="zend.dojo.form.elements.horizontalSlider">HorizontalSlider</link>, und
  1409. funktioniert auf dem gleichen Weg wie dieses Element. Der einzige wirkliche Unterschied
  1410. besteht darin, das die 'top*' und 'bottom*' Methoden mit 'left*' und 'right*' ersetzt
  1411. wurden, und statt HorizontalRule und HorizontalRuleLabels jetzt VerticalRule und
  1412. VerticalRuleLabels verwendet werden sollten.
  1413. </para>
  1414. <example id="zend.dojo.form.elements.verticalSlider.example">
  1415. <title>Beispiel der Verwendung des VerticalSlider Dijit Elements</title>
  1416. <para>
  1417. Das folgende erstellt eine Vertikale Schieberauswahl mit Ganzzahlen die von -10 bis
  1418. 10 reichen. Die linke Seite hat Label bei den 20%, 40%, 60% und 80% Marken. Die
  1419. rechte Seite hat Regeln bei 0, 50% und 100%. Jedesmal wenn der Wert verändert wird,
  1420. wird auch das versteckte Element, das den Wert speichert, aktualisiert.
  1421. </para>
  1422. <programlisting language="php"><![CDATA[
  1423. $form->addElement(
  1424. 'VerticalSlider',
  1425. 'foo',
  1426. array(
  1427. 'label' => 'VerticalSlider',
  1428. 'value' => 5,
  1429. 'style' => 'height: 200px; width: 3em;',
  1430. 'minimum' => -10,
  1431. 'maximum' => 10,
  1432. 'discreteValues' => 11,
  1433. 'intermediateChanges' => true,
  1434. 'showButtons' => true,
  1435. 'leftDecorationDijit' => 'VerticalRuleLabels',
  1436. 'leftDecorationContainer' => 'leftContainer',
  1437. 'leftDecorationLabels' => array(
  1438. ' ',
  1439. '20%',
  1440. '40%',
  1441. '60%',
  1442. '80%',
  1443. ' ',
  1444. ),
  1445. 'rightDecorationDijit' => 'VerticalRule',
  1446. 'rightDecorationContainer' => 'rightContainer',
  1447. 'rightDecorationLabels' => array(
  1448. '0%',
  1449. '50%',
  1450. '100%',
  1451. ),
  1452. )
  1453. );
  1454. ]]></programlisting>
  1455. </example>
  1456. </sect3>
  1457. </sect2>
  1458. <!--
  1459. vim:se ts=4 sw=4 et:
  1460. -->