12.3. Dojo 视图助手

把请求文件集中到 layers，layer 把所有的请求 文件集中成一个单个的 JS 文件。（Hence the name of this section.）

"Interns" non-javascript files used by dijits (typically, template files). These are also grouped in the same JS file as the layer.

通过 ShrinkSafe 传递文件，它剥离了空白字符和注释，还缩短了短变量名。

setView(Zend_View_Interface $view): 在容器中设置一个视图实例。

enable(): 显式地开启 Dojo 集成。

disable(): 关闭 Dojo 集成。

isEnabled(): 确定是否 Dojo 集成已经开启。

requireModule($module): 设置一条 dojo.require 语句。

getModules(): 确定模块 已经被请求。

registerModulePath($module, $path): 注册一个定制的 Dojo 模块路径。

getModulePaths(): 获得已注册模块路径列表。

addLayer($path): 添加一个 layer （定制） 路径。

getLayers(): 获得已注册的 layer 路径（定制）的列表。

removeLayer($path): 从已注册的 layers （定制）列表里删除匹配 $path 的 layer。

setCdnBase($url): 为 CDN 设置基础 URL； 一般地是 Zend_Dojo::CDN_BASE_AOL 或 Zend_Dojo::CDN_BASE_GOOGLE 其中之一， 但它只需要在版本号之前的 URL 字符串。

getCdnBase(): 获取基础 CDN url

setCdnVersion($version = null): 从 CDN 设置 Dojo 的版本。

getCdnVersion(): 从将要用的 CDN 获取 Dojo 的版本。

setCdnDojoPath($path): 在一个 CDN 中设置 dojo.js 或 dojo.xd.js 文件的相对路径 ； 一般地是 Zend_Dojo::CDN_DOJO_PATH_AOL 或 Zend_Dojo::CDN_DOJO_PATH_GOOGLE 其中之一，但 它只需要是带版本号的路径字符串。

getCdnDojoPath(): 获取最后的 CDN url 指向 dojo.js文件的路径段。

useCdn(): 告诉容器使用 CDN；显式地开启集成。

setLocalPath($path): 告诉容器指向本地 Dojo 安装（和服务器相关的路径，包括 dojo.js 文件自己） 的路径。显式地开启集成。

getLocalPath(): 确定使用哪个本地 Dojo 路径。

useLocalPath(): 是否集成使用 Dojo 本地路径？

setDjConfig(array $config): 设置 dojo/dijit 配置值（需要联合数组）。

setDjConfigOption($option, $value): 设置一单个的 dojo/dijit 配置值。

getDjConfig(): 获取所有的 dojo/dijit 配置值。

getDjConfigOption($option, $default = null): 获取一单个的 dojo/dijit 配置值。

addStylesheetModule($module): 基于模块主题添加风格。

getStylesheetModules(): 获取注册为模块主题的风格。

addStylesheet($path): 添加一个本地风格来和 Dojo 一起使用。

getStylesheets(): 获取本地 Dojo 风格。

addOnLoad($spec, $function = null): 为 dojo.onLoad 添加一个 lambda 来调用。如果传递一个参数，那就是 函数名或一个 javascript closure。如果传递两个参数，第一参数是 对象实例变量的名字，第二个参数是该对象的方法名或使用这个对象的 一个 closure。

getOnLoadActions(): 获取所有用容器注册的 dojo.onLoad 动作，将是一个数组的数组。

onLoadCaptureStart($obj = null): 为 dojo.onLoad() 抓取用做 lambda 的数据。如果提供了 $obj， 那么 JS 抓取代码被认为是一个和 Javascript 对象一起使用的 closure 。

onLoadCaptureEnd($obj = null): 停止为使用 dojo.onLoad() 抓取数据。

javascriptCaptureStart(): 抓取任意的 javascript 包含到 Dojo JS （onLoad、 require 等语句）。

javascriptCaptureEnd(): 停止抓取 javascript。

__toString(): 转换容器为字符串；解析所有的 HTMl 风格和脚本元素。

AccordionContainer：dijit.layout.AccordionContainer。 垂直堆放所有的 pane ，点击一个 pane 的 titlebar 就会展开并显示特定的 pane。

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

AccordionPane: dijit.layout.AccordionPane. 在 AccordionContainer 内使用。

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

BorderContainer：dijit.layout.BorderContainer。 用象传统程序中的可改变尺寸的 pane 来完成布局。

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

ContentPane: dijit.layout.ContentPane。 用在除了 AccordionContainer 以外的任何容器内部。

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

SplitContainer：dijit.layout.SplitContainer。 允许可变尺寸的内容 pane；在 Dojo 里废除转而使用 BorderContainer。

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

StackContainer：dijit.layout.StackContainer。 所有在 StackContainer 里的 pane 放在一个堆栈里，生成按钮或功能一次显示一个。

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

TabContainer：dijit.layout.TabContainer。 所有在 TabContainer 里的 pane 放在一个堆栈里，并带有 tab 的位置，用于切换。

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

captureStart($id, array $params = array(), array $attribs = array())： 开始抓取内容到容器。$params 是和容器一起使用的 dijit 参数， $attribs 指的是任何一般的 HTML 属性。

只要 ids 没有重复 ，容器在抓取的时候可以嵌套。

captureEnd($id)： 完成抓取内容到容器。$id 是指先前和 captureStart() 调用一起使用的 id。返回一个字符串表示容器和它的内容，就好像传递内容给助手自己。

Button: dijit.form.Button. 显示一个表单按钮

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

CheckBox：dijit.form.CheckBox. 显示一个 checkbox。接受可选的第五个参数，$checkedOptions 数组， 包含：

如果没有提供 $checkedOptions 就假定为 1 和 0 。

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

ComboBox：dijit.layout.ComboBox. 组合框是一个混合体，包括选择框和带有自动完成的文字框。 关键是在列表里没有相应的选项的时候可以手工输入，而且是有效的。 它接受可选的第五个参数：联合数组 $options；如果提供 了该参数，ComboBox 就当作 select 被解析。也要注意 $options 数组的 标签值 在表单中返回， 而不选项值自己。

另外，也可以传递关于和元素一起使用的 dojo.data 数据存储的信息。 如果提供该参数，ComboBox 就当作 input 被解析， 并且将通过那个数据存储来取出它的选项。

为了指定数据存储，请提供下列 $params 键组合之一：

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

// As a dojo.data-enabled element:
echo $view->comboBox(
    'foo', 
    'bar', 
    array(
        'autocomplete' => false,
        'store'        => 'stateStore',
        'storeType'    => 'dojo.data.ItemFileReadStore',
        'storeParams'  => array('url' => '/js/states.json'),
    ),
);

CurrencyTextBox：dijit.form.CurrencyTextBox。 从 ValidationTextBox 继承，并提供货币的客户端校验。 它期望 dijit 参数 'currency' 的值是适当的三字符货币代码。 可以为 ValidationTextBox 和 TextBox 指定任何有效的 dijit 参数。

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

	Issues with Builds
	目前有这些 和 build 层一起使用的 CurrencyTextBox 的已知问题 . 一个解决办法是确保文档的 Content-Type http-equiv meta tag 把字符集设置为 utf-8， 可通过调用下列方法来完成： $view->headMeta()->appendHttpEquiv('Content-Type', 'text/html; charset=utf-8'); ?> 这当然意味着你需要确保 headMeta() 占位符在布局脚本中。

DateTextBox：dijit.form.DateTextBox. 从 ValidationTextBox 继承，提供客户端的日期校验和下拉式日历。 你可以指定任何 dijit 可用的参数给 ValidationTextBox 或 TextBox。

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

FilteringSelect：dijit.form.FilteringSelect。 和 ComboBox 类似，这是个选择/文字混合体，它可以从提供的选项列表 里读取或者从 dojo.data 数据存储里抓取。和 ComboBox 不一样的地方是 FilteringSelect 不允许输入不在列表里的选项。另外，它的操作和标准选择 一样，从选项值里选择而不是从标签里选择，当表单提交时返回它们。

请参考上述关于 ComboBox 范例和定义数据存储的可用选项的信息。

HorizontalSlider 和 VerticalSlider： dijit.form.HorizontalSlider 和 dijit.form.VerticalSlider. 滑尺是 UI 小部件，用来在给定范围内选择数值的，这两个一个是水平的，一个是垂直的。

至少，它们需要 dijit 参数 'minimum'、 'maximum' 和 'discreteValues'，来定义值的范围。 其它通用的选项有：

Zend Framework 实现生成一个隐藏的元素来存储滑尺的数值。

你可以可选地为滑尺显示尺子或标签，可通过分配一个或多个 dijit 参数 'topDecoration' 和/或 'bottomDecoration'(水平滑尺） 或 'leftDecoration' 和/或 'rightDecoration' （垂直滑尺）来完成。它们有下列选项：

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。 数字输入文本框，按钮用来增减值。

期望用于 dijit 参数 'constraints' 的联合数值或者键 'min'、'max' 和 'places' （这些也期望 constraints 参数的条目）。 'places' 可用于指示微调数的增加和减少的数值。

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

NumberTextBox：dijit.form.NumberTextBox。 NumberTextBox 可选地依靠给定的限制以本地化方式格式化和显示数字条目，同时也校验数字条目。

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

PasswordTextBox： 和密码输入相关的 dijit.form.ValidationTextBox。 PasswordTextBox 生成密码输入，并和当前的 dijit 主题匹配，同时也做客户端校验。

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

RadioButton：dijit.form.RadioButton。 一组选项，但只能选一个，除了视觉上和其它 dijits 保持一致， 其它方面都和普通的单选（radio，也叫无线电按钮）元素一样。

RadioButton 接受可选的第四个参数，$options， 是个联合数组，值/标签对用作radio选项。 你可以以 $attribs 键 options 来传递。

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

SubmitButton：和提交元素相关的 dijit.form.Button。 参见按钮视图助手有更多的细节。主要的区别是这个按钮可以提交一个表单。

Textarea：dijit.form.Textarea. 除了有很多行以外，和普通的文本区域一样，它们按照用户类型来扩展。 宽度通过风格来设定。

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

TextBox：dijit.form.TextBox。 该元素主要用来在不同的 dijit 元素之间提供一个通用的外观， 并对其它 TextBox 派生的类 （ValidationTextBox、 NumberTextBox、 CurrencyTextBox、 DateTextBox 和 TimeTextBox）提供基本功能。

普通的 dijit 参数标志包括 'lowercase' （转换成小写）、 'uppercase' （转换成大写）、 'propercase' （转换成合适的大小写）和 trim （修剪引导和拖尾的空白字符）； 它们都接受布尔值。另外，你可以指定参数 'size' 和 'maxLength'。

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

TimeTextBox： dijit.form.TimeTextBox。 也包含在 TextBox 家族，TimeTextBox 提供一个下拉式时间选择器。 Dijit 参数让你指定可用的时间增量以及有效的时间的可见范围。

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。 为文本元素提供客户端校验。从 TextBox 继承。

普通的 dijit 参数包括：

echo $view->validationTextBox(
    'foo',
    '',
    array(
        'required' => true,
        'regExp'   => '[\w]+',
        'invalidMessage' => 'No spaces or non-word characters allowed',
        'promptMessage'  => 'Single word consisting of alphanumeric characters and underscores only',
    ),
    array(
        'maxlength' => 20,
    )
);