www.dextsolution.com
DEXTUPLOAD
X5
リファレンス > dx5オブジェクト

# dx5メソッド

## canonicalize

- 1.0.0.0以上

- 説明

  パラメータで指定された相対パスをフルパス返す。

  DEXTUploadX5コンポーネントとは関係なく、サンプルの作業をするために作られた一種のユーティリティである。「/」、「./ 'または' ../」で始まるパスをスキーマで始まるパスに変更して返します。

  無効なパス値が与えられる場合には、正しくない、完全なパスが返されることがあるから、参考のためにのみ使用することを推奨する。

      //現在のURLが「http://abc.com/path1/path2/current.html」ラーメン「http://abc.com/path1/abc/resource.txt」が返される。
      var full = dx5.canonicalize("../abc/resource.txt");

- 形式

      fullURL = dx5.canonicalize(relativeURL);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  relativeURL | String | 「/」、「./」、「../」で始まるURL

- リターンタ

  スキーマで始まるフルパス

## create

- 1.0.0.0以上

- 説明

  コンポーネントを生成する。

      <div id="dext5-container" style="width:500px; height:300px;"><!-- コンポーネントのコンテナ要素 --></div>
      <button id="btn-add-files" type="button">ファイルの追加</button>
      <script>
          dx5.create({
              // 「id」属性でコンポーネントにDOM IDを与えます。このDOM IDはコンポーネントを区別するものです。
              // 「parentId」属性は、コンテナのIDを指定します。
              id: "dext5", parentId: "dext5-container",
              // コンポーネントはボタンを持っていないため、ボタン要素を直接作成する必要が、
              // 「button」または「input[type=button]」の要素を作成し、ターゲットユーザ名を指定してくれれば、ファイルのアドインが自動的に接続されているボタンが生成される。
              btnFile: "btn-add-files"
          });
      </script>
      <script>
          function onDX5Error(id, code, msg) {
              // コンポーネントの使用中にエラーが発生したときに呼び出されます。
          }
          function onDX5Created(id) {
              // 「dx5.create」メソッドを使用して、コンポーネントが作成されるとonDX5Createコールバック関数が呼び出されます。
              // コールバック関数で「dx5.get」メソッドを使用して、コンポーネントオブジェクトを得ることができる。
              var dx = dx5.get(id);
          }
      </script>

  バージョン3.3.0.0以降、コンポーネントを作成するときに、同じIDのコンポーネントが存在する場合、重複しないように既存のコンポーネントが削除されます。

- 形式

      dx5.create({ /* 作成オプション */ });

- パラメータ

  以下の表の内容は、「create」メソッドが必要とするJSONパラメータオブジェクトの属性とその値について説明している。

  名前 | 説明
  --- | ---
  style | コンポーネントの基本的なGUIの外観を決定する属性である。 list', 'tile', 'single', 'grid' の値をとり、デフォルトは 'list' である。grid' はバージョン 3.2.0.0 で追加されました。
  progressType | コンポーネントのアップロード/ダウンロードの進行ウィンドウGUIの外観を決定する。 '0'、 '1'、 '2'、 '3'の値を持ち、デフォルトでは「0」である。 ORAF経由でアップロードする場合、各ファイルのアップロード状況を確認できないため、「0」または「3」の進捗状況ウィンドウしか使用できません。 「3」番進行ウィンドウ形式は、ファイルのダウンロード処理を実行するとき、ファイルのサイズを事前に知ることができない場合に使用するように2.3.0.0バージョンから追加された。
  id | [必須] DEXTUploadX5コンポーネントのIDである。 コンポーネントが作成されるとき、使用されている「object」HTML要素の 'id'属性の値であり、dx5オブジェクトは、このIDを持ってコンポーネントを区分する。
  parentId | [必須] DEXTUploadX5コンポーネントが生成される親要素のIDである。 コンポーネントが作成されるとき、使用されている「object」のHTML要素を格納するコンテナ要素の 'id'属性値である。
  lang | DEXTUploadX5コンポーネントがサポートすべき言語である。 「en」、「ko」、「ja」、「zh」、...のような値を指定することができるが、デフォルトでは、ブラウザの言語の文字セットに続く。 本製品はデフォルトで韓国語のリソースを使用するので、韓国語以外の言語の文字セットを使用したい場合は、その言語で書かれた'dextuploadx5-svg-message-{charset}.txt'が必要です。
  width | コンポーネントの横サイズである。 CSS形式を使用して、デフォルトでは「100％」である。 コンポーネントの横幅は 'width'特性を使用せずに、コンテナの水平方向のサイズに依存することをお勧めします。
  height | コンポーネントの垂直方向のサイズである。 CSS形式を使用して、デフォルトでは「100％」である。 コンポーネントの縦サイズは「height」プロパティを使用せずに、コンテナの縦サイズに依存することをお勧めします。
  path | DEXTUploadX5コンポーネントの場所である。 この値が指定されていなければ、「dextuploadx5-configuration.js「ファイルの「dextuploadx5Configuration.productPath」の値に続く。
  btnFile | ファイル選択ダイアログを接続するボタンエレメントのIDを設定する。/p> 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれれば、ファイルを追加機能が自動的に接続される。
  btnFolder(3.7.0.0以上) | フォルダ選択ダイアログを接続するボタンエレメントのIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれればフォルダの追加機能が自動的に接続される。
  btnSelectAll | 全ファイル選択機能を使用するボタン要素のIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれれば、ファイル全体を選択する機能が自動的に接続される。
  btnUnselectAll | 全ファイル選択解除機能を使用するボタン要素のIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれれば、選択したファイルを終了する機能が自動的に接続される。
  btnDeleteSelected | 選択したファイルの削除機能を使用ボタンエレメントのIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれれば、選択したファイルを削除する機能が自動的に接続される。
  btnDeleteAll | 全ファイルを削除する機能を使用するボタン要素のIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれれば、ファイル全体を削除する機能が自動的に接続される。
  btnDeleteChecked | チェックされたファイルを削除する機能を使用ボタンエレメントのIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれればチェック状態のファイルを削除する機能が自動的に接続される。
  btnRevokeAll | 削除された仮想ファイルを復元する機能を使用ボタンエレメントのIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれれば削除された仮想ファイルの両方を復元する機能が自動的に接続される。
  btnUploadAuto | ファイルをアップロードする機能を使用ボタンエレメントのIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれればまだアップロードが未ローカルファイルの両方をアップロードする機能が自動的に接続される。
  btnUploadChecked | ファイルをアップロードする機能を使用ボタンエレメントのIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれればチェック状態のローカルファイルの両方をアップロードする機能が自動的に接続される。
  btnUploadSelected | ファイルをアップロードする機能を使用ボタンエレメントのIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれれば選択状態のローカルファイルの両方をアップロードする機能が自動的に接続される。
  btnStopUploading | ファイルのアップロードを停止する機能を使用ボタンエレメントのIDを設定する。 「button」または「input [type = button]」エレメントのようにユーザ名を指定してくれれば、アップロードを中止する機能が自動的に接続される。
  btnDownloadAuto | ファイルをダウンロードする機能を使用するボタン要素のIDを設定します。 『button』 または 『input[type=button]』 要素のようにIDを指定すると、仮想ファイルをすべてダウンロードする機能が自動的に接続されます。
  btnDownloadChecked | ファイルをダウンロードする機能を使用するボタン要素のIDを設定します。 『button』または『input[type=button]』要素のようにIDを指定すると、チェック状態の仮想ファイルをすべてダウンロードする機能が自動的に接続されます。
  btnDownloadSelected | ファイルをダウンロードする機能を使用するボタン要素のIDを設定します。 『button』または『input[type=button]』要素のようにIDを指定すると、選択状態の仮想ファイルをすべてダウンロードする機能が自動的に接続されます。
  btnStopDownloading | ファイルダウンロードを中止する機能を使用するボタン要素のIDを設定します。 『button』または『input[type=button]』要素のようにIDを指定すると、ダウンロードを中止する機能が自動的に接続されます。
  btnDownloadCompressedAuto | 圧縮ダウンロード機能を使用するボタン要素のIDを設定します。 『button』または『input[type=button]』要素のようにIDを指定すると、仮想ファイルを1つの圧縮ファイルとしてダウンロードする機能が自動的に接続されます。
  btnDownloadCompressedChecked | 圧縮ダウンロード機能を使用するボタン要素のIDを設定します。 『button』または『input[type=button]』要素のようにIDを指定すると、チェック状態の仮想ファイルを1つの圧縮ファイルとしてダウンロードする機能が自動的に接続されます。
  btnDownloadCompressedSelected | 圧縮ダウンロード機能を使用するボタン要素のIDを設定します。 『button』 または 『input[type=button]』 要素のようにIDを指定すると、選択状態の仮想ファイルを1つの圧縮ファイルとしてダウンロードする機能が自動的に接続されます。
  btnStopCompressWaiting | 圧縮ダウンロードを中止する機能を使用するボタン要素のIDを設定します。 『button』または『input[type=button]』要素のようにIDを指定すると、圧縮ダウンロードを中止する機能が自動的に接続されます。
  btnOpenDownloadDialogOfHD | HDアプリケーションのダウンロードパスを設定するダイアログウィンドウを開く機能を使用するボタン要素のIDを設定します。 『button』または『input[type=button]』要素のようにIDを指定すると、HDアプリケーションのダウンロードパスを設定する機能が自動的に接続されます。
  btnDownloadToHDAuto | HDアプリケーションを使用してファイルをダウンロードする機能を使用するボタン要素のIDを設定します。 『button』または『input[type=button]』要素のようにIDを指定すると、仮想ファイルをHDアプリケーションを使用してダウンロードする機能が自動的に接続されます。
  btnDownloadToHDChecked | HD アプリケーションを使用してファイルをダウンロードする機能を使用するボタン要素のIDを設定します。 「button」または「input[type=button]」要素のようにIDを指定すると、チェック状態の仮想ファイルをHD アプリケーションを使用してダウンロードする機能が自動的に接続されます。
  btnDownloadToHDSelected | HDアプリケーションを使用してファイルをダウンロードする機能を使用するボタン要素のIDを設定します。 『button』または『input[type=button]』要素のようにIDを指定すると、選択状態の仮想ファイルをHDアプリケーションを使用してダウンロードする機能が自動的に接続されます。
  loadWaitingTime (2.1.2.0バージョンからサポート) | コンポーネントを作成してからロードするまでの待ち時間を設定します。 初期値は10000ms（10秒）、それ以上待ちたい場合はミリ秒（1000分の1秒）で設定します。 バージョン3.6.1.0までは、3000ms（3秒）でした。
  events (3.10.0.0バージョンからサポート) | これは、製品内で発生するイベントを処理する個々のハンドラを登録するために使用します。製品は、'onDX5~'で始まる名前のグローバル・イベント・ハンドラを呼び出してイベントを処理しますが、コンポーネント作成時に、個々のコンポーネントが必要に応じて独自のハンドラを登録して使用できるように指定することができます。 グローバルイベントハンドラと個別イベントハンドラを重複して宣言します： 両方のイベントハンドラが呼び出されます。 両方のイベント・ハンドラが呼び出されます。イベント・ハンドラは、個別ハンドラ、グローバル・ハンドラの順に呼び出されます。 戻り値が影響を受けるイベントについては、最後に呼び出されたイベントハンドラの戻り値のみが影響を受けます。
      dx5.create({
          ...
          events: {
              created:                    /* onDX5Created */,
              error:                      /* onDX5Error */,
              beforeItemsAdd:             /* onDX5BeforeItemsAdd */,
              itemAdding:                 /* onDX5ItemAdding */,
              itemsAdded:                 /* onDX5ItemsAdded */,
              beforeItemsDelete:          /* onDX5BeforeItemsDelete */,
              itemDeleting:               /* onDX5ItemDeleting */,
              itemsDeleted:               /* onDX5ItemsDeleted */,
              itemSelect:                 /* onDX5ItemSelect */,
              itemCheck:                  /* onDX5ItemCheck */,
              itemDoubleClick:            /* onDX5ItemDoubleClick */,
              uploadBegin:                /* onDX5UploadBegin */,
              uploadItemStart:            /* onDX5UploadItemStart */,
              uploadItemEnd:              /* onDX5UploadItemEnd */,
              uploadStopped:              /* onDX5UploadStopped */,
              uploadCompleted:            /* onDX5UploadCompleted */,
              downloadBegin:              /* onDX5DownloadBegin */,
              downloadItemStart:          /* onDX5DownloadItemStart */,
              downloadItemEnd:            /* onDX5DownloadItemEnd */,
              downloadStopped:            /* onDX5DownloadStopped */,
              downloadCompleted:          /* onDX5DownloadCompleted */,
              preview:                    /* onDX5Preview */,
              itemsToHDFinish:            /* onDX5ItemsToHDFinish */,
              columnDataBinding:          /* onDX5ColumnDataBinding */,
              compressWaitingBegin:       /* onDX5CompressWaitingBegin */,
              compressWaitingCompleted:   /* onDX5CompressWaitingCompleted */,
              compressWaitingStopped:     /* onDX5CompressWaitingStopped */,
              dragAndDrop:                /* onDX5DragAndDrop */,
          }
      });

## delete

- 3.3.0.0以上

- 説明

  DEXTUploadX5コンポーネントを削除します。 削除するオブジェクトが存在しなくてもエラーは発生しません。

      // IDが「dext5」のコンポーネントを削除します。
      dx5.delete("dext5");

- 形式

      success = dx5.delete(id);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  id | String | 削除するDEXTUploadX5コンポーネントのID

- リターンタ

  ターゲットが存在し、削除されている場合はtrue、それ以外の場合はfalseです。

## get

- 1.0.0.0以上

- 説明

  生成されたDEXTUploadX5コンポーネントを使用するためには、「dx5.get」メソッドを使用して、コンポーネントオブジェクトを得なければならない。

      <div id="dext5-container" style="width:500px; height:300px;"><!-- コンポーネントのコンテナ要素 --></div>
      <button id="btn-add-files" type="button">ファイルの追加</button>
      <script>
          dx5.create({ mode: "multi", id: "dext5", ... });
      </script>
      <script>
          function onDX5Error(id, code, msg) {
              // コンポーネントの使用中にエラーが発生したときに呼び出されます。
          }
          function onDX5Created(id) {
              // 「dx5.create」メソッドを使用して、コンポーネントが作成されると「onDX5Create」コールバック関数が呼び出されます。
              // コンポーネントが作成されると、「dx5.get」メソッドを使用してコンポーネントを取得することができる。
              var dx = dx5.get(id);
          }
      </script>

- 形式

      component = dx5.get(id);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  id | String | DEXTUploadX5コンポーネントのIDをある。 コンポーネントが作成されるとき、使用されている「object」HTML要素の 'id'属性の値であり、「dx5」オブジェクトは、このIDを持ってコンポーネントを区分する。

- リターンタ

  指定されたユーザ名に対応するコンポーネントオブジェクト

## isHDAvailable

- 2.3.5.0以上

- 説明

  HDアプリケーションがインストールされ、Webページとの通信が可能な状態であるかを確認するときに使用するメソッドです。

  メソッドを呼び出して、正常な応答を取得しsuccessパラメータに登録されたコールバック関数が呼び出さとなり、失敗した場合failパラメータとして登録されたコールバック関数が呼び出されます。

      function checkHDInstalled() {
          dx5.isHDAvailable(function (ver) {
              // 成功した場合のバージョンを表す文字列をパラメータとして得ることができる。
              alert(ver);
          }, function (code, msg) {
              // 失敗すると、失敗コードとメッセージを得ることができる。
              alert(code + ": " + msg);
          });
      }

  isHDAvailable関数は、HDアプリケーションを使用できる状態を示すものであり、現在のHDアプリケーションの実行するかどうかを知ることはできない。

  応答が失敗した場合、ブラウザのコンソールには、次のような追加のエラー情報が出力されることができる。

      # Chrome
      POST http://localhost:35959/DEXTUploadX5_HDS net::ERR_CONNECTION_REFUSED

      # FF
      Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at http://localhost:35959/DEXTUploadX5_HDS. (Reason: CORS request did not succeed).

      # Opera
      POST http://localhost:35959/DEXTUploadX5_HDS net::ERR_CONNECTION_REFUSED

- 形式

      dx5.isHDAvailable(success, fail);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  success | function | HDの使用が可能な場合に呼び出されるコールバック関数
  fail | function | HDの使用が不可能な場合に呼び出されるコールバック関数

## isHDRunning

- 2.3.5.0以上

- 説明

  HDのアプリケーションが現在実行中であることを確認するときに使用するメソッドです。

  メソッドを呼び出して、正常な応答を取得しsuccessパラメータに登録されたコールバック関数が呼び出さとなり、失敗した場合failパラメータとして登録されたコールバック関数が呼び出されます。

      function checkHDRunning() {
          dx5.isHDRunning(function (ver) {
              // 成功した場合のバージョンを表す文字列をパラメータとして得ることができる。
              alert(ver);
          }, function (code, msg) {
              // 失敗すると、失敗コードとメッセージを得ることができる。
              alert(code + ": " + msg);
          });
      }

  isHDRunning関数は、現在HDアプリケーションの実行するかどうかだけを確認する。したがって、HDアプリケーションのインストールするかどうかは知ることができない。

  応答が失敗した場合、ブラウザのコンソールには、次のような追加のエラー情報が出力されることができ、HDインストールするかどうかに応じて、メッセージが異なる場合があります。

      # Chrome
      POST http://localhost:35959/DEXTUploadX5_HDM 404 (Not Found)
      Access to XMLHttpRequest at 'http://localhost:35959/DEXTUploadX5_HDM' from origin 'http://(omission)' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

      # FF
      Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at http://localhost:35959/DEXTUploadX5_HDM. (Reason: CORS header ‘Access-Control-Allow-Origin’ missing).

      # Opera
      Failed to load resource: the server responded with a status of 404 (Not Found)
      Access to XMLHttpRequest at 'http://localhost:35959/DEXTUploadX5_HDM' from origin 'http://(omission)' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.

- 形式

      dx5.isHDRunning(success, fail);

- パラメータ

  名前 | 形式 | 説明
  --- | --- | ---
  success | function | HDアプリケーションが実行中の場合に呼び出されるコールバック関数
  fail | function | HDアプリケーションが実行されていない場合に呼び出されるコールバック関数