Zend_Dojo-Form-Elements.xml 66 KB

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