Public/Erpadmin/lib/webuploader-0.1.5/jekyll/document.md

这里只显示每个文件的开头 60 行。登录后可以解锁完整代码。

微信扫码关注公众号，代码整理好后第一时间通知你。

---
layout: post
title: 文档
name: Document
group: 'nav'
weight : 2
hideTitle: true
commentIssueId: 80
---

## 接口说明
Web Uploader的所有代码都在一个内部闭包中，对外暴露了唯一的一个变量`WebUploader`，所以完全不用担心此框架会与其他框架冲突。

内部**所有**的类和功能都暴露在`WebUploader`名字空间下面。<br />
Demo中使用的是`WebUploader.create`方法来初始化的，实际上可直接访问`WebUploader.Uploader`。

```javascript
var uploader = new WebUploader.Uploader({
    swf: 'path_of_swf/Uploader.swf'

    // 其他配置项
});
```

具体有哪些内部类，请转到[API]({{ site.baseurl }}/doc/index.html)页面。

## 事件
`Uploader`实例具有Backbone同样的事件API：`on`，`off`，`once`，`trigger`。

```javascript
uploader.on( 'fileQueued', function( file ) {
    // do some things.
});
```

除了通过`on`绑定事件外，`Uploader`实例还有一个更便捷的添加事件方式。

```javascript
uploader.onFileQueued = function( file ) {
    // do some things.
};
```

如同`Document Element`中的onEvent一样，他的执行比`on`添加的`handler`的要晚。如果那些`handler`里面，有一个`return false`了，此`onEvent`里面是不会执行到的。

## Hook
`Uploader`里面的功能被拆分成了好几个`widget`，由`command`机制来通信合作。<br />
如下，filepicker在用户选择文件后，直接把结果`request`出去，然后负责队列的`queue` widget，监听命令，根据配置项中的`accept`来决定是否加入队列。

```javascript
// in file picker
picker.on( 'select', function( files ) {
    me.owner.request( 'add-file', [ files ]);
});

// in queue picker
Uploader.register({
    'add-file': 'addFiles'

    // xxxx