Zend_Dojo-Form-Elements.xml 64 KB

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