コードから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機能のリスト
- ファイルの開く/閉じる
- ページナビゲーション
- 表示コントロール
- ViewerCommands.ROTATION
- ViewerCommands.ROTATELEFT
- ViewerCommands.ROTATERIGHT
- ViewerCommands.SCALING
- ViewerCommands.ZOOMIN
- ViewerCommands.ZOOMOUT
- ViewerCommands.SINGLE
- ViewerCommands.CONTINUOUS
- ViewerCommands.CONTINUOUS_FACING
- ViewerCommands.FACING
- ViewerCommands.PAGEFLOW
- ViewerCommands.PORTFOLIO_DETAIL
- ViewerCommands.PORTFOLIO_TILES
- ViewerCommands.FULLSCREEN
- ViewerCommands.OPENINSYSTEMDEFAULT
- ページレンダリング設定
- インタラクティブ機能
- ViewerCommands.SAVE
- ViewerCommands.PRINT
- ViewerCommands.MOUSEMODE
- ViewerCommands.PANMODE
- ViewerCommands.TEXTSELECT
- ViewerCommands.SELECTALL
- ViewerCommands.DESELECTALL
- ViewerCommands.FIND
- ViewerCommands.PREVIOUSRESULT
- ViewerCommands.NEXTRESULT
- ViewerCommands.UPDATEGUILAYOUT
- ViewerCommands.VISITWEBSITE
- ViewerCommands.HIGHLIGHT
- ダイアログ
- カスタマイズ
指定された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つの入力を受け取ります。
- ページ上のスクロール先の領域を記述するRectangleオブジェクト。
- スクロール先の領域を含むページを指定する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つのページをビューアに表示します。
入力値
なし
出力値 なし
表示モードを連続ページモードに設定します。このモードは、すべてのページを連続した列として表示し、必要に応じて読み込んでレンダリングします。
入力値
なし
出力値 なし
表示モードを連続見開きページモードに設定します。このモードは、すべてのページを2ページの連続した列として表示し、必要に応じて読み込んでレンダリングします。奇数ページは右側、偶数ページは左側に配置されます。
入力値
なし
出力値 なし
表示モードを見開きページモードに設定します。このモードは、2ページを1行に表示し、必要に応じて読み込んでレンダリングします。奇数ページは右側、偶数ページは左側に配置されます。ページが2つしかない場合は、奇数ページが左側に表示され、隣り合って配置されます。
入力値
なし
出力値 なし
表示モードをページフローモードに設定します。このモードは、ビューの中央に1つのページを表示し、他のすべてのページはY軸に沿って回転します。この表示モードが機能するにはJavaFXが必要です。
入力値
なし
出力値 なし
表示モードを詳細モードに設定します。これにより、ポートフォリオ内の各アイテムの詳細のテーブルが表示されます。この機能は、ポートフォリオPDFが開いている場合にのみ機能します。
入力値
なし
出力値 なし
表示モードをタイルモードに設定します。これにより、ポートフォリオ内の各アイテムの一連のタイルが表示されます。この機能は、ポートフォリオPDFが開いている場合にのみ機能します。
入力値
なし
出力値 なし
ビューアをフルスクリーンモードで表示するように設定します。これにより、標準フレームが非表示になり、ビューアが画面全体を占めるようになります。
オンにすると、奇数ページが右側に配置され、そうでない場合は左側に配置されます。
入力値
なし
出力値 なし
現在のファイル(または指定されたファイル)を現在のシステムのデフォルトアプリケーションで開きます。
入力値 このメソッドの各呼び出しは、以下のいずれかのタイプの値を受け入れることができます。
- PDFの絶対ファイル名を表すString。
- なし。ビューアで現在開いているファイルを代わりに開きます。
出力値 なし
見開きモードと連続見開きモードで使用される、最初のページを単独で表示するかどうかを切り替えます。
入力値
なし
出力値 なし
1未満のストローク幅でレンダリングされる線を、代わりに幅1でレンダリングするかどうかを設定します。
これにより、線が小さくなりすぎて見えなくなるのを防ぎます。
入力値
このオプションをオン(true)またはオフ(false)にするBoolean値。
出力値 なし
ストローク図形がコンテンツの幅を無視し、代わりにすべての図形をストローク1でレンダリングするかどうかを設定します。
入力値
このオプションをオン(true)またはオフ(false)にするBoolean値。
出力値 なし
編集可能なフォームフィールドを強調表示して、ページ上で見つけやすくするかどうかを設定します。
入力値
このオプションをオン(true)またはオフ(false)にするBoolean値。
出力値 なし
フォーム内容の変更を含むPDFを保存します。ファイルを保存する場所を指定するダイアログが開きます。
入力値
なし
出力値 なし
印刷オプションを指定してファイルを印刷するダイアログを開きます。
入力値
なし
出力値 なし
2つのマウスモード、テキスト選択(マウスでテキストを選択できる)とパンモード(マウスでページビューを移動できる)を切り替えます。現在のモードがテキスト選択の場合、この機能はパンモードに変更します。現在のモードがパンモードの場合、この機能はテキスト選択に変更します。
入力値
なし
出力値 なし
現在のマウスモードをパンモードに設定します。これにより、マウスをドラッグしてページの表示領域を変更できます。
入力値
なし
出力値 なし
現在のマウスモードをテキスト選択に設定します。これにより、テキスト上でクリックしてドラッグし、選択できます。
入力値
なし
出力値 なし
現在のページ上のすべてのテキストがテキスト選択機能を使用して強調表示されます。
入力値
なし
出力値 なし
現在のページ上のすべての強調表示されたテキストから、強調表示と選択が削除されます。
入力値
なし
出力値 なし
ページ上の特定のテキスト文字列を検索できます。完了すると、最初に見つかった結果が強調表示されます。
入力値
このコマンドは4つの入力値を受け入れます。
- 検索する用語のString値。
- SearchType 値を表すInteger。ビット単位のORを使用して複数のオプションを組み合わせます。
- 文字列をスペースで区切られた複数の検索用語として扱うか(trueの場合)、そうでないかを制御するBoolean。
- 現在のページのみを検索するか(trueの場合)、またはドキュメント全体を検索するかを示すBoolean。
出力値 なし
現在の強調表示された結果をクリアし、前の結果に表示を変更し、それを強調表示します。
入力値
なし
出力値 3つの可能な値のいずれかを持つIntegerが返されます。
- (Commands.FIRST_DOCUMENT_SEARCH_RESULT_NOW_SHOWN == 1) このアクションが検索の最初の検索結果に到達したときに返されます。
- (Commands.SEARCH_RETURNED_TO_START == 2) このアクションが検索の最初の検索結果にループバックしたときに返されます。
- (Commands.SEARCH_NOT_FOUND == 3) このドキュメントで検索結果が見つからなかった場合に返されます。
現在の強調表示された結果をクリアし、次の結果に表示を変更し、それを強調表示します。
入力値
なし
出力値 3つの可能な値のいずれかを持つIntegerが返されます。
- (Commands.FIRST_DOCUMENT_SEARCH_RESULT_NOW_SHOWN == 1) このアクションが検索の最初の検索結果に到達したときに返されます。
- (Commands.SEARCH_RETURNED_TO_START == 2) このアクションが検索の最初の検索結果にループバックしたときに返されます。
- (Commands.SEARCH_NOT_FOUND == 3) このドキュメントで検索結果が見つからなかった場合に返されます。
ビューアが開いて表示されている間に、ビューア内のGUI要素の可視性を変更できます。
入力値
このコマンドは2つの入力値を受け入れます。要素名のString。要素の新しい可視性を示すBoolean(可視の場合はtrue、不可視の場合はfalse)。
出力値 なし
システムのデフォルトWebブラウザを開き、IDRSolutionsのホームページを表示します。
入力値
なし
出力値 なし
強調表示する領域またはテキストのセクションを指定します。
入力値
このコマンドは3つの入力値を受け入れます。
- ページ上の領域を定義する4つの値を持つInteger配列を含むInteger[][]。
- 強調表示を適用するページ。
- 領域をテキスト選択として扱うか(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バージョン番号を含めることができます。
入力値
なし
出力値 なし
