|
intra-mart ® 7.2 patch09 Client Side JavaScript | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Object | +--ImUploadApplet
ファイルアップロードコンポーネント。
このコンポーネントはコンストラクタを利用して生成せずに、タグライブラリを利用して配置します。
ファイルアップロードコンポーネントの画面への配置は、JavaEE開発モデル、スクリプト開発モデルのそれぞれで、カスタムタグを用いて行うことが可能です。
document.upload1.addParameter("fileName", "サンプル1");
document.upload1.upload();
callback
」属性、またはsetUploadListener()関数で指定したコールバック関数を利用して確認する必要があります。${Webサーバコンテキストパス}/upload/jp/co/intra_mart/foundation/upload/config/UploadAppletConfig.xml
${Webサーバコンテキストパス}/upload/images
コンストラクタの概要 | |
ImUploadApplet()
ファイルアップロードコンポーネント(直接生成して利用することはできません) |
メソッドの概要 | |
void
|
addParameter(<String> key, <String> value)
送信パラメータを設定します。 |
void
|
cancel()
ファイルアップロードを中止します。 |
void
|
clear()
送信ファイルを一覧から全て削除します。 |
String
|
getAcceptable()
アップロード可能なファイルの種別を取得します。 |
String
|
getAction()
送信先URLを取得します。 |
String
|
getActionListener(<String> event)
画面上のイベント用のコールバック関数を取得します。 |
Number
|
getCols()
アップロードコンポーネントの幅を取得します。 |
Number
|
getDelay()
送信遅延時間を取得します。 |
String
|
getDisplayMode()
ファイル名の表示方法を取得します。 |
ImUploadRequestInfo
|
getErrorResponse()
直前のエラー発生時のHTTPイベントオブジェクトを取得します。 |
ImUploadFileModel
|
getFile(<Number> index)
送信ファイルオブジェクトを取得します。 |
Number
|
getFileCount()
送信ファイルリストの件数を取得します。 |
Array<ImUploadFileModel>
|
getFiles()
送信ファイルオブジェクト一覧を取得します。 |
Number
|
getInterval()
送信イベントのコールバック関数の呼び出し間隔を取得します。 |
Number
|
getMaxSize()
アップロード可能な最大ファイルサイズを取得します。 |
Array<String>
|
getParameterValues(<String> key)
送信パラメータを取得します。 |
String
|
getPath(<Number> index)
送信ファイル名を取得します。 |
String
|
getRequestKey()
送信リクエストパラメータの名前を取得します。 |
Number
|
getRows()
アップロードコンポーネントの高さを取得します。 |
Number
|
getSelectedIndex()
選択済みのファイルのインデックスを取得します。 |
String
|
getStyle(<String> key)
コンポーネントのスタイルを取得します。 |
String
|
getUploadListener()
送信のコールバック関数を取得します。 |
Boolean
|
isAcceptable(<String> path)
指定したファイル名のアップロード可否をチェックします。 |
Boolean
|
isAuto()
自動送信の有無を取得します。 |
Boolean
|
isEnabled()
アップロードコンポーネントの有効化状態を取得します。 |
Boolean
|
isEnableIcon()
アイコンの表示有無を取得します。 |
Boolean
|
isEnableRemoveButton()
削除ボタンの表示有無を取得します。 |
Boolean
|
isSelected(<Number> index)
送信ファイルが選択済みかを取得します。 |
Boolean
|
isVisible()
アップロードコンポーネントの表示状態を取得します。 |
void
|
movePath(<Number> start, <Number> end, <Number> to)
送信ファイルの順序をリストの中で移動します。 |
void
|
removeActionListener(<String> event, <String> listener)
画面上のイベント用ののコールバック関数を削除します。 |
void
|
removeParameter(<String> key)
送信パラメータを削除します。 |
void
|
removePath(<Number> start, <Number> end)
送信ファイルを削除します。 |
void
|
reset()
送信完了したファイルを、送信可能状態に設定します。 |
void
|
setAcceptable(<String> acceptable)
アップロード可能なファイルの種別を設定します。 |
void
|
setAction(<String> action)
送信先を設定します。 |
void
|
setActionListener(<String> event, <String> listener)
画面操作時のイベント用のコールバック関数を設定します。 |
void
|
setAuto(<Boolean> auto)
自動送信の有無を設定します。 |
void
|
setCols(<Number> cols)
アップロードコンポーネントの幅を設定します。 |
void
|
setDelay(<Number> delay)
送信遅延時間を設定します。 |
void
|
setDisplayMode(<String> mode)
ファイル名の表示方法を設定します。 |
void
|
setEnabled(<Boolean> enabled)
アップロードコンポーネントの有効化状態を設定します。 |
void
|
setEnableIcon(<Boolean> enable)
アイコンの表示有無を設定します。 |
void
|
setEnableRemoveButton(<Boolean> enable)
削除ボタンの表示有無を設定します。 |
void
|
setInterval(<Number> interval)
送信イベントのコールバック関数の呼び出し間隔を設定します。 |
void
|
setMaxSize(<Number> maxSize)
アップロード可能な最大ファイルサイズを設定します。 |
void
|
setParameter(<String> key, <String> value)
送信パラメータを設定します。 |
void
|
setParameterValues(<String> key, <Array
送信パラメータを設定します。 |
void
|
setRequestKey(<String> key)
送信リクエストパラメータの名前を設定します。 |
void
|
setRows(<Number> rows)
アップロードコンポーネントの高さを設定します。 |
void
|
setStyle(<String> key, <String> style)
コンポーネントのスタイルを設定します。 |
void
|
setUploadListener(<String> listener)
送信イベントのコールバック関数を設定します。 |
void
|
setView(<Boolean> visible)
アップロードコンポーネントの表示状態を設定します。 |
Boolean
|
upload()
ファイルアップロードを開始します。 |
コンストラクタの詳細 |
ImUploadApplet()
メソッドの詳細 |
void addParameter(<String> key, <String> value)
key
- 送信するリクエストパラメータの名前
value
- 送信するリクエストパラメータの値
void cancel()
void clear()
String getAcceptable()
(例)"*.jpg *.gif"
String getAction()
application
およびservice
属性)や、スクリプト開発モデルのページパス(page
属性)は、URLに変換されて取得されます。String getActionListener(<String> event)
event
- イベント種別。以下のイベント種別を指定可能です。 Number getCols()
Number getDelay()
カスタムタグの「auto
」属性、またはsetAuto()関数 で「true
」を設定した場合の遅延時間を取得します。
String getDisplayMode()
path
- ファイル名をフルパスで表示します。(デフォルト)name
- ファイル名のみを表示します。none
- ファイル名や削除ボタンを表示しません。ImUploadRequestInfo getErrorResponse()
null
」を返却します
ImUploadFileModel getFile(<Number> index)
index
- [option] ファイル名を取得するインデックス(省略可能)Number getFileCount()
Array<ImUploadFileModel> getFiles()
Number getInterval()
送信イベントのうち、送信完了までに呼び出される、「送信中(uploading)」イベントの呼び出し間隔を取得します。
interval
」属性で設定された値を取得します。カスタムタグで指定されていない場合、「0」になります。Number getMaxSize()
Array<String> getParameterValues(<String> key)
カスタムタグの「uploadParam
」タグ、またはsetParameter()等の関数を利用して設定したパラメータが対象で、
ファイル一覧に追加したファイルは取得されません。
key
- 送信するリクエストパラメータの名前
String getPath(<Number> index)
index
- [option] ファイル名を取得するインデックス(省略可能)null
」が取得されます。
String getRequestKey()
Number getRows()
Number getSelectedIndex()
String getStyle(<String> key)
カスタムタグの「style」属性、またはsetStyle()関数で指定したスタイル情報が取得されます。
key
- コンポーネントのスタイルのキー
String getUploadListener()
callback
」属性、またはsetUploadListener()関数で指定した、 ImUploadRequestInfoオブジェクトを引数とする関数の名前が取得されます。Boolean isAcceptable(<String> path)
accept
」属性、
および setAcceptable()関数で設定したファイルパターンのチェックが行われます。path
- ファイル名
false
」の場合、指定したファイルはアップロード対象外です。
Boolean isAuto()
true
の場合、ファイルのドロップと同時に自動送信されます。delay
」属性が指定されている場合は、指定された時間の経過後に送信されます。
Boolean isEnabled()
false
」の場合、ファイルの追加も、アップロードも実行できません。
Boolean isEnableIcon()
false
」の場合、アイコンは非表示です。Boolean isEnableRemoveButton()
false
」の場合、削除ボタンは非表示です。Boolean isSelected(<Number> index)
index
- 項目を取得するインデックス
index
で指定した送信ファイルが選択済みかどうかです。
Boolean isVisible()
false
」の場合、このコンポーネントは非表示です。void movePath(<Number> start, <Number> end, <Number> to)
引数を省略した場合、以下のように判断します。
movePath(start, to)
- start
で指定した1つのファイルを、to
に移動する。movePath(to)
- 現在選択している1つのファイルを、to
に移動する。start
- [option] 移動するファイルの開始インデックス(省略可能)。 省略した場合、現在選択済みのファイルを移動します。
end
- [option] 移動するファイルの終了インデックス(省略可能)。 省略した場合、startで指定したファイルのみ移動します。
to
- 移動先インデックス
void removeActionListener(<String> event, <String> listener)
event
- イベント種別。以下のイベントをサポートします。listener
- CSJSのコールバック関数名。 ImUploadActionEventオブジェクトを引数とする関数の名前を指定します。void removeParameter(<String> key)
key
- 送信するリクエストパラメータの名前
void removePath(<Number> start, <Number> end)
引数を省略した場合、以下のように判断します。
removePath(start)
- start
で指定した1つのファイルを削除する。removePath()
- 現在選択しているファイルを削除する。未選択状態では削除は実行されません。start
- [option] 削除する開始インデックス(省略可能)。 省略した場合、現在選択済みのファイルを削除します。
end
- [option] 削除する終了インデックス(省略可能)。 省略した場合、startで指定したファイルのみ削除します。
void reset()
void setAcceptable(<String> acceptable)
acceptable
- アップロード可能なファイルの種別(例)obj.setAcceptable("*.jpg *.gif");
また、未設定の場合は全てのファイルを登録可能です。
void setAction(<String> action)
action
- 送信先URL
void setActionListener(<String> event, <String> listener)
event
- イベント種別。以下のイベントをサポートします。type | イベント種別名 | 説明 |
---|---|---|
select | 選択状態変更 | リストの選択状態が変更された場合に呼び出されます。 |
insert | 追加 | リストにファイルが追加された場合に呼び出されます。 |
move | 移動 | リストの順序が変更された場合に呼び出されます。 |
delete | 削除 | リストからファイルが削除された場合に呼び出されます。 |
listener
- CSJSのコールバック関数名。 ImUploadActionEventオブジェクトを引数とする関数の名前を指定します。void setAuto(<Boolean> auto)
auto
- true
の場合、ファイルのドロップと同時に自動送信されます。delay
」属性が指定されている場合は、指定された時間の経過後に送信されます。
void setCols(<Number> cols)
cols
- アップロードコンポーネントの幅(文字数)
void setDelay(<Number> delay)
カスタムタグの「auto
」属性、またはsetAuto()関数で「true
」を設定した場合の遅延時間を設定します。
delay
- 遅延時間(ミリ秒)
void setDisplayMode(<String> mode)
mode
- ファイル名の表示方法。以下の値を設定します。path
を設定した場合、ファイル名をフルパスで表示します。(デフォルト)name
を設定した場合、ファイル名のみを表示します。none
を設定した場合、ファイル名や削除ボタンを表示しません。void setEnabled(<Boolean> enabled)
enabled
- 設定する有効化状態false
」を設定した場合、ファイルの追加も、アップロードも実行できません。
void setEnableIcon(<Boolean> enable)
リストの左端にアイコン表示領域を表示します。
アイコン表示領域では、送信の成功/失敗がアイコンで表示されます。
enable
- アイコンの表示有無false
」を設定場合、アイコンは非表示です。void setEnableRemoveButton(<Boolean> enable)
enable
- 削除ボタンの表示有無false
」を設定場合、削除ボタンは非表示です。void setInterval(<Number> interval)
送信イベントのうち、送信完了までに呼び出される、「送信中(uploading)」イベントの呼び出し間隔を設定します。
interval
- コールバック関数呼び出し間隔(ミリ秒)void setMaxSize(<Number> maxSize)
1ファイルあたりの最大サイズを指定します。
送信データの合計サイズの最大サイズは、CSJS APIを利用して設定することはできません。
カスタムタグの「maxRequestLength
」属性を参照してください。
maxSize
- アップロード可能な最大ファイルサイズ(byte)void setParameter(<String> key, <String> value)
key
- 送信するリクエストパラメータの名前
value
- 送信するリクエストパラメータの値
void setParameterValues(<String> key, <Array> value)
key
- 送信するリクエストパラメータの名前
value
- 送信するリクエストパラメータの値の配列
void setRequestKey(<String> key)
コンポーネントに複数のファイルを登録した場合は、同一のパラメータ名の配列として送信されますが、 以下のような指定をすることで、パラメータ名を連番にして送信することが可能です。
document.upload1.setRequestKey("upload_file%1")
key
- 送信リクエストパラメータの名前
void setRows(<Number> rows)
rows
- アップロードコンポーネントの高さ(行数)
void setStyle(<String> key, <String> style)
CSSと似たプロパティを設定可能ですが、互換性はありませんので注意してください。
以下のスタイルを設定可能です。
color, background
プロパティの色の指定には、カラーチャートのカラー名を利用することも可能です。key
- コンポーネントのスタイルのキー
style
- コンポーネントのスタイルに設定する値
void setUploadListener(<String> listener)
listener
- CSJSのコールバック関数名。 ImUploadRequestInfoオブジェクトを引数とする関数の名前を指定します。void setView(<Boolean> visible)
visible
- 設定する表示状態false
」を設定場合、このコンポーネントは非表示です。Boolean upload()
true
false
を返却します。false
」が返却された場合、getErrorResponse()関数でエラー内容を取得してください。callback
」属性、またはsetUploadListener()関数でコールバック関数を指定している場合、 エラー時にコールバック関数が呼び出されるため、 コールバック関数の引数ImUploadRequestInfoオブジェクトのインスタンスを利用してエラー内容を取得してください。
|
intra-mart ® 7.2 patch09 Client Side JavaScript | ||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||
概要: フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |