コードからPDFビューアの機能にアクセスする

PDFビューアコンポーネントを統合 した後、独自のJavaコードからその機能にアクセスしたい場合があります。このセクションでは、その方法について説明します。

PDFビューアには、ビューアの機能にアクセスしたり、ビューアから情報を取得したりするための2つのメソッドがあります。

現在のページ/表示に関する情報の取得は、以下のメソッドを使用して行うことができます。
Object Viewer.getViewerValue(ViewerValues) - このメソッドを見る 。入力としてViewerValues を使用することで、以下の値を返すことができます。

• ViewerValues.CURRENTPAGE - 返されるオブジェクトは現在のページのInteger型です。
• ViewerValues.PAGECOUNT - 返されるオブジェクトは総ページ数のInteger型です。
• ViewerValues.PDFNAME - 返されるオブジェクトはPDFファイル名を表すString型です。
• ViewerValues.SCALE - 返されるオブジェクトは倍率を表すFloat型です（1が100%）。
• ViewerValues.ROTATION - 返されるオブジェクトは表示における現在のページの回転角度のInteger型です。
• ViewerValues.PAGELAYOUT 返されるオブジェクトは、以下の値を使用してページレイアウトを表すInteger型です。
  • Display.SINGLE_PAGE = 1
  • Display.CONTINUOUS = 2
  • Display.CONTINUOUS_FACING = 3
  • Display.FACING = 4
  • Display.PAGEFLOW = 5
  • Display.PORTFOLIO_DETAIL = 6
  • Display.PORTFOLIO_TILE = 7

ビューアの機能は、以下のメソッドを使用して実行できます。
Object Viewer.executeCommand(ViewerCommands command, Object… args) - このメソッドを見る 。

このメソッドは、実行する機能を指定するためにViewerCommands 列挙型を使用し、特定のメソッドが完全なカスタマイズのために必要とする場合には入力引数を指定するObject…を使用します。そうでない場合、メソッドは標準のJPedalコードを使用します。

返されるObjectは、指定されたコマンドから返される可能性のあるものを返します。特に記載がない限り、この値はnullになります。これは、PDFの読み込みや印刷などに独自のポップアップウィンドウを使用したい場合に便利です。

JPedal関数のリスト

1. ファイルの開く/閉じる
   1. ViewerCommands.OPENFILE
   2. ViewerCommands.OPENURL
   3. ViewerCommands.PREVIOUSDOCUMENT
   4. ViewerCommands.NEXTDOCUMENT
   5. ViewerCommands.EXIT
2. ページナビゲーション
   1. ViewerCommands.FORWARDPAGE
   2. ViewerCommands.FFORWARDPAGE
   3. ViewerCommands.BACKPAGE
   4. ViewerCommands.FBACKPAGE
   5. ViewerCommands.FIRSTPAGE
   6. ViewerCommands.LASTPAGE
   7. ViewerCommands.GOTO
   8. ViewerCommands.BOOKMARK
   9. ViewerCommands.SCROLL
3. 表示制御
   1. ViewerCommands.ROTATION
   2. ViewerCommands.ROTATELEFT
   3. ViewerCommands.ROTATERIGHT
   4. ViewerCommands.SCALING
   5. ViewerCommands.ZOOMIN
   6. ViewerCommands.ZOOMOUT
   7. ViewerCommands.SINGLE
   8. ViewerCommands.CONTINUOUS
   9. ViewerCommands.CONTINUOUS_FACING
   10. ViewerCommands.FACING
   11. ViewerCommands.PAGEFLOW
   12. ViewerCommands.PORTFOLIO_DETAIL
   13. ViewerCommands.PORTFOLIO_TILES
   14. ViewerCommands.FULLSCREEN
   15. ViewerCommands.OPENINSYSTEMDEFAULT
4. ページレンダリング設定
   1. ViewerCommands.SEPARATECOVER
   2. ViewerCommands.SETENHANCEFRACTIONALLINES
   3. ViewerCommands.SETHIDELINEWEIGHTS
   4. ViewerCommands.SETHIGHLIGHTFORMFIELDS
5. インタラクティブ機能
   1. ViewerCommands.SAVE
   2. ViewerCommands.PRINT
   3. ViewerCommands.MOUSEMODE
   4. ViewerCommands.PANMODE
   5. ViewerCommands.TEXTSELECT
   6. ViewerCommands.SELECTALL
   7. ViewerCommands.DESELECTALL
   8. ViewerCommands.FIND
   9. ViewerCommands.PREVIOUSRESULT
   10. ViewerCommands.NEXTRESULT
   11. ViewerCommands.UPDATEGUILAYOUT
   12. ViewerCommands.VISITWEBSITE
   13. ViewerCommands.HIGHLIGHT
6. ダイアログ
   1. ViewerCommands.ABOUT
   2. ViewerCommands.BITMAP
   3. ViewerCommands.IMAGES
   4. ViewerCommands.TEXT
   5. ViewerCommands.DOCINFO
   6. ViewerCommands.TIP
   7. ViewerCommands.PREFERENCES
   8. ViewerCommands.EXTRACTTEXT
   9. ViewerCommands.EXTRACTIMAGE
   10. ViewerCommands.SNAPSHOT
   11. ViewerCommands.SIGN
7. カスタマイズ
   1. ViewerCommands.SETDISPLAYBACKGROUND
   2. ViewerCommands.SETPAGECOLOR
   3. ViewerCommands.SETTEXTCOLOR
   4. ViewerCommands.CHANGELINEART
   5. ViewerCommands.SETREPLACEMENTCOLORTHRESHOLD
   6. ViewerCommands.SETUNDRAWNPAGECOLOR
   7. ViewerCommands.AUTOSCROLL
   8. ViewerCommands.HIDEVERSIONNUMBER
   9. ViewerCommands.SHOWVERSIONNUMBER

指定されたPDFを開くか、PDFを選択するためのダイアログを開きます。

入力値
このメソッドの各呼び出しは、以下のいずれかのタイプの値を受け入れることができます。

• PDFまたは画像の絶対ファイル名を表すString型
• PDFまたは画像のFileオブジェクト
• PDFまたは画像ファイルの内容を含むInputStreamとそれに続くファイル名を表すString型（オプション）
• PDFまたは画像の内容を含むbyte[]とそれに続くファイル名を表すString型
• 入力なし（代わりにPDFを選択するダイアログを開く）

出力値 なし

指定されたURLからPDFを開くか、URLを入力するためのダイアログを開きます。

入力値
このメソッドの各呼び出しは、以下のいずれかのタイプの値を受け入れることができます。

• PDFを指すURLを表すString型
• 入力なし（代わりにURLを入力するダイアログを開く）

出力値 なし

最後に開いたドキュメントを開きます。このコマンドは、ファイルメニューにある最近使用したファイルリストを使用して動作します。

入力値
なし

出力値 なし

次に開かれるドキュメントを開きます。これはViewerCommands.PREVIOUSDOCUMENTの後に使用して、以前に表示していたドキュメントに戻ることができます。

入力値
なし

出力値 なし

ビューアを閉じます。ビューアにはViewer.exitOnCloseというフラグがあります。これがtrueの場合、ビューアはSystem.exit(1)を呼び出し、JVMをシャットダウンします。

入力値
なし

出力値 なし

指定されたページ数だけ前方にナビゲートします。

入力値 このメソッドの各呼び出しは、以下のいずれかのタイプの値を受け入れることができます。

• 前方に移動するページ数を指定するString型（現在のページを指定された量だけ増やす）
• なし（次のページに移動する、現在のページを1つ増やす）

出力値 なし

10ページ前方にナビゲートします。

入力値
なし

出力値 なし

指定されたページ数だけ後方にナビゲートします。

入力値
このメソッドの各呼び出しは、以下のいずれかのタイプの値を受け入れることができます。

• 後方に移動するページ数を指定するString型（現在のページを指定された量だけ減らす）
• なし（次のページに移動する、現在のページを1つ減らす）

出力値 なし

10ページ後方にナビゲートします。

入力値
なし

出力値 なし

ドキュメントの最初のページにナビゲートします。

入力値
なし

出力値 なし

ドキュメントの最後のページにナビゲートします。

入力値
なし

出力値 なし

ドキュメントの指定されたページにナビゲートします。

入力値
ナビゲート先のページ番号を表すString型

出力値 なし

PDF内の指定されたブックマークにナビゲートします。

入力値
PDF内のブックマーク名を表すString型

出力値 なし

ページの指定された部分を表示するようにナビゲートします。これはページの拡大縮小や回転には影響しません。

入力値
このコマンドは2つの入力を受け取ります。

1. ページ上の領域を記述するRectangleオブジェクト
2. スクロール先の領域を含むページを指定するInteger型

出力値 なし

ページの回転を指定された量に設定します。

入力値
“0”、“90”、“180”、“270"のいずれかのString値

出力値 なし

ページを現在の回転から反時計回りに90度回転させます。

入力値
なし

出力値 なし

ページを現在の回転から時計回りに90度回転させます。

入力値
なし

出力値 なし

ページの拡大縮小を指定された量に設定します。

入力値
必要な拡大縮小のViewerScaling値。可能な値は以下の通りです：

• ViewerScaling.FIT_WIDTH
• ViewerScaling.FIT_HEIGHT
• ViewerScaling.FIT_PAGE
• ViewerScaling.PERCENT_50
• ViewerScaling.PERCENT_100
• ViewerScaling.PERCENT_150
• ViewerScaling.PERCENT_200
• ViewerScaling.PERCENT_250
• ViewerScaling.CUSTOM（その後に拡大縮小率のパーセンテージを表すString値が続く）

例：

Viewer.executeCommand(ViewerCommands.SCALING, ViewerScaling.CUSTOM, "80"); // ページを80%に拡大縮小

Viewer.executeCommand(ViewerCommands.SCALING, ViewerScaling.FIT_WIDTH); // ビューアの幅に合わせてページを拡大縮小

出力値 なし

拡大縮小コンボボックス内の次に大きい値にページの拡大縮小を増やします

入力値
なし

出力値 なし

拡大縮小コンボボックス内の次に小さい値にページの拡大縮小を減らします

入力値
なし

出力値 なし

表示モードをシングルページモードに設定します。このモードは、ビューアに一度に1ページを表示します。

入力値
なし

出力値 なし

表示モードを連続ページモードに設定します。このモードは、すべてのページを連続した1列のページとして表示し、必要に応じて読み込まれ、レンダリングされます。

入力値
なし

出力値 なし

表示モードを連続見開きページモードに設定します。このモードは、すべてのページを2ページの連続した列として表示し、必要に応じて読み込まれ、レンダリングされます。奇数ページは右側、偶数ページは左側に表示されます。

入力値
なし

出力値 なし

表示モードを見開きページモードに設定します。このモードは、1行に2ページを表示し、必要に応じて読み込まれ、レンダリングされます。奇数ページは右側、偶数ページは左側に表示されます。2ページしかない場合、奇数ページが左側に表示され、隣り合って表示されます。

入力値
なし

出力値 なし

表示モードをページフローページモードに設定します。このモードは、ビューの中央に1ページを表示し、他のすべてのページはY軸に沿って回転されます。この表示モードは動作するためにJavaFXが必要です。

入力値
なし

出力値 なし

表示モードを詳細モードに設定し、ポートフォリオ内の各アイテムの詳細テーブルを表示します。この機能はポートフォリオPDFが開かれているときのみ動作します。

入力値
なし

出力値 なし

表示モードをタイルモードに設定し、ポートフォリオ内の各アイテムの一連のタイルを表示します。この機能はポートフォリオPDFが開かれているときのみ動作します。

入力値
なし

出力値 なし

ビューアをフルスクリーンモードで表示するように設定します。これにより、標準フレームが非表示になり、ビューアが画面全体を占めます。
オンの場合、奇数ページは右側に配置され、そうでない場合は左側に配置されます。

入力値
なし

出力値 なし

現在のファイル（または指定されたファイル）を現在のシステムのデフォルトアプリケーションで開きます。

入力値 このメソッドの各呼び出しは、以下のいずれかのタイプの値を受け入れることができます。

• PDFの絶対ファイル名を表すString型
• なし（代わりにビューアで現在開かれているファイルを開く）

出力値 なし

見開きモードと連続見開きモードで使用される表紙を分離するオプションを切り替えます。最初のページを単独で表示するかどうかを設定します。

入力値
なし

出力値 なし

1未満のストローク幅でレンダリングされる線を、代わりに幅1でレンダリングするかどうかを設定します。
これにより、線が小さくなりすぎて表示されなくなることを防ぎます。

入力値
このオプションをオン（true）またはオフ（false）にするBoolean値

出力値 なし

ストロークされた図形がコンテンツの幅を無視し、代わりにすべての図形をストローク1でレンダリングするかどうかを設定します。

入力値
このオプションをオン（true）またはオフ（false）にするBoolean値

出力値 なし

編集可能なフォームフィールドをページ上で見つけやすくするためにハイライト表示するかどうかを設定します。

入力値
このオプションをオン（true）またはオフ（false）にするBoolean値

出力値 なし

フォームコンテンツへの変更を含むPDFを保存します。これにより、ファイルを保存する場所を指定するダイアログが開きます。

入力値
なし

出力値 なし

印刷オプションを指定し、ファイルを印刷するためのダイアログを開きます。

入力値
なし

出力値 なし

2つのマウスモード、テキスト選択（マウスでテキストを選択可能）とパンモード（マウスを使用してページビューを移動可能）を切り替えます。現在のモードがテキスト選択の場合、この機能はパンモードに変更します。現在のモードがパンモードの場合、この機能はテキスト選択に変更します。

入力値
なし

出力値 なし

現在のマウスモードをパンモードに設定します。これにより、マウスをドラッグしてページの表示領域を変更できます。

入力値
なし

出力値 なし

現在のマウスモードをテキスト選択に設定します。これにより、テキスト上でクリックしてドラッグすることでテキストを選択できます。

入力値
なし

出力値 なし

現在のページ上のすべてのテキストがテキスト選択機能を使用してハイライト表示されます

入力値
なし

出力値 なし

現在のページ上のすべてのハイライトされたテキストのハイライトと選択が削除されます。

入力値
なし

出力値 なし

ページ上の特定のテキスト文字列を検索できます。完了すると、最初に見つかった結果がハイライト表示されます。

入力値
このコマンドは4つの入力値を受け入れます。

1. 検索する用語のString値
2. ビット単位のORを使用して複数のオプションを組み合わせたSearchType 値を表すInteger型
3. 文字列をスペースで区切られた複数の検索用語として扱うか（trueの場合）、そうでないかを制御するBoolean型
4. 現在のページのみを検索するか（trueの場合）、ドキュメント全体を検索するかを指定するBoolean型

出力値 なし

現在ハイライト表示されている結果をクリアし、前の結果に表示を変更してハイライト表示します。

入力値
なし

出力値 Integer型が返され、以下の3つの可能な値のいずれかになります。

1. (Commands.FIRST_DOCUMENT_SEARCH_RESULT_NOW_SHOWN == 1) このアクションが検索から最初の検索結果に到達したときに返されます。
2. (Commands.SEARCH_RETURNED_TO_START == 2) このアクションが検索から最初の検索結果にループバックしたときに返されます。
3. (Commands.SEARCH_NOT_FOUND == 3) このドキュメントで検索結果が見つからなかった場合に返されます。

現在ハイライト表示されている結果をクリアし、次の結果に表示を変更してハイライト表示します。

入力値
なし

出力値 Integer型が返され、以下の3つの可能な値のいずれかになります。

1. (Commands.FIRST_DOCUMENT_SEARCH_RESULT_NOW_SHOWN == 1) このアクションが検索から最初の検索結果に到達したときに返されます。
2. (Commands.SEARCH_RETURNED_TO_START == 2) このアクションが検索から最初の検索結果にループバックしたときに返されます。
3. (Commands.SEARCH_NOT_FOUND == 3) このドキュメントで検索結果が見つからなかった場合に返されます。

ビューアが開いて表示されている間に、ビューア内のGUI要素の可視性を変更できます。

入力値
このコマンドは2つの入力値を受け入れます。要素名のString型。要素の新しい可視性のBoolean型（表示する場合はtrue、非表示にする場合はfalse）。

出力値 なし

システムのデフォルトWebブラウザを開き、IDRSolutionsのホームページを表示します。

入力値
なし

出力値 なし

ハイライト表示する領域またはテキストのセクションを指定します。

入力値
このコマンドは3つの入力値を受け入れます。

1. ページ上の領域を定義する4つの値のInteger配列を含むInteger[][]
2. ハイライトを適用するページ
3. 領域をテキスト選択として扱うか（false）、ハイライトの正確な領域として扱うか（true）を指定するBoolean型

出力値 なし

JPedalとは何か、JPedalとJavaのバージョン、JPedalのWebページへのリンクを記載したビューアのバージョン情報ダイアログを開きます。

入力値
なし

出力値 なし

すべてのページを異なる形式の個別の画像として抽出できるダイアログを開きます。

入力値
なし

出力値 なし

PDFページからすべての画像コンテンツを抽出できるダイアログを開きます。

入力値
なし

出力値 なし

PDFページからすべてのテキストコンテンツを抽出できるダイアログを開きます。

入力値
なし

出力値 なし

ページサイズとトリミング値、フォント、フォームなど、現在のPDFに関するさまざまな情報を表示するダイアログを開きます。

入力値
なし

出力値 なし

ビューアの使用に関するランダムなヒントを表示するダイアログを開きます。これは、この機能を使用せずに起動時に実行できます。プロパティファイルキー「displaytipsonstartup」をtrueに設定 してください。

入力値
なし

出力値 なし

現在のプロパティファイルから読み込まれたビューアプロパティを表示するダイアログを開き、ユーザーがこれらの値を変更して変更を保存できるようにします。

入力値
なし

出力値 なし

現在ハイライト表示されているテキストのテキスト抽出プレビューとオプションを表示するダイアログを開きます。

入力値
なし

出力値 なし

ページ上の現在ハイライト表示されている画像コンテンツを保存できるダイアログを開きます（このコンテンツは、テキスト選択モードで画像をクリックすることでハイライト表示されます）。

入力値
なし

出力値 なし

トリガーされると、ユーザーはページ上の領域を選択でき、その後、ユーザーがキャンセル、選択した領域を画像として保存、または領域を画像としてシステムクリップボードにコピーできるダイアログが開きます。

入力値
なし

出力値 なし

トリガーされると、ユーザーが現在のPDFファイルに署名してエクスポートできるダイアログが開きます。

入力値
なし

出力値 なし

PDFページの背後にある表示の色を設定します。

入力値
Color値を表すInteger型。これはColor.getRGB()を使用して作成できます。

出力値 なし

PDFページの背景色を設定します。

入力値
Color値を表すInteger型。これはColor.getRGB()を使用して作成できます。

出力値 なし

PDFページ上のテキストの色を設定します。

入力値
Color値を表すInteger型。これはColor.getRGB()を使用して作成できます。

出力値 なし

テキストと同様に図形も色を変更するかどうかを指定します。

入力値
図形の色をテキストの色に合わせて変更するかどうかを指定するBoolean型

出力値 なし

テキストの色が置き換えられるしきい値を設定します。このしきい値は、すべてのRGB値が置き換えられるために下回る必要がある値です。

入力値
どのテキストの色が置き換えられるかを決定するために使用されるInteger値

出力値 なし

コンテンツが描画される前に表示されるPDFページの色を設定します。

入力値
Color値を表すInteger型。これはColor.getRGB()を使用して作成できます。

出力値 なし

テキストを選択している間にビューアがページをスクロールするかどうかを切り替えることができます。デフォルトではこのオプションはtrueですが、プロパティファイルで変更できます。

入力値
なし

出力値 なし

ユーザーがデフォルトのJFrameタイトルバーからJPedalバージョン番号を削除できるようにします。

入力値
なし

出力値 なし

ユーザーがデフォルトのJFrameタイトルバーにJPedalバージョン番号を含めることができるようにします。

入力値
なし

出力値 なし