Zend_Dojo-Form-Elements.xml 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect2 id="zend.dojo.form.elements">
  4. <title>Elementos de Formularios Dijit-Specific</title>
  5. <para>
  6. Cada formulario dijit para el que se provee un ayudante tiene un
  7. elemento correspondiente <classname>Zend_Form</classname>.
  8. Todos ellos tienen los siguientes métodos disponibles para manipular
  9. los parámetros dijit:
  10. </para>
  11. <itemizedlist>
  12. <listitem><para>
  13. <code>setDijitParam($key, $value)</code>: establecer un único
  14. parámetro dijit. Si el parámetro dijit ya existe, se borrará y
  15. se reemplazará por el nuevo.
  16. </para></listitem>
  17. <listitem><para>
  18. <code>setDijitParams(array $params)</code>: establecer varios
  19. parámetros dijit a la vez. Cualquiera de los parámetros pasados
  20. que concuerden con los ya presentes se sobreescribirán.
  21. </para></listitem>
  22. <listitem><para>
  23. <code>hasDijitParam($key)</code>: si un determinado parámetro
  24. dijit está definido y presente, devolverá TRUE, de lo contrario
  25. devolverá FALSE.
  26. </para></listitem>
  27. <listitem><para>
  28. <code>getDijitParam($key)</code>: recupera el parámetro dijit.
  29. Si no está disponible, se devuelve un valor null.
  30. </para></listitem>
  31. <listitem><para>
  32. <code>getDijitParams()</code>: recupera todos los parámetros
  33. dijit.
  34. </para></listitem>
  35. <listitem><para>
  36. <code>removeDijitParam($key)</code>: elimina el parámetro
  37. dijit dado.
  38. </para></listitem>
  39. <listitem><para>
  40. <code>clearDijitParams()</code>: borra todos los parámetros
  41. dijit actualmente definidos.
  42. </para></listitem>
  43. </itemizedlist>
  44. <para>
  45. Los parámetros Dijit se almacenan en la propiedad pública
  46. <code>dijitParams</code>. Así, puede habilitar dijit para un elemento
  47. de un formulario existente simplemente estableciendo esta propiedad
  48. en el elemento; sencillamante no tendrá los accessors anteriores a fin
  49. de facilitar la manipulación de parámetros.
  50. </para>
  51. <para>
  52. Además, los elementos específicos de dijit implementan una lista
  53. diferente de decoradores, correspondientes a lo siguiente:
  54. </para>
  55. <programlisting role="php"><![CDATA[
  56. $element->addDecorator('DijitElement')
  57. ->addDecorator('Errors')
  58. ->addDecorator('HtmlTag', array('tag' => 'dd'))
  59. ->addDecorator('Label', array('tag' => 'dt'));
  60. ]]></programlisting>
  61. <para>
  62. En efecto, el decorador DijitElement es utilizado en lugar del
  63. decorador standard ViewHelper.
  64. </para>
  65. <para>
  66. Finalmente, el elemento base Dijit asegura que el path del ayudante de
  67. vista de Dojo se establezca en la vista.
  68. </para>
  69. <para>
  70. Una variante de DijitElement, DijitMulti, ofrece la funcionalidad del
  71. elemento abstracto del formulario <code>Multi</code>, permitiendo al
  72. desarrollador especificar 'multiOptions' -- típicamente opciones
  73. "select" u opciones de "radio".
  74. </para>
  75. <para>
  76. Los siguientes elementos dijit están incluídos en la distribución
  77. standard de Zend Framework.
  78. </para>
  79. <sect3 id="zend.dojo.form.elements.button">
  80. <title>Button</title>
  81. <para>
  82. Si bien no derivan del elemento standard Button <link
  83. linkend="zend.form.standardElements.button"></link>, implementan
  84. la misma funcionalidad, y pueden ser utilizados como una sustitución
  85. de drop-in, como se expone en la siguiente funcionalidad:
  86. </para>
  87. <itemizedlist>
  88. <listitem><para>
  89. <code>getLabel()</code> utilizará el nombre del elemento como el
  90. rótulo del botón si no se ha provisto el nombre.
  91. Además, traducirá el nombre si un adaptador de traducción
  92. encuentra concordancia con un mensaje disponible.
  93. </para></listitem>
  94. <listitem><para>
  95. <code>isChecked()</code> determina si el valor enviado
  96. coincide con la etiqueta; si así fuera, devuelve true.
  97. Esto es útil para determinar qué botón se utilizó cuando se
  98. envió un formulario.
  99. </para></listitem>
  100. </itemizedlist>
  101. <para>
  102. Además, sólo los decoradores <code>DijitElement</code> y
  103. <code>DtDdWrapper</code> se utilizan para elementos Button.
  104. </para>
  105. <example id="zend.dojo.form.elements.button.example">
  106. <title>Ejemplo de Uso del Elemento Button dijit</title>
  107. <programlisting role="php"><![CDATA[
  108. $form->addElement(
  109. 'Button',
  110. 'foo',
  111. array(
  112. 'label' => 'Button Label',
  113. )
  114. );
  115. ]]></programlisting>
  116. </example>
  117. </sect3>
  118. <sect3 id="zend.dojo.form.elements.checkBox">
  119. <title>CheckBox</title>
  120. <para>
  121. Si bien no derivan del elemento standard Checkbox <link
  122. linkend="zend.form.standardElements.checkbox"></link>,
  123. aplican la misma funcionalidad. Esto significa exponer los
  124. siguientes métodos:
  125. </para>
  126. <itemizedlist>
  127. <listitem><para>
  128. <code>setCheckedValue($value)</code>: establecer el valor a usar
  129. cuando el elemento está marcado (checked).
  130. </para></listitem>
  131. <listitem><para>
  132. <code>getCheckedValue()</code>: obtener el valor del item a
  133. usar cuando está comprobado (checked).
  134. </para></listitem>
  135. <listitem><para>
  136. <code>setUncheckedValue($value)</code>: establecer el valor del
  137. item a utilizar cuando está desactivado (unchecked).
  138. </para></listitem>
  139. <listitem><para>
  140. <code>getUncheckedValue()</code>: obtener el valor del
  141. item a utilizar cuando está desactivado (unchecked).
  142. </para></listitem>
  143. <listitem><para>
  144. <code>setChecked($flag)</code>: marcar el elemento como
  145. activado (checked) o desactivado (unchecked).
  146. </para></listitem>
  147. <listitem><para>
  148. <code>isChecked()</code>: determina si el elemento está
  149. activo (checked) actualmente.
  150. </para></listitem>
  151. </itemizedlist>
  152. <example id="zend.dojo.form.elements.checkBox.example">
  153. <title>Ejemplo de Uso de Elementos CheckBox dijit</title>
  154. <programlisting role="php"><![CDATA[
  155. $form->addElement(
  156. 'CheckBox',
  157. 'foo',
  158. array(
  159. 'label' => 'A check box',
  160. 'checkedValue' => 'foo',
  161. 'uncheckedValue' => 'bar',
  162. 'checked' => true,
  163. )
  164. );
  165. ]]></programlisting>
  166. </example>
  167. </sect3>
  168. <sect3 id="zend.dojo.form.elements.comboBox">
  169. <title>ComboBox y FilteringSelect</title>
  170. <para>
  171. Como se señaló en la documentación del ayudante de vista de
  172. ComboBox dijit <link
  173. linkend="zend.dojo.view.dijit.form"></link>, los ComboBoxes
  174. son un híbrido entre "select" y "text input", permitiendo el
  175. autocompletado y la capacidad para especificar una alternativa a las
  176. opciones provistas.
  177. FilteringSelects es lo mismo, pero no permite entradas arbitrarias.
  178. </para>
  179. <note>
  180. <title>ComboBoxes que Devuelven los Valores de los Labels</title>
  181. <para>
  182. Los ComboBoxes devuelven los valores de los rótulos (labels),
  183. y no los valores de opción, que pueden llevar a una
  184. desvinculación de las expectativas.
  185. Por esta razón, los ComboBoxes no auto-registran un validador
  186. <code>InArray</code> (aunque los FilteringSelects si lo hacen).
  187. </para>
  188. </note>
  189. <para>
  190. Los elementos de forms de ComboBox y FilteringSelect proporcionan
  191. accessors y mutators para examinar y establecer las opciones
  192. seleccionadas, así como para especificar un datastore dojo.data
  193. (si se usa). Se extienden desde DijitMulti, que le permite
  194. especificar opciones de selección vía los métodos
  195. <code>setMultiOptions()</code> y <code>setMultiOption()</code>.
  196. Además, están disponibles los siguientes métodos:
  197. </para>
  198. <itemizedlist>
  199. <listitem><para>
  200. <code>getStoreInfo()</code>: Obtener del datastore toda la
  201. información establecida actualmente.
  202. Devuelve un array vacío si no hay datos actualmente establecidos.
  203. </para></listitem>
  204. <listitem><para>
  205. <code>setStoreId($identifier)</code>: establece la variable del
  206. identificador (generalmente referenciado por el atributo
  207. 'jsId' en Dojo).
  208. Este debe ser un nombre de variable válido para javascript.
  209. </para></listitem>
  210. <listitem><para>
  211. <code>getStoreId()</code>: recupera el nombre de la variable del
  212. identificador del datastore.
  213. </para></listitem>
  214. <listitem><para>
  215. <code>setStoreType($dojoType)</code>: establece la clase del
  216. datastore a usar; por ejemplo, "dojo.data.ItemFileReadStore".
  217. </para></listitem>
  218. <listitem><para>
  219. <code>getStoreType()</code>: obtiene la clase del datastore a
  220. usar.
  221. </para></listitem>
  222. <listitem><para>
  223. <code>setStoreParams(array $params)</code>: establece cualquiera
  224. de los parámetros utilizados para configurar el objeto datastore.
  225. Como ejemplo, el datastore dojo.data.ItemFileReadStore esperaría
  226. un parámetro 'url' apuntando a un lugar que devolvería el objeto
  227. dojo.data.
  228. </para></listitem>
  229. <listitem><para>
  230. <code>getStoreParams()</code>: obtiene cualquiera de los
  231. parámetros del datastore actualmente establecido; si no hay
  232. ninguno, se devuelve un array vacío.
  233. </para></listitem>
  234. <listitem><para>
  235. <code>setAutocomplete($flag)</code>: indica si será usado o no
  236. el elemento seleccionado una vez que el usuario deje el
  237. elemento.
  238. </para></listitem>
  239. <listitem><para>
  240. <code>getAutocomplete()</code>: obtener el valor del flag de
  241. autocomplete.
  242. </para></listitem>
  243. </itemizedlist>
  244. <para>
  245. Por defecto, si no hay ningún dojo.data registrado con el
  246. elemento, este elemento registra un validador <code>InArray</code>
  247. que valida contra las claves del array de las opciones registradas.
  248. Puede desactivar este comportamiento ya sea llamando a
  249. <code>setRegisterInArrayValidator(false)</code>, o pasando un valor
  250. false a la clave de configuración <code>registerInArrayValidator</code>.
  251. </para>
  252. <example id="zend.dojo.form.elements.comboBox.selectExample">
  253. <title>Elemento de ComboBox dijit Usado como select input</title>
  254. <programlisting role="php"><![CDATA[
  255. $form->addElement(
  256. 'ComboBox',
  257. 'foo',
  258. array(
  259. 'label' => 'ComboBox (select)',
  260. 'value' => 'blue',
  261. 'autocomplete' => false,
  262. 'multiOptions' => array(
  263. 'red' => 'Rouge',
  264. 'blue' => 'Bleu',
  265. 'white' => 'Blanc',
  266. 'orange' => 'Orange',
  267. 'black' => 'Noir',
  268. 'green' => 'Vert',
  269. ),
  270. )
  271. );
  272. ]]></programlisting>
  273. </example>
  274. <example id="zend.dojo.form.elements.comboBox.datastoreExample">
  275. <title>Elemento de ComboBox dijit Usado con datastore</title>
  276. <programlisting role="php"><![CDATA[
  277. $form->addElement(
  278. 'ComboBox',
  279. 'foo',
  280. array(
  281. 'label' => 'ComboBox (datastore)',
  282. 'storeId' => 'stateStore',
  283. 'storeType' => 'dojo.data.ItemFileReadStore',
  284. 'storeParams' => array(
  285. 'url' => '/js/states.txt',
  286. ),
  287. 'dijitParams' => array(
  288. 'searchAttr' => 'name',
  289. ),
  290. )
  291. );
  292. ]]></programlisting>
  293. </example>
  294. <para>
  295. Los ejemplos anteriores también podrían utilizar
  296. <code>FilteringSelect</code> en vez de <code>ComboBox</code>.
  297. </para>
  298. </sect3>
  299. <sect3 id="zend.dojo.form.elements.currencyTextBox">
  300. <title>CurrencyTextBox</title>
  301. <para>
  302. El CurrencyTextBox principalmente brinda apoyo a la entrada de
  303. moneda. La moneda puede ser localizada, y puede manejar tanto a
  304. valores fraccionarios como no fraccionarios.
  305. </para>
  306. <para>
  307. Internamente, CurrencyTextBox deriva de <link
  308. linkend="zend.dojo.form.elements.numberTextBox">NumberTextBox</link>,
  309. <link
  310. linkend="zend.dojo.form.elements.validationTextBox">ValidationTextBox</link>,
  311. y <link linkend="zend.dojo.form.elements.textBox">TextBox</link>;
  312. todos los métodos disponibles a esas clases están disponibles.
  313. Además, pueden utilizarse los siguientes métodos restrictivos:
  314. </para>
  315. <itemizedlist>
  316. <listitem><para>
  317. <code>setCurrency($currency)</code>: establecer el tipo de
  318. moneda a usar; y debe seguir la especificación <ulink
  319. url="http://en.wikipedia.org/wiki/ISO_4217">ISO-4217</ulink>
  320. </para></listitem>
  321. <listitem><para>
  322. <code>getCurrency()</code>: recupera el tipo de moneda actual.
  323. </para></listitem>
  324. <listitem><para>
  325. <code>setSymbol($symbol)</code>: establece el símbolo de
  326. 3 letras <ulink
  327. url="http://en.wikipedia.org/wiki/ISO_4217">ISO-4217</ulink>
  328. de la moneda a usar.
  329. </para></listitem>
  330. <listitem><para>
  331. <code>getSymbol()</code>: recupera el símbolo de la moneda actual.
  332. </para></listitem>
  333. <listitem><para>
  334. <code>setFractional($flag)</code>: establece si la moneda
  335. debería permitir o no valores fraccionarios.
  336. </para></listitem>
  337. <listitem><para>
  338. <code>getFractional()</code>: recupera el status del flag
  339. fraccional.
  340. </para></listitem>
  341. </itemizedlist>
  342. <example id="zend.dojo.form.elements.currencyTextBox.example">
  343. <title>Ejemplo de Uso del Elemento CurrencyTextBox dijit</title>
  344. <programlisting role="php"><![CDATA[
  345. $form->addElement(
  346. 'CurrencyTextBox',
  347. 'foo',
  348. array(
  349. 'label' => 'Currency:',
  350. 'required' => true,
  351. 'currency' => 'USD',
  352. 'invalidMessage' => 'Invalid amount. ' .
  353. 'Include dollar sign, commas, and cents.',
  354. 'fractional' => false,
  355. )
  356. );
  357. ]]></programlisting>
  358. </example>
  359. </sect3>
  360. <sect3 id="zend.dojo.form.elements.dateTextBox">
  361. <title>DateTextBox</title>
  362. <para>
  363. DateTextBox establece un calendario desplegable (drop-down) para
  364. seleccionar una fecha, así como validación y formateo de fechas del
  365. lado del clente.
  366. </para>
  367. <para>
  368. Internamente, DateTextBox deriva de <link
  369. linkend="zend.dojo.form.elements.validationTextBox">ValidationTextBox</link>
  370. y <link linkend="zend.dojo.form.elements.textBox">TextBox</link>;
  371. todos los métodos disponibles a esas clases están disponibles.
  372. Además, los siguientes métodos pueden utilizarse para establecer
  373. restricciones individuales:
  374. </para>
  375. <itemizedlist>
  376. <listitem><para>
  377. <code>setAmPm($flag)</code> y <code>getAmPm()</code>: Cuándo
  378. usar o no los strings AM/PM en los fortmatos de horas.
  379. </para></listitem>
  380. <listitem><para>
  381. <code>setStrict($flag)</code> y <code>getStrict()</code>:
  382. Cuándo usar o no el matching para una expresión regular estricta
  383. al validar la entrada. Si es falso, que es el valor por defecto,
  384. será indulgente sobre espacios en blanco y algunas abreviaturas.
  385. </para></listitem>
  386. <listitem><para>
  387. <code>setLocale($locale)</code> y <code>getLocale()</code>:
  388. Establece y recupera la localidad a utilizar con este elemento
  389. específico.
  390. </para></listitem>
  391. <listitem><para>
  392. <code>setDatePattern($pattern)</code> y
  393. <code>getDatePattern()</code>: provee y recupera el <ulink
  394. url="http://www.unicode.org/reports/tr35/#Date_Format_Patterns"> patrón
  395. de formato de fechas unicode</ulink> para el formateo de
  396. fechas.
  397. </para></listitem>
  398. <listitem><para>
  399. <code>setFormatLength($formatLength)</code> y
  400. <code>getFormatLength()</code>: proporciona y recupera la
  401. longitud del tipo de formato a usar; debe ser uno de los
  402. siguientes: "long", "short", "medium" o "full".
  403. </para></listitem>
  404. <listitem><para>
  405. <code>setSelector($selector)</code> y
  406. <code>getSelector()</code>: proporciona y recupera el estilo del
  407. selector; debe ser "date" o "time".
  408. </para></listitem>
  409. </itemizedlist>
  410. <example id="zend.dojo.form.elements.dateTextBox.example">
  411. <title>Ejemplo de Uso del Elemento DateTextBox dijit</title>
  412. <programlisting role="php"><![CDATA[
  413. $form->addElement(
  414. 'DateTextBox',
  415. 'foo',
  416. array(
  417. 'label' => 'Date:',
  418. 'required' => true,
  419. 'invalidMessage' => 'Invalid date specified.',
  420. 'formatLength' => 'long',
  421. )
  422. );
  423. ]]></programlisting>
  424. </example>
  425. </sect3>
  426. <sect3 id="zend.dojo.form.elements.editor">
  427. <title>Editor</title>
  428. <para>
  429. Editor proporciona un editor WYSIWYG que puede ser utilizado tanto
  430. para crear como para editar contenidos HTML ricos.
  431. dijit.Editor es pluggable y podrá ampliarse con plugins
  432. personalizados si lo desea; para más detalles vea en
  433. <ulink url="http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/advanced-editing-and-display/editor-rich-text">
  434. la documentación de dijit.Editor</ulink>.
  435. </para>
  436. <para>
  437. El elemento form de Editor proporciona un número de accessors y
  438. mutators para manipular diversos parámetros dijit, tal como sigue:
  439. </para>
  440. <itemizedlist>
  441. <listitem>
  442. <para>
  443. <emphasis>captureEvents</emphasis> son eventos que se
  444. conectan al área de edición en si.
  445. Los siguientes accessors y mutators están disponibles para
  446. manipular la captura de eventos:
  447. </para>
  448. <itemizedlist>
  449. <listitem><para><code>addCaptureEvent($event)</code></para></listitem>
  450. <listitem><para><code>addCaptureEvents(array $events)</code></para></listitem>
  451. <listitem><para><code>setCaptureEvents(array $events)</code></para></listitem>
  452. <listitem><para><code>getCaptureEvents()</code></para></listitem>
  453. <listitem><para><code>hasCaptureEvent($event)</code></para></listitem>
  454. <listitem><para><code>removeCaptureEvent($event)</code></para></listitem>
  455. <listitem><para><code>clearCaptureEvents()</code></para></listitem>
  456. </itemizedlist>
  457. </listitem>
  458. <listitem>
  459. <para>
  460. <emphasis>events</emphasis> son eventos DOM estándar, como
  461. onClick, onKeyup, etc. Los siguientes accessors y mutators
  462. están disponibles para manipular eventos:
  463. </para>
  464. <itemizedlist>
  465. <listitem><para><code>addEvent($event)</code></para></listitem>
  466. <listitem><para><code>addEvents(array $events)</code></para></listitem>
  467. <listitem><para><code>setEvents(array $events)</code></para></listitem>
  468. <listitem><para><code>getEvents()</code></para></listitem>
  469. <listitem><para><code>hasEvent($event)</code></para></listitem>
  470. <listitem><para><code>removeEvent($event)</code></para></listitem>
  471. <listitem><para><code>clearEvents()</code></para></listitem>
  472. </itemizedlist>
  473. </listitem>
  474. <listitem>
  475. <para>
  476. <emphasis>plugins</emphasis> añaden funcionalidad al Editor
  477. -- herramientas adicionales para la barra de herramientas,
  478. estilos adicionales a permitir, etc.
  479. Los siguientes accessors y mutators están disponibles para
  480. manipular plugins:
  481. </para>
  482. <itemizedlist>
  483. <listitem><para><code>addPlugin($plugin)</code></para></listitem>
  484. <listitem><para><code>addPlugins(array $plugins)</code></para></listitem>
  485. <listitem><para><code>setPlugins(array $plugins)</code></para></listitem>
  486. <listitem><para><code>getPlugins()</code></para></listitem>
  487. <listitem><para><code>hasPlugin($plugin)</code></para></listitem>
  488. <listitem><para><code>removePlugin($plugin)</code></para></listitem>
  489. <listitem><para><code>clearPlugins()</code></para></listitem>
  490. </itemizedlist>
  491. </listitem>
  492. <listitem>
  493. <para>
  494. <emphasis>editActionInterval</emphasis> se utiliza para
  495. agrupar eventos para deshacer operaciones. Por defecto,
  496. este valor es de 3 segundos. El método
  497. <code>setEditActionInterval($interval)</code> puede ser
  498. usado para establecer el valor, mientras que
  499. <code>getEditActionInterval()</code> lo recuperará.
  500. </para>
  501. </listitem>
  502. <listitem>
  503. <para>
  504. <emphasis>focusOnLoad</emphasis> se utiliza para determinar
  505. si este editor en particular recibirá atención cuando la página
  506. se haya cargado. Por defecto, esto es falso. El método
  507. <code>setFocusOnLoad($flag)</code> puede usarse para
  508. establecer el valor, mientras que <code>getFocusOnLoad()</code>
  509. lo recuperará.
  510. </para>
  511. </listitem>
  512. <listitem>
  513. <para>
  514. <emphasis>height</emphasis> especifica la altura del editor;
  515. por defecto, es de 300px. El método
  516. <code>setHeight($height)</code> puede ser utilizado para
  517. establecer el valor, mientras que <code>getHeight()</code>
  518. lo recupera.
  519. </para>
  520. </listitem>
  521. <listitem>
  522. <para>
  523. <emphasis>inheritWidth</emphasis> se utiliza para determinar
  524. si el editor utilizará el ancho del contenedor padre o
  525. simplemente toma por defecto el 100% del ancho.
  526. Por defecto, esto es falso (es decir, llenará el ancho de la
  527. ventana). El método <code>setInheritWidth($flag)</code>
  528. puede ser utilizado para establecer el valor, mientras que
  529. <code>getInheritWidth()</code> lo recuperará.
  530. </para>
  531. </listitem>
  532. <listitem>
  533. <para>
  534. <emphasis>minHeight</emphasis> indica la altura mínima del
  535. editor; por defecto, es de 1em. El método
  536. <code>setMinHeight($height)</code> puede ser utilizado para
  537. establecer el valor, mientras que <code>getMinHeight()</code>
  538. lo recuperará.
  539. </para>
  540. </listitem>
  541. <listitem>
  542. <para>
  543. <emphasis>styleSheets</emphasis> indica qué otras hojas de
  544. estilo CSS deberían ser utilizadas para incidir sobre la
  545. pantalla del Editor. Por defecto, ninguna está registrada,
  546. y hereda la página de estilos. Los siguientes accessors
  547. y mutators están disponibles para manipular al editor de
  548. hojas de estilo (stylesheets):
  549. </para>
  550. <itemizedlist>
  551. <listitem><para><code>addStyleSheet($styleSheet)</code></para></listitem>
  552. <listitem><para><code>addStyleSheets(array $styleSheets)</code></para></listitem>
  553. <listitem><para><code>setStyleSheets(array $styleSheets)</code></para></listitem>
  554. <listitem><para><code>getStyleSheets()</code></para></listitem>
  555. <listitem><para><code>hasStyleSheet($styleSheet)</code></para></listitem>
  556. <listitem><para><code>removeStyleSheet($styleSheet)</code></para></listitem>
  557. <listitem><para><code>clearStyleSheets()</code></para></listitem>
  558. </itemizedlist>
  559. </listitem>
  560. </itemizedlist>
  561. <example id="zend.dojo.form.elements.editor.example">
  562. <title>Ejemplo de Uso del Elemento Editor dijit</title>
  563. <programlisting role="php"><![CDATA[
  564. $form->addElement('editor', 'content', array(
  565. 'plugins' => array('undo', '|', 'bold', 'italic'),
  566. 'editActionInterval' => 2,
  567. 'focusOnLoad' => true,
  568. 'height' => '250px',
  569. 'inheritWidth' => true,
  570. 'styleSheets' => array('/js/custom/editor.css'),
  571. ));]></programlisting>
  572. </example>
  573. </sect3>
  574. <sect3 id="zend.dojo.form.elements.horizontalSlider">
  575. <title>HorizontalSlider</title>
  576. <para>
  577. HorizontalSlider proporciona un widget deslizador de UI para
  578. seleccionar un valor numérico dentro de un rango.
  579. Internamente, establece el valor de un elemento oculto que es
  580. enviado por el formulario.
  581. </para>
  582. <para>
  583. HorizontalSlider proviene del elemento abstracto <link
  584. linkend="zend.dojo.form.elements.slider">Slider dijit</link>.
  585. Además, tiene una variedad de métodos de ajuste y configuración
  586. de reglas deslizantes y etiquetas para esas reglas.
  587. </para>
  588. <itemizedlist>
  589. <listitem>
  590. <para>
  591. <code>setTopDecorationDijit($dijit)</code> y
  592. <code>setBottomDecorationDijit($dijit)</code>: establecen el
  593. nombre de la dijit a utilizar bien para la parte superior o
  594. inferior de la barra deslizante.
  595. Esto no debería incluir el prefijo "dijit.form.",
  596. sino sólo el último nombre -- "HorizontalRule" o
  597. "HorizontalRuleLabels".
  598. </para>
  599. </listitem>
  600. <listitem>
  601. <para>
  602. <code>setTopDecorationContainer($container)</code> y
  603. <code>setBottomDecorationContainer($container)</code>:
  604. especifican el nombre a utilizar para el elemento
  605. contenedor de las reglas; por ejemplo 'Toprule',
  606. 'topContainer', etc.
  607. </para>
  608. </listitem>
  609. <listitem>
  610. <para>
  611. <code>setTopDecorationLabels(array $labels)</code> y
  612. <code>setBottomDecorationLabels(array $labels)</code>:
  613. establecen las etiquetas a usar por uno de los tipos
  614. RuleLabels dijit. Debe ser un array indexado; especificar un
  615. único espacio vacío para saltar a la posición de una
  616. determinada etiqueta (como ser al comienzo o al final).
  617. </para>
  618. </listitem>
  619. <listitem>
  620. <para>
  621. <code>setTopDecorationParams(array $params)</code> y
  622. <code>setBottomDecorationParams(array $params)</code>:
  623. parámetros dijit para utilizar al configurar la Regla o
  624. RuleLabels dijit.
  625. </para>
  626. </listitem>
  627. <listitem>
  628. <para>
  629. <code>setTopDecorationAttribs(array $attribs)</code> y
  630. <code>setBottomDecorationAttribs(array $attribs)</code>:
  631. atributos HTML para especificar una Regla dada o el
  632. elemento contenedor de HTML RuleLabels.
  633. </para>
  634. </listitem>
  635. <listitem>
  636. <para>
  637. <code>getTopDecoration()</code> y
  638. <code>getBottomDecoration()</code>: recuperar todos los
  639. metadatos para una determinada Regla o definición de
  640. RuleLabels, tal como han sido provistos por los mutators
  641. anteriores.
  642. </para>
  643. </listitem>
  644. </itemizedlist>
  645. <example id="zend.dojo.form.elements.horizontalSlider.example">
  646. <title>Ejemplo de Uso del Elemento HorizontalSlider dijit</title>
  647. <para>
  648. Lo siguiente creará un deslizador horizontal de selección con
  649. valores enteros que van desde -10 a 10. La parte superior tendrá
  650. etiquetas en las marcas del 20%, 40%, 60%, y 80%.
  651. La parte inferior será una regla con marcas en el 0, 50%, y 100%.
  652. Cada vez que se cambie el valor, el elemento oculto almacenará
  653. el valor actualizado.
  654. </para>
  655. <programlisting role="php"><![CDATA[
  656. $form->addElement(
  657. 'HorizontalSlider',
  658. 'horizontal',
  659. array(
  660. 'label' => 'HorizontalSlider',
  661. 'value' => 5,
  662. 'minimum' => -10,
  663. 'maximum' => 10,
  664. 'discreteValues' => 11,
  665. 'intermediateChanges' => true,
  666. 'showButtons' => true,
  667. 'topDecorationDijit' => 'HorizontalRuleLabels',
  668. 'topDecorationContainer' => 'topContainer',
  669. 'topDecorationLabels' => array(
  670. ' ',
  671. '20%',
  672. '40%',
  673. '60%',
  674. '80%',
  675. ' ',
  676. ),
  677. 'topDecorationParams' => array(
  678. 'container' => array(
  679. 'style' => 'height:1.2em; font-size=75%;color:gray;',
  680. ),
  681. 'list' => array(
  682. 'style' => 'height:1em; font-size=75%;color:gray;',
  683. ),
  684. ),
  685. 'bottomDecorationDijit' => 'HorizontalRule',
  686. 'bottomDecorationContainer' => 'bottomContainer',
  687. 'bottomDecorationLabels' => array(
  688. '0%',
  689. '50%',
  690. '100%',
  691. ),
  692. 'bottomDecorationParams' => array(
  693. 'list' => array(
  694. 'style' => 'height:1em; font-size=75%;color:gray;',
  695. ),
  696. ),
  697. )
  698. );
  699. ]]></programlisting>
  700. </example>
  701. </sect3>
  702. <sect3 id="zend.dojo.form.elements.numberSpinner">
  703. <title>NumberSpinner</title>
  704. <para>
  705. Un número spinner es un elemento de texto para introducir valores
  706. numéricos; también incluye elementos de incremento y decremento
  707. del valor por una cantidad fija.
  708. </para>
  709. <para>
  710. Se encuentran disponibles los siguientes métodos:
  711. </para>
  712. <itemizedlist>
  713. <listitem><para>
  714. <code>setDefaultTimeout($timeout)</code> y
  715. <code>getDefaultTimeout()</code>: establece y recupera el
  716. tiempo de espera predeterminado en milisegundos, entre cuando
  717. el botón se mantiene presionado y cambia el valor.
  718. </para></listitem>
  719. <listitem><para>
  720. <code>setTimeoutChangeRate($rate)</code> y
  721. <code>getTimeoutChangeRate()</code>: establece y recupera la
  722. tasa en milisegundos, en la que se harán cambios cuando un botón
  723. se mantiene presionado.
  724. </para></listitem>
  725. <listitem><para>
  726. <code>setLargeDelta($delta)</code> y
  727. <code>getLargeDelta()</code>: establece y recupera la cantidad
  728. en la que el valor numérico debería cambiar cuando un botón se
  729. mantiene presionado.
  730. </para></listitem>
  731. <listitem><para>
  732. <code>setSmallDelta($delta)</code> y
  733. <code>getSmallDelta()</code>: establece y recupera el delta con
  734. la que el número debería cambiar cuando se pulsa un botón una vez.
  735. </para></listitem>
  736. <listitem><para>
  737. <code>setIntermediateChanges($flag)</code> y
  738. <code>getIntermediateChanges()</code>: establece y recupera el
  739. flag que indica si debe o no ser mostrado cada cambio de valor
  740. cuando un botón se mantiene presionado.
  741. </para></listitem>
  742. <listitem><para>
  743. <code>setRangeMessage($message)</code> y
  744. <code>getRangeMessage()</code>: establece y recupera el mensaje
  745. indicando el rango de valores disponibles.
  746. </para></listitem>
  747. <listitem><para>
  748. <code>setMin($value)</code> y <code>getMin()</code>:
  749. establece y recupera el valor mínimo posible.
  750. </para></listitem>
  751. <listitem><para>
  752. <code>setMax($value)</code> y <code>getMax()</code>:
  753. establece y recupera el valor máximo posible.
  754. </para></listitem>
  755. </itemizedlist>
  756. <example id="zend.dojo.form.elements.numberSpinner.example">
  757. <title>Ejemplo de Uso del Elemento NumberSpinner dijit</title>
  758. <programlisting role="php"><![CDATA[
  759. $form->addElement(
  760. 'NumberSpinner',
  761. 'foo',
  762. array(
  763. 'value' => '7',
  764. 'label' => 'NumberSpinner',
  765. 'smallDelta' => 5,
  766. 'largeDelta' => 25,
  767. 'defaultTimeout' => 500,
  768. 'timeoutChangeRate' => 100,
  769. 'min' => 9,
  770. 'max' => 1550,
  771. 'places' => 0,
  772. 'maxlength' => 20,
  773. )
  774. );
  775. ]]></programlisting>
  776. </example>
  777. </sect3>
  778. <sect3 id="zend.dojo.form.elements.numberTextBox">
  779. <title>NumberTextBox</title>
  780. <para>
  781. Un cuadro de texto numérico es un elemento de texto de introducción
  782. de valores numéricos; a diferencia de NumberSpinner, se introducen
  783. manualmente. Se pueden proporcionar validaciones y restricciones para
  784. garantizar que el número permanece en un rango o formato particular.
  785. </para>
  786. <para>
  787. Internmente, NumberTextBox proviene de <link
  788. linkend="zend.dojo.form.elements.validationTextBox">ValidationTextBox</link>
  789. y <link linkend="zend.dojo.form.elements.textBox">TextBox</link>;
  790. todos los métodos disponibles a esas clases están disponibles.
  791. Además, los siguientes métodos pueden utilizarse para establecer
  792. restricciones individuales:
  793. </para>
  794. <itemizedlist>
  795. <listitem><para>
  796. <code>setLocale($locale)</code> y <code>getLocale()</code>:
  797. especifica y recupera un "locale" determinado o alternativo para
  798. usar con este dijit.
  799. </para></listitem>
  800. <listitem><para>
  801. <code>setPattern($pattern)</code> y
  802. <code>getPattern()</code>: establece y recupera un <ulink
  803. url="http://www.unicode.org/reports/tr35/#Number_Format_Patterns">
  804. patrón de formato numérico </ulink> a usar en el formateo de
  805. números.
  806. </para></listitem>
  807. <listitem><para>
  808. <code>setType($type)</code> y <code>getType()</code>:
  809. establece y recupera el tipo de formato numérico a utilizar
  810. (deberán ser uno de 'decimal', 'percent', o 'currency').
  811. </para></listitem>
  812. <listitem><para>
  813. <code>setPlaces($places)</code> y <code>getPlaces()</code>:
  814. establece y recupera el número de decimales que soportará.
  815. </para></listitem>
  816. <listitem><para>
  817. <code>setStrict($flag)</code> y <code>getStrict()</code>:
  818. establece y recupera el valor estricto del flag, que indica
  819. cuánta indulgencia es permitida en relación con espacios en
  820. blanco y con caracteres no numéricos.
  821. </para></listitem>
  822. </itemizedlist>
  823. <example id="zend.dojo.form.elements.numberTextBox.example">
  824. <title>Ejemplo de Uso del Elemento NumberTextBox dijit</title>
  825. <programlisting role="php"><![CDATA[
  826. $form->addElement(
  827. 'NumberTextBox',
  828. 'elevation',
  829. array(
  830. 'label' => 'NumberTextBox',
  831. 'required' => true,
  832. 'invalidMessage' => 'Invalid elevation.',
  833. 'places' => 0,
  834. 'constraints' => array(
  835. 'min' => -20000,
  836. 'max' => 20000,
  837. ),
  838. )
  839. );
  840. ]]></programlisting>
  841. </example>
  842. </sect3>
  843. <sect3 id="zend.dojo.form.elements.passwordTextBox">
  844. <title>PasswordTextBox</title>
  845. <para>
  846. PasswordTextBox es simplemente un ValidationTextBox que está ligado
  847. a una contraseña; su único objetivo es permitir la entrada de texto
  848. de contraseñas de dijit que también proporciona validación del
  849. lado del cliente.
  850. </para>
  851. <para>
  852. Internmente, NumberTextBox proviene de <link
  853. linkend="zend.dojo.form.elements.validationTextBox">ValidationTextBox</link>
  854. y <link linkend="zend.dojo.form.elements.textBox">TextBox</link>;
  855. todos los métodos disponibles a esas clases están disponibles.
  856. </para>
  857. <example id="zend.dojo.form.elements.passwordTextBox.example">
  858. <title>Ejemplo de Uso del Elemento PasswordTextBox dijit</title>
  859. <programlisting role="php"><![CDATA[
  860. $form->addElement(
  861. 'PasswordTextBox',
  862. 'password',
  863. array(
  864. 'label' => 'Password',
  865. 'required' => true,
  866. 'trim' => true,
  867. 'lowercase' => true,
  868. 'regExp' => '^[a-z0-9]{6,}$',
  869. 'invalidMessage' => 'Invalid password; ' .
  870. 'must be at least 6 alphanumeric characters',
  871. )
  872. );
  873. ]]></programlisting>
  874. </example>
  875. </sect3>
  876. <sect3 id="zend.dojo.form.elements.radioButton">
  877. <title>RadioButton</title>
  878. <para>
  879. RadioButton envuelve a elementos standard de entrada tipo radio para
  880. brindar un look-and-feel consistente con otros dojo dijits.
  881. </para>
  882. <para>
  883. RadioButton se extiende desde DijitMulti, que le permite especificar
  884. la selección de opciones vía los métodos
  885. <code>setMultiOptions()</code> y <code>setMultiOption()</code>.
  886. </para>
  887. <para>
  888. Por defecto, este elemento registra un validador <code>InArray</code>
  889. que valida contra las calves del array de las opciones registradas.
  890. Puede desactivar este comportamiento ya sea llamando a
  891. <code>setRegisterInArrayValidator(false)</code>, o pasando un valor
  892. falso a la clave de configuración <code>registerInArrayValidator</code>.
  893. </para>
  894. <example id="zend.dojo.form.elements.radioButton.example">
  895. <title>Ejemplo de Uso del Elemento RadioButton dijit</title>
  896. <programlisting role="php"><![CDATA[
  897. $form->addElement(
  898. 'RadioButton',
  899. 'foo',
  900. array(
  901. 'label' => 'RadioButton',
  902. 'multiOptions' => array(
  903. 'foo' => 'Foo',
  904. 'bar' => 'Bar',
  905. 'baz' => 'Baz',
  906. ),
  907. 'value' => 'bar',
  908. )
  909. );
  910. ]]></programlisting>
  911. </example>
  912. </sect3>
  913. <sect3 id="zend.dojo.form.elements.simpletextarea">
  914. <title>SimpleTextarea</title>
  915. <para>
  916. SimpleTextarea actúa principalmente como un textarea estándar de HTML.
  917. Sin embargo, no permite establecer filas ni columnas.
  918. En su lugar, el ancho de textarea debe especificarse utilizando
  919. medidas CSS estándar. A diferencia de Textarea, esta no aumentará
  920. automáticamente.
  921. </para>
  922. <example id="zend.dojo.form.elements.simpletextarea.example">
  923. <title>Ejemplo de Uso del Elemento SimpleTextarea dijit</title>
  924. <programlisting role="php"><![CDATA[
  925. $form->addElement(
  926. 'SimpleTextarea',
  927. 'simpletextarea',
  928. array(
  929. 'label' => 'SimpleTextarea',
  930. 'required' => true,
  931. 'style' => 'width: 80em; height: 25em;',
  932. )
  933. );
  934. ]]></programlisting>
  935. </example>
  936. </sect3>
  937. <sect3 id="zend.dojo.form.elements.slider">
  938. <title>Elemento abstracto Slider</title>
  939. <para>
  940. Slider es un elemento abstracto que proviene de ambos
  941. <link linkend="zend.dojo.form.elements.horizontalSlider">HorizontalSlider</link>
  942. y
  943. <link linkend="zend.dojo.form.elements.verticalSlider">VerticalSlider</link>.
  944. Expone una serie de métodos comunes para configurar sus deslizadores,
  945. incluyendo a:
  946. </para>
  947. <itemizedlist>
  948. <listitem><para>
  949. <code>setClickSelect($flag)</code> y
  950. <code>getClickSelect()</code>: establece y recupera el flag
  951. que indica cuando al presionar el botón deslizante cambia o no
  952. el valor.
  953. </para></listitem>
  954. <listitem><para>
  955. <code>setIntermediateChanges($flag)</code> y
  956. <code>getIntermediateChanges()</code>: establece y recupera el
  957. flag que indica si dijit enviará o no una notificación sobre
  958. cada evento de cambio del deslizador.
  959. </para></listitem>
  960. <listitem><para>
  961. <code>setShowButtons($flag)</code> y
  962. <code>getShowButtons()</code>: establece y recupera el flag que
  963. indica si los botones de uno u otro extremo se mostrarán o no;
  964. si es así, el usuario puede hacer clic sobre éstos para cambiar
  965. el valor de la barra deslizante.
  966. </para></listitem>
  967. <listitem><para>
  968. <code>setDiscreteValues($value)</code> y
  969. <code>getDiscreteValues()</code>: establece y recupera el número
  970. de valores discretos representados por el deslizador.
  971. </para></listitem>
  972. <listitem><para>
  973. <code>setMaximum($value)</code> y <code>getMaximum()</code>:
  974. establece y recupera el valor máximo del deslizador.
  975. </para></listitem>
  976. <listitem><para>
  977. <code>setMinimum($value)</code> y <code>getMinimum()</code>:
  978. establece y recupera el valor mínimo del deslizador.
  979. </para></listitem>
  980. <listitem><para>
  981. <code>setPageIncrement($value)</code> y
  982. <code>getPageIncrement()</code>: establece la cantidad en que
  983. cambiará el deslizador por eventos del teclado.
  984. </itemizedlist>
  985. <para>
  986. Ejemplos de uso provistos con cada clase extendida concretamente.
  987. </para>
  988. </sect3>
  989. <sect3 id="zend.dojo.form.elements.submitButton">
  990. <title>SubmitButton</title>
  991. <para>
  992. Si bien no hay Dijit llamado SubmitButton, incluimos uno aquí para
  993. proporcionar un botón dijit capaz de enviar un formulario sin que se
  994. exijan ligaduras con javascript.
  995. Funciona exactamente igual que el
  996. <link linkend="zend.dojo.form.elements.button">Button dijit</link>.
  997. </para>
  998. <example id="zend.dojo.form.elements.submitButton.example">
  999. <title>Ejemplo de Uso del Elemento SubmitButton dijit</title>
  1000. <programlisting role="php"><![CDATA[
  1001. $form->addElement(
  1002. 'SubmitButton',
  1003. 'foo',
  1004. array(
  1005. 'required' => false,
  1006. 'ignore' => true,
  1007. 'label' => 'Submit Button!',
  1008. )
  1009. );
  1010. ]]></programlisting>
  1011. </example>
  1012. </sect3>
  1013. <sect3 id="zend.dojo.form.elements.textBox">
  1014. <title>TextBox</title>
  1015. <para>
  1016. Textbox se incluyó principalmente para proporcionar una entrada de
  1017. texto con apariencia coherente y con el look-and-feel de los demás dijits.
  1018. Sin embargo, también incluye algunas pequeñas capacidades de
  1019. filtrado y validación, representadas en los métodos siguientes:
  1020. </para>
  1021. <itemizedlist>
  1022. <listitem><para>
  1023. <code>setLowercase($flag)</code> y
  1024. <code>getLowercase()</code>: establece y recupera el flag que
  1025. indica si la entrada debe o no ser presentada en minúsculas.
  1026. </para></listitem>
  1027. <listitem><para>
  1028. <code>setPropercase($flag)</code> y
  1029. <code>getPropercase()</code>: establece y recupera el flag que
  1030. indica si la entrada debe ser o no ser presentada como Proper
  1031. Case.
  1032. </para></listitem>
  1033. <listitem><para>
  1034. <code>setUppercase($flag)</code> y <code>getUppercase()</code>:
  1035. establece y recupera el flag que indica si la entrada debe ser
  1036. presentada como mayúsculas (UPPERCASE).
  1037. </para></listitem>
  1038. <listitem><para>
  1039. <code>setTrim($flag)</code> y <code>getTrim()</code>:
  1040. establece y recupera el flag que indica si los espacios al
  1041. comienzo o al final deben ser eliminados o no.
  1042. </para></listitem>
  1043. <listitem><para>
  1044. <code>setMaxLength($length)</code> y
  1045. <code>getMaxLength()</code>: establece y recupera la longitud
  1046. máxima del input.
  1047. </para></listitem>
  1048. </itemizedlist>
  1049. <example id="zend.dojo.form.elements.textBox.example">
  1050. <title>Ejemplo de Uso del Elemento TextBox dijit</title>
  1051. <programlisting role="php"><![CDATA[
  1052. $form->addElement(
  1053. 'TextBox',
  1054. 'foo',
  1055. array(
  1056. 'value' => 'some text',
  1057. 'label' => 'TextBox',
  1058. 'trim' => true,
  1059. 'propercase' => true,
  1060. )
  1061. );
  1062. ]]></programlisting>
  1063. </example>
  1064. </sect3>
  1065. <sect3 id="zend.dojo.form.elements.textarea">
  1066. <title>Textarea</title>
  1067. <para>
  1068. Textarea actúa principalmente como un textarea estándar de HTML.
  1069. Sin embargo, no permite establecer filas y columnas.
  1070. En su lugar, el ancho de la textarea debe especificarse utilizando
  1071. medidas CSS estándar; las filas debe omitirse totalmente.
  1072. Luego, la textarea crecerá verticalmente tanto como texto se añada
  1073. a ella.
  1074. </para>
  1075. <example id="zend.dojo.form.elements.textarea.example">
  1076. <title>Ejemplo de Uso del Elemento Textarea dijit</title>
  1077. <programlisting role="php"><![CDATA[
  1078. $form->addElement(
  1079. 'Textarea',
  1080. 'textarea',
  1081. array(
  1082. 'label' => 'Textarea',
  1083. 'required' => true,
  1084. 'style' => 'width: 200px;',
  1085. )
  1086. );
  1087. ]]></programlisting>
  1088. </example>
  1089. </sect3>
  1090. <sect3 id="zend.dojo.form.elements.timeTextBox">
  1091. <title>TimeTextBox</title>
  1092. <para>
  1093. TimeTextBox es una entrada de texto que proporciona una lista
  1094. desplegable (drop-down) para seleccionar un tiempo (fecha y hora).
  1095. La lista desplegable, puede ser configurada para mostrar una cierta
  1096. ventana de tiempo, con incrementos especificados.
  1097. </para>
  1098. <para>
  1099. Internamente, TimeTextBox proviene de <link
  1100. linkend="zend.dojo.form.elements.dateTextBox">DateTextBox</link>,
  1101. <link
  1102. linkend="zend.dojo.form.elements.validationTextBox">ValidationTextBox</link>
  1103. y <link linkend="zend.dojo.form.elements.textBox">TextBox</link>;
  1104. todos los métodos disponibles a esas clases están disponibles.
  1105. Además, los siguientes métodos pueden utilizarse para establecer
  1106. restricciones individuales:
  1107. </para>
  1108. <itemizedlist>
  1109. <listitem><para>
  1110. <code>setTimePattern($pattern)</code> y
  1111. <code>getTimePattern()</code>: establece y recupera el <ulink
  1112. url="http://www.unicode.org/reports/tr35/#Date_Format_Patterns">patrón
  1113. de formato de fecha y hora unicode</ulink> para el formato
  1114. correspondiente.
  1115. </para></listitem>
  1116. <listitem><para>
  1117. <code>setClickableIncrement($format)</code> y
  1118. <code>getClickableIncrement()</code>: establece y recupera el
  1119. string <ulink
  1120. url="http://en.wikipedia.org/wiki/ISO_8601">ISO-8601</ulink>
  1121. representando la cantidad de tiempo a incrementar cada vez que
  1122. se recolecta un elemento clickable.
  1123. </para></listitem>
  1124. <listitem><para>
  1125. <code>setVisibleIncrement($format)</code> y
  1126. <code>getVisibleIncrement()</code>: establece y recupera el
  1127. incremento visible en el selector de tiempo; debe seguir los
  1128. formatos ISO-8601.
  1129. </para></listitem>
  1130. <listitem><para>
  1131. <code>setVisibleRange($format)</code> y
  1132. <code>getVisibleRange()</code>: establece y recupera el intervalo
  1133. de tiempo visible en el selector de tiempo en cualquier momento;
  1134. debe seguir los formatos ISO-8601.
  1135. </para></listitem>
  1136. </itemizedlist>
  1137. <example id="zend.dojo.form.elements.timeTextBox.example">
  1138. <title>Ejemplo de Uso del Elemento TimeTextBox dijit</title>
  1139. <para>
  1140. Lo siguiente creará un TimeTextBox que muestra 2 horas a la vez,
  1141. con incrementos de 10 minutos.
  1142. </para>
  1143. <programlisting role="php"><![CDATA[
  1144. $form->addElement(
  1145. 'TimeTextBox',
  1146. 'foo',
  1147. array(
  1148. 'label' => 'TimeTextBox',
  1149. 'required' => true,
  1150. 'visibleRange' => 'T04:00:00',
  1151. 'visibleIncrement' => 'T00:10:00',
  1152. 'clickableIncrement' => 'T00:10:00',
  1153. )
  1154. );
  1155. ]]></programlisting>
  1156. </example>
  1157. </sect3>
  1158. <sect3 id="zend.dojo.form.elements.validationTextBox">
  1159. <title>ValidationTextBox</title>
  1160. <para>
  1161. ValidationTextBox ofrece la posibilidad de añadir validaciones y
  1162. limitaciones a una entrada de texto. Internamente, proviene de
  1163. <link linkend="zend.dojo.form.elements.textBox">TextBox</link>,
  1164. y añade los siguientes accessors y mutators para manejar
  1165. parámetros dijit:
  1166. </para>
  1167. <itemizedlist>
  1168. <listitem><para>
  1169. <code>setInvalidMessage($message)</code> y
  1170. <code>getInvalidMessage()</code>: establece y recupera el mensaje
  1171. de tooltip para mostrar cuando el valor no se validó.
  1172. </para></listitem>
  1173. <listitem><para>
  1174. <code>setPromptMessage($message)</code> y
  1175. <code>getPromptMessage()</code>: establece y recupera el mensaje
  1176. de tooltip a mostrar para el uso del elemento.
  1177. </para></listitem>
  1178. <listitem><para>
  1179. <code>setRegExp($regexp)</code> y <code>getRegExp()</code>:
  1180. establece y recupera la expresión regular a utilizar para validar
  1181. el elemento. La expresión regular no necesita límites
  1182. (a diferencia de la familia de funciones preg*, de PHP).
  1183. </para></listitem>
  1184. <listitem><para>
  1185. <code>setConstraint($key, $value)</code> y
  1186. <code>getConstraint($key)</code>: establece y recupera
  1187. restricciones adicionales para utilizar al validar el elemento;
  1188. se utiliza principalmente con subclases. Las restricciones son
  1189. almacenados en la clave 'constraints' de los parámetros dijit.
  1190. </para></listitem>
  1191. <listitem><para>
  1192. <code>setConstraints(array $constraints)</code> y
  1193. <code>getConstraints()</code>: establece y recupera las
  1194. restricciones para utilizar al validar el elemento; se utiliza
  1195. principalmente con subclases.
  1196. </para></listitem>
  1197. <listitem><para>
  1198. <code>hasConstraint($key)</code>: prueba si una restricción
  1199. dada existe.
  1200. </para></listitem>
  1201. <listitem><para>
  1202. <code>removeConstraint($key)</code> y
  1203. <code>clearConstraints()</code>: elimina una restricción
  1204. individual o todas las restricciones para el elemento.
  1205. </para></listitem>
  1206. </itemizedlist>
  1207. <example id="zend.dojo.form.elements.validationTextBox.example">
  1208. <title>Ejemplo de Uso del Elemento ValidationTextBox dijit</title>
  1209. <para>
  1210. Lo siguiente creará un ValidationTextBox que requiere un solo
  1211. string compuesto exclusivamente por caracteres de palabra
  1212. (es decir, sin espacios, la mayor parte de la puntuación es inválida).
  1213. </para>
  1214. <programlisting role="php"><![CDATA[
  1215. $form->addElement(
  1216. 'ValidationTextBox',
  1217. 'foo',
  1218. array(
  1219. 'label' => 'ValidationTextBox',
  1220. 'required' => true,
  1221. 'regExp' => '[\w]+',
  1222. 'invalidMessage' => 'Invalid non-space text.',
  1223. )
  1224. );
  1225. ]]></programlisting>
  1226. </example>
  1227. </sect3>
  1228. <sect3 id="zend.dojo.form.elements.verticalSlider">
  1229. <title>VerticalSlider</title>
  1230. <para>
  1231. VerticalSlider es el hermano de <link
  1232. linkend="zend.dojo.form.elements.horizontalSlider">HorizontalSlider</link>,
  1233. y opera en todos los sentidos como ese elemento.
  1234. La única diferencia real es que los métodos 'top*' y 'bottom*' son
  1235. sustituidos por 'left*' y 'right*', y en lugar de utilizar
  1236. HorizontalRule y HorizontalRuleLabels, debe usarse VerticalRule y
  1237. VerticalRuleLabels.
  1238. </para>
  1239. <example id="zend.dojo.form.elements.verticalSlider.example">
  1240. <title>Ejemplo de Uso del Elemento VerticalSlider dijit</title>
  1241. <para>
  1242. Lo siguiente creará una selección deslizante vertical con valores
  1243. enteros desde -10 a 10. La izquierda tendrá etiquetas en las
  1244. marcas correspondientes al 20%, 40%, 60%, y 80%. El derecho
  1245. tiene reglas en un 0, 50%, y 100%. Cada vez que se cambie el
  1246. valor, se actualizará el elemento oculto que almacena el valor.
  1247. </para>
  1248. <programlisting role="php"><![CDATA[
  1249. $form->addElement(
  1250. 'VerticalSlider',
  1251. 'foo',
  1252. array(
  1253. 'label' => 'VerticalSlider',
  1254. 'value' => 5,
  1255. 'style' => 'height: 200px; width: 3em;',
  1256. 'minimum' => -10,
  1257. 'maximum' => 10,
  1258. 'discreteValues' => 11,
  1259. 'intermediateChanges' => true,
  1260. 'showButtons' => true,
  1261. 'leftDecorationDijit' => 'VerticalRuleLabels',
  1262. 'leftDecorationContainer' => 'leftContainer',
  1263. 'leftDecorationLabels' => array(
  1264. ' ',
  1265. '20%',
  1266. '40%',
  1267. '60%',
  1268. '80%',
  1269. ' ',
  1270. ),
  1271. 'rightDecorationDijit' => 'VerticalRule',
  1272. 'rightDecorationContainer' => 'rightContainer',
  1273. 'rightDecorationLabels' => array(
  1274. '0%',
  1275. '50%',
  1276. '100%',
  1277. ),
  1278. )
  1279. );
  1280. ]]></programlisting>
  1281. </example>
  1282. </sect3>
  1283. </sect2>
  1284. <!--
  1285. vim:se ts=4 sw=4 et:
  1286. -->