Grupos de archivos necesarios en layers ; una capa (layer) agrupa a todos archivos necesarios en un único archivo JS. (De ahí el nombre de esta sección.)

"Interns" no son archivos javascript usados por dijits (típicamente, archivos de plantilla). También están agrupados en el mismo archivo JS como la capa.

Pasa el archivo a través de ShrinkSafe, que elimina espacios en blanco y comentarios, así como acorta nombres de variables.

setView(Zend_View_Interface $view) : establecer una instancia de vista en el contenedor.

enable() : habilitar explícitamente la integración de Dojo.

disable() : deshabilitar la integración de Dojo.

isEnabled() : determinar cuándo la integración de Dojo está habilitada o no.

requireModule($module) : establecer una sentencia dojo.require

getModules() : determinar qué módulos han sido requeridos.

registerModulePath($module, $path) : registrar un path de un módulo personalizado de Dojo.

getModulePaths() : obtener la lista de los paths de módulos registrados.

addLayer($path) : añadir una capa (construcción personalizada) del path a utilizar.

getLayers() : conseguir una lista de todos los paths de capas registrados (construcción personalizada).

removeLayer($path) : eliminar la capa que concuerde con $path de la lista de capas registradas (construcción personalizada).

setCdnBase($url) : establecer la URL base para un CDN; típicamente, una de las Zend_Dojo::CDN_BASE_AOL o Zend_Dojo::CDN_BASE_GOOGLE , pero sólo necesita ser el string del URL antes del número de versión.

getCdnBase() : recuperar el CDN de la url base a utilizar.

setCdnVersion($version = null) : establecer cuál es la versión de Dojo a utilizar desde el CDN.

getCdnVersion() : recuperar que versión de Dojo será utilizada desde el CDN.

setCdnDojoPath($path) : establecer el path relativo a un archivo dojo.js o dojo.xd.js sobre un CDN; típicamente, uno de los Zend_Dojo::CDN_DOJO_PATH_AOL o Zend_Dojo::CDN_DOJO_PATH_GOOGLE , pero sólo debe ser el string del path detrás del número de versión.

getCdnDojoPath() : recuperar el último segmento del path del CDN de la url apuntando al archivo dojo.js.

useCdn() : decirle al contenedor que utilice el CDN; implícitamente permite integración.

setLocalPath($path) : decirle al contenedor el path a una instalación local de Dojo (deberá ser una ruta relativa al servidor, y contener el propio archivo dojo.js); implícitamente permite integración.

getLocalPath() : determinar qué ruta local a Dojo está siendo utilizada.

useLocalPath() : ¿la integración está utilizando un path local de Dojo?

setDjConfig(array $config) : conjunto de valores de configuración dojo/dijit (espera un array asociativo).

setDjConfigOption($option, $value) : establecer un único valor de configuración para dojo/dijit.

getDjConfig() : obtener todos los valores de configuración de dojo/dijit.

getDjConfigOption($option, $default = null) : conseguir un único valor de configuración de dojo/dijit.

addStylesheetModule($module) : agregar una hoja de estilo sobre la base del tema de un módulo.

getStylesheetModules() : obtener hojas de estilo registradas como temas de módulos.

addStylesheet($path) : agregar una hoja de estilo local para su uso con Dojo.

getStylesheets() : obtener hojas de estilo locales Dojo.

addOnLoad($spec, $function = null) : agregar un lambda para dojo.onLoad para llamadas. Si se pasa un argumento, se supone que que puede ser tanto el nombre de una función o dar por terminado javascript. Si se pasan dos argumentos, el primero se supone que es el nombre de la variable de la instancia de un objeto y el segundo ya sea un nombre de método en ese objeto o un cierre a utilizar con ese objeto.

prependOnLoad($spec, $function = null) : exactamente como addOnLoad() , excluyendo agregar al principio el comienzo de onLoad stack.

getOnLoadActions() : recuperar todas las acciones dojo.onLoad registradas con el contenedor. Esto será un array de arrays.

onLoadCaptureStart($obj = null) : capturar los datos que se utilizarán como lambda para dojo.onLoad(). Si se provee $obj, los códigos JS capturados serán considerados un cierre a utilizar con ese objeto Javascript.

onLoadCaptureEnd($obj = null) : finalizar la captura de datos para su uso con dojo.onLoad().

javascriptCaptureStart() : captura javascript arbitrario para ser incluido en Dojo JS (onLoad, require, etc. statements).

javascriptCaptureEnd() : finalizar la captura de javascript.

__toString() : emitir el contenedor a un string; muestra todo el estilo HTML y elementos del script.

AccordionContainer : dijit.layout.AccordionContainer. Apilará todos los cuadros juntos verticalmente; con un click en la barra del título de un cuadro, se expandirá y mostrará ese cuadro en particular.

<?php echo $view->accordionContainer(
    'foo',
    $content,
    array(
        'duration' => 200,
    ),
    array(
        'style' => 'width: 200px; height: 300px;',
    ),
); ?>

AccordionPane : dijit.layout.AccordionPane. Para su uso en AccordionContainer.

<?php echo $view->accordionPane(
    'foo',
    $content,
    array(
        'title' => 'Pane Title',
    ),
    array(
        'style' => 'background-color: lightgray;',
    ),
); ?>

BorderContainer : dijit.layout.BorderContainer. Logra diseños con cuadros opcionalmente redimensionables como se puede ver en una aplicación tradicional.

<?php echo $view->borderContainer(
    'foo',
    $content,
    array(
        'design' => 'headline',
    ),
    array(
        'style' => 'width: 100%; height: 100%',
    ),
); ?>

ContentPane : dijit.layout.ContentPane. Usarlo dentro de cualquier contenedor excepto AccordionContainer.

<?php echo $view->contentPane(
    'foo',
    $content,
    array(
        'title'  => 'Pane Title',
        'region' => 'left',
    ),
    array(
        'style' => 'width: 120px; background-color: lightgray;',
    ),
); ?>

SplitContainer : dijit.layout.SplitContainer. Permite cuadros de contenido redimensionables, discontinuado en Dojo en favor de BorderContainer.

<?php echo $view->splitContainer(
    'foo',
    $content,
    array(
        'orientation'  => 'horizontal',
        'sizerWidth'   => 7,
        'activeSizing' => true,
    ),
    array(
        'style' => 'width: 400px; height: 500px;',
    ),
); ?>

StackContainer : dijit.layout.StackContainer. Todos los cuadros dentro de un StackContainer se colocan en una pila; crea botones o funcionalidades a ser revelados uno a uno.

<?php echo $view->stackContainer(
    'foo',
    $content,
    array(),
    array(
        'style' => 'width: 400px; height: 500px; border: 1px;',
    ),
); ?>

TabContainer : dijit.layout.TabContainer. Todos los cuadros dentro de un TabContainer se colocan en una pila, con pestañas colocadas a un lado para cambiar entre ellos.

<?php echo $view->tabContainer(
    'foo',
    $content,
    array(),
    array(
        'style' => 'width: 400px; height: 500px; border: 1px;',
    ),
); ?>

captureStart($id, array $params = array(), array $attribs = array()) : inicia la captura del contenido a incluir en un contenedor. $params hace referencia a dijit params para utilizar con el contenedor, mientras que $attribs se refiere a cualquier atributo general HTML a utilizar.

Los contenedores pueden estar anidados durante la captura, mientras no hayan IDs duplicados .

captureEnd($id) : finalizar la captura del contenido a incluir en un contenedor. $id debe referirse a un id anteriormente utilizado con la llamada captureStart() . Regresa el string representando al contenedor y su contenido, como si simplemente pasara el contenido al ayudante mismo.

Button : dijit.form.Button. Muestra un botón de form.

<?php echo $view->button(
    'foo',
    'Show Me!',
    array('iconClass' => 'myButtons'),
); ?>

CheckBox : dijit.form.CheckBox. Muestra un checkbox. Acepta opcionalmente un quinto argumento, el array $checkedOptions , que puede contener:

Si $checkedOptions no fueron suministradas, se asume 1 y 0.

<?php echo $view->checkBox(
    'foo',
    'bar',
    array(),
    array(),
    array('checkedValue' => 'foo', 'unCheckedValue' => 'bar')
); ?>

ComboBox : dijit.layout.ComboBox. Los ComboBoxes son un híbrido entre un cuadro de selección y uno de texto con autocompletado. La diferencia fundamental es que puede escribir una opción que no está en la lista de las opciones disponibles, y que todavía considera válido el input. Opcionalmente acepta un quinto argumento, un array asociativo $options ; si lo hay, ComboBox será presentado como un select . Note también que la label values del array $options será devuelto al form -- y no los valores en si mismos.

Alternativamente, puede pasar información sobre un datastrore dojo.data para utilizar con el elemento. Si la hay, el ComboBox será presentado como un texto input , y traerá sus opciones vía ese datastore.

Para especificar un datastore, proporcionar una de las siguientes $params combinaciones de claves:

// Como un elemento select:
echo $view->comboBox(
    'foo',
    'bar',
    array(
        'autocomplete' => false,
    ),
    array(),
    array(
        'foo' => 'Foo',
        'bar' => 'Bar',
        'baz' => 'Baz',
    )
);

// Como en elemento habilitado de dojo.data:
echo $view->comboBox(
    'foo',
    'bar',
    array(
        'autocomplete' => false,
        'store'        => 'stateStore',
        'storeType'    => 'dojo.data.ItemFileReadStore',
        'storeParams'  => array('url' => '/js/states.json'),
    ),
);

CurrencyTextBox : dijit.form.CurrencyTextBox. Se hereda de ValidationTextBox, y proporciona validación de moneda del lado del cliente. Se espera que el parámetro dijit 'currency' será siempre proporcionado con el código adecuado de 3 caracteres de la moneda. También puede especificar cualquiera de los parámetros dijit válidos para ValidationTextBox y TextBox.

echo $view->currencyTextBox(
    'foo',
    '$25.00',
    array('currency' => 'USD'),
    array('maxlength' => 20)
);

$view->headMeta()->appendHttpEquiv('Content-Type',
                                   'text/html; charset=utf-8');

DateTextBox : dijit.form.DateTextBox. Es heredada de ValidationTextBox, y ofrece tanto validación de fechas de lado del cliente, así como un calendario desplegable desde el cual elegir una fecha. Puede especificar cualquiera de los parámetros dijit disponibles para ValidationTextBox o TextBox.

echo $view->dateTextBox(
    'foo',
    '2008-07-11',
    array('required' => true)
);

Editor : dijit.Editor. Proporciona un editor WYSIWYG mediante el cual los usuarios pueden crear o editar el contenido. dijit.Editor es un editor pluggable y extensible, con una variedad de parámetros que puede utilizar para personalización; para más detalles vea la documentación de dijit.Editor .

echo $view->editor('foo');

FilteringSelect : dijit.form.FilteringSelect. Similar a ComboBox, este es un híbrido de select/text que puede hacer una lista de opciones o aquellos retornados vía un dojo.data datastore. A diferencia de ComboBox, sin embargo, FilteringSelect no permite escribir una opción ni siquieraen en su lista. Además, opera como un select standard en que los valores de opción, no las etiquetas, son devueltos cuando el form se envía.

Por favor vea la información anterior sobre ComboBox para ejemplos y las opciones disponibles para definir datastores.

HorizontalSlider y VerticalSlider : dijit.form.HorizontalSlider y dijit.form.VerticalSlider. Los sliders permiten a los widgets de UI seleccionar números en un rango dado; las variantes son horizontales y verticales.

En lo más elemental, exigen los parámetros dijit 'minimum', 'maximum', y 'discreteValues'. Estos definen el rango de valores. Otras opciones comunes son las siguientes:

La implementación de Zend Framework crea un elemento oculto para guardar el valor del deslizador.

Opcionalmente puede desear mostrar una regla o etiquetas para el deslizador. Para hacerlo, se asignará uno o más de los parámetros dijit 'topDecoration' y/o 'bottomDecoration' (HorizontalSlider) o 'leftDecoration' y/o 'rightDecoration' (VerticalSlider). Cada uno de éstos espera las siguientes opciones:

echo $view->horizontalSlider(
    'foo',
    1,
    array(
        'minimum'             => -10,
        'maximum'             => 10,
        'discreteValues'      => 11,
        'intermediateChanges' => true,
        'showButtons'         => true,
        'topDecoration'       => array(
            'container' => 'topContainer'
            'dijit'     => 'HorizontalRuleLabels',
            'labels'    => array(
                ' ',
                '20%',
                '40%',
                '60%',
                '80%',
                ' ',
            ),
            'params' => array(
                'container' => array(
                    'style' => 'height:1.2em; font-size=75%;color:gray;',
                ),
                'labels' => array(
                    'style' => 'height:1em; font-size=75%;color:gray;',
                ),
            ),
        ),
        'bottomDecoration'    => array(
            'container' => 'bottomContainer'
            'labels'    => array(
                '0%',
                '50%',
                '100%',
            ),
            'params' => array(
                'container' => array(
                    'style' => 'height:1.2em; font-size=75%;color:gray;',
                ),
                'labels' => array(
                    'style' => 'height:1em; font-size=75%;color:gray;',
                ),
            ),
        ),
    )
);

NumberSpinner : dijit.form.NumberSpinner. Text box numérico para entrada, con botones para incremento y decremento.

Espera bien un array asociativo del parámetro dijit 'constraints' o simplemente las claves 'min', 'max', y 'places' (estas serían también las entradas esperadas del parámetro de restricciones). 'places' puede ser utilizada para indicar en cuánto se incrementará y decrementará el número giratorio.

echo $view->numberSpinner(
    'foo',
    5,
    array(
        'min'    => -10,
        'max'    => 10,
        'places' => 2,
    ),
    array(
        'maxlenth' => 3,
    )
);

NumberTextBox : dijit.form.NumberTextBox. NumberTextBox ofrece la capacidad de dar formato y mostrar entradas numéricas de una manera localizada, así como validar entradas numéricas, opcionalmente en contra de las restricciones dadas.

echo $view->numberTextBox(
    'foo',
    5,
    array(
        'places' => 4,
        'type'   => 'percent',
    ),
    array(
        'maxlength' => 20,
    )
);

PasswordTextBox : dijit.form.ValidationTextBox está atada a una contraseña. PasswordTextBox ofrece la posibilidad de crear una entrada para contraseña que adhiere al actual tema dijit, así como permitir la validación del lado del cliente.

echo $view->passwordTextBox(
    'foo',
    '',
    array(
        'required' => true,
    ),
    array(
        'maxlength' => 20,
    )
);

RadioButton : dijit.form.RadioButton. Una serie de opciones entre las que sólo una puede ser seleccionada. Esta se comporta en todos los sentidos como una de radio normal, pero tiene un look-and-feel consistente con otros dijits.

RadioButton acepta un cuarto argumento como opción, $options , un array asociativo de pares valor/etiqueta utilizado como opciones de radio. También puede pasar estos como la clave options de $attribs .

echo $view->radioButton(
    'foo',
    'bar',
    array(),
    array(),
    array(
        'foo' => 'Foo',
        'bar' => 'Bar',
        'baz' => 'Baz',
    )
);

SimpleTextarea : dijit.form.SimpleTextarea. Estos actuarán como textareas normales, pero se estilizan usando el tema actual de dijit. No necesita especificar los atributos ya sea de las filas o de las columnas; use ems o porcentajes del ancho y del alto en su lugar.

echo $view->simpleTextarea(
    'foo',
    'Start writing here...',
    array(),
    array('style' => 'width: 90%; height: 5ems;')
);

SubmitButton : un dijit.form.Button está atado a un elemento de entrada a enviar. Vea el ayudante de vista de Button para más detalles; la diferencia fundamental es que este botón puede enviar un form.

Textarea : dijit.form.Textarea. Éstas actuarán como textareas normales, salvo que en lugar de un determinado número de filas, se expanden a medida que el usuario tipea. El ancho debe especificarse mediante una regla de estilo.

echo $view->textarea(
    'foo',
    'Start writing here...',
    array(),
    array('style' => 'width: 300px;')
);

TextBox : dijit.form.TextBox. Este elemento está presente principalmente para proporcionar un look-and-feel común entre los diversos elementos dijit, y a ofrecer funcionalidades de base para otras clases derivadas de TextBox (ValidationTextBox, NumberTextBox, CurrencyTextBox, DateTextBox, y TimeTextBox).

El parámetro común de dijit para los flags incluyen 'lowercase' (emitido a minúsculas), 'uppercase' (emitido a mayúsculas), 'propercase' (emitido a Proper Case), y trim (elimina los espacios en blanco iniciales y finales); todos aceptan valores booleanos. Además, puede especificar los parámetros 'size' y 'maxLength'.

echo $view->textBox(
    'foo',
    'some text',
    array(
        'trim'       => true,
        'propercase' => true,
        'maxLength'  => 20,
    ),
    array(
        'size' => 20,
    )
);

TimeTextBox : dijit.form.TimeTextBox. También de la familia TextBox, TimeTextBox proporciona una selección desplazable drop down de la cantidad de veces que un usuario podrá seleccionar. Los parámetros Dijit le permiten especificar el tiempo disponible para incrementos en el select así como un rango visible de veces en disponibilidad.

echo $view->timeTextBox(
    'foo',
    '',
    array(
        'am.pm'            => true,
        'visibleIncrement' => 'T00:05:00', // 5-minute increments
        'visibleRange'     => 'T02:00:00', // show 2 hours of increments
    ),
    array(
        'size' => 20,
    )
);

ValidationTextBox : dijit.form.ValidateTextBox. Proporciona validaciones del lado del cliente para un elemento de texto. Se hereda desde TextBox.

Los parámetros comunes de dijit incluyen:

echo $view->validationTextBox(
    'foo',
    '',
    array(
        'required' => true,
        'regExp'   => '[\w]+',
        'invalidMessage' => 'No se permiten espacios o caracteres especiales',
        'promptMessage'  => 'Una palabra consiste de caracteres  ' .
                            'alfanuméricos y underscores solamente',
    ),
    array(
        'maxlength' => 20,
    )
);