spFileUpload
コンポーネント情報 | |
---|---|
モジュール | im_mobile_framework |
導入されたバージョン | 8.0.3 |
バージョン | 8.0.8 |
機能説明
ストレージサービスへのファイルのアップロードを行います。
- アップロードするファイルの選択方法は以下の通りです。
- 「ファイル選択」ボタンをクリックし、ファイル選択ダイアログからファイルを選択する
- 指定するパラメータ、機種、OSによって、カメラで撮影した画像ファイルを送信することもできます。
- 提供する機能は以下の通りです。
- 選択したファイルを個別にアップロード
- 選択したファイルの一括アップロード
- アップロードしたファイルの削除
- 自動アップロード
- ファイルを選択すると同時に、自動的にファイルをアップロードします。
- このタグはスマートフォン用の画面向けにデザインされています。
- ご利用の機器のOS、OSのバージョンによってアップロードできるファイルが制限されます。
- iOS
- iOS5以前
- ファイルをアップロードできません。
- iOS6
- ファイルをアップロードすることができます。
- アップロード可能なファイルは、画像または動画の2種類です。
- 画像ファイルは、ファイル名が image.jpg に固定されています。
- multiple属性をtrueにすると、複数ファイルを選択可能です。ただし、上記の通りファイル名はすべて image.jpg になるのでファイル名の扱いに注意してください。
- Media Captureに対応していないため、capture属性に値を指定しても無視されます。
- iOS5以前
- Android
- Android2.1以前
- ファイルをアップロードできません。
- Android2.2以降
- ファイルをアップロードすることができます。
- multiple属性をtrueにしても、複数ファイルを選択することはできません。
- File APIに対応していないため、ファイルサイズやMIME-Typeを取得することができません。
- Media Captureに対応していないため、capture属性に値を指定しても無視されます。
- Android4以降
- ファイルをアップロードすることができます。
- multiple属性をtrueにしても、複数ファイルを選択することはできません。
- File APIに対応しているため、ファイルサイズやMime-Typeを取得することができます。
- Media Captureに対応しているため、capture属性に値を指定するとアップロードするファイルを制御できます。
- Android2.1以前
- iOS
- このタグは不可視な iframe へデータを送信し、非同期でファイルをアップロードする方法を利用します。
- このため、formタグのaction属性に指定したURLへ画面遷移しません。
- 画面遷移したい場合はコールバック関数を定義し、定義した関数の中で画面遷移を行う必要があります。
- 動作を確認しているのは、iOS6(iPhone4, iPhone4S, iPhone5), Android(Galaxy SII, Galaxy SIII, Galaxy Note)のみです。
- アプリケーションサーバの設定によって、アップロード可能なファイルサイズが制限されます。
- このタグや、ほかの方法でアップロードされているHTMLファイルをダウンロードする機能を提供すると、ダウンロードするファイルにテーマが適用され、想定したファイルがダウンロードできない場合があります。
- 回避するにはテーマを適用しないような実装が必要です。詳細はテーマ仕様書の「PageBuilder」を参照してください。
属性一覧
- ファイルをアップロードするには、ファイルの保存先を指定する必要があります。以下の3つの保存先を示す属性のうちいずれか1つだけを指定してください。
- storeTo
- url
- outerFormId
- 複数指定してしまった場合、これらの値の優先度は以下のようになります。例えば、outerFormIdとurlを同時に指定した場合、outerFormIdの値が利用され、urlに指定した値は無視されます。
- 優先度高
- outerFormId
- url
- storeTo
- 優先度低
- 優先度高
注釈 | 属性名 | 型 | 説明 | 省略時の動作 | 実行時評価 |
---|---|---|---|---|---|
acceptMimeType |
String | アップロードを許可するMime-Type | - | ||
Boolean属性 | autoUpload |
Boolean | ファイル選択後に自動的にアップロードするかどうかのフラグ | false | |
capture |
String | Media Capture APIのcapture属性 | - | ||
containerId |
String | ファイル一覧を追加する対象のid 詳細は ファイル一覧をカスタマイズする を参照してください |
- | ||
無害化 | converter |
String | ファイル情報を変換する関数名 詳細は ファイル一覧をカスタマイズする を参照してください |
- | |
deleteItemTemplateId |
String | enableDelete が true の場合に利用される、ファイル一覧の項目のテンプレートを示すid 詳細は ファイル一覧をカスタマイズする を参照してください |
- | ||
editItemTemplateId |
String | fileNameEditable が true の場合に利用される、ファイル一覧の項目のテンプレートを示すid 詳細は ファイル一覧をカスタマイズする を参照してください |
- | ||
Boolean属性 | enableDelete |
Boolean | アップロード完了したファイルを削除するボタンを表示するかどうかのフラグ | false | |
Boolean属性 | fileNameEditable |
Boolean | アップロード前にファイル名を編集するかどうかのフラグ(自動アップロード時は設定不可) | false | |
HTML5
Boolean属性
|
hidden |
Boolean | このタグを非表示にします | false | |
id |
String | 生成されるform要素のid | 代替idを付与 | ||
imagePath |
String | ファイル選択ボタンの代わりに表示する画像のパス | - | ||
itemTemplateId |
String | ファイル一覧の項目のテンプレートを示すid 詳細は ファイル一覧をカスタマイズする を参照してください |
- | ||
listTemplateId |
String | ファイル一覧のテンプレートを示すid 詳細は ファイル一覧をカスタマイズする を参照してください |
- | ||
maxNumberOfFiles |
Integer | アップロード可能ファイル数(1以上の数値) | 無制限 | ||
HTML5
Boolean属性
|
multiple |
Boolean | 複数同時にファイルをアップロードするかどうかのフラグ(true=複数同時、false=単一) | false | |
name |
String | 生成されるform要素のname | 代替nameを付与 | ||
HTML5
Boolean属性
|
novalidate |
Boolean | 入力されたデータの妥当性を確認しない(true:確認しない、false:確認する) | false | |
無害化 | onBeforeSend |
String | アップロード直前に呼び出されるCSJSの関数名 | - | - |
無害化 | onChange |
String | ファイル選択時に呼び出されるCSJSの関数名 | - | |
無害化 | onError |
String | アップロード失敗時に呼び出されるCSJSの関数名 | - | |
無害化 | onRemove |
String | アップロードしたファイルのDelete実行時に呼び出されるCSJSの関数名 | - | |
無害化 | onSuccess |
String | アップロード成功時に呼び出されるCSJSの関数名 | - | |
無害化 | outerFormId |
String | このタグの外側にformがある場合のformタグのid | - | |
Boolean属性 | showList |
Boolean | ファイル選択後に選択したファイルのリストを表示するかどうかのフラグ(true=表示する、false=表示しない) | true | |
無害化 | storeTo |
String | 保存先ディレクトリ(SessionScopeStorageをルートとした相対パスを指定する) | - | |
無害化 | url |
String | 保存先URL(urlとstoreToが同時に指定された場合、urlを優先する) | - | |
無害化 | その他 |
String | ユーザ定義属性(生成されるinput type=“file”タグの属性として出力される) | - |