PtlPDFDocument

java.lang.Object
- jp.co.antenna.ptl.PtlPDFDocument

すべての実装されたインタフェース:

java.lang.AutoCloseable
```
public class PtlPDFDocument
extends java.lang.Object
implements java.lang.AutoCloseable
```
PDF文書を表現したクラスです。

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`PtlPDFDocument.PDFA_TYPE` PDF/Aのタイプ
`static class`	`PtlPDFDocument.SAVE_OPTION` 保存オプション

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

PtlPDFDocument()
コンストラクタ

PtlPDFDocument(PtlPDFDocument obj)
コピーコンストラクタ
alias copy

コンストラクタ
コンストラクタと説明
`PtlPDFDocument()` コンストラクタ
`PtlPDFDocument(PtlPDFDocument obj)` コピーコンストラクタ alias copy

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`appendWaterMark(PtlParamWaterMark waterMark)` 透かしを設定。
`void`	`close()` 終了処理。
`boolean`	`embedFonts()` フォント埋め込み。
`void`	`exportAnnotsToFDF(PtlParamOutput outParam)` マークアップ注釈のFDF文書へのエクスポート。
`void`	`exportFormFieldsToFDF(PtlParamOutput outParam)` フォームフィールドデータのFDF文書へのエクスポート。
`void`	`exportFormFieldsToXFDF(PtlParamOutput outParam)` フォームフィールドデータのXFDF文書へのエクスポート。
`PtlDocProperty`	`getDocProperty()` 文書プロパティを取得。
`PtlEmbeddedFiles`	`getEmbeddedFiles()` 添付ファイルコンテナを取得。
`PtlEncrypt`	`getEncrypt()` 暗号化情報を取得。
`int`	`getPageCount()` ページ数を取得。
`PtlPages`	`getPages()` ページコンテナを取得。
`PtlPDFDocument.PDFA_TYPE`	`getPDFAType()` PDF/Aタイプを取得。
`PtlOutline`	`getRootOutline()` ルートアウトライン(しおり)を取得。
`boolean`	`hasEmbeddedFiles()` 添付ファイルを持っているかどうかを取得。
`boolean`	`hasOutlines()` アウトライン(しおり)を持っているかどうかを取得。
`boolean`	`hasOwnerAuthority()` オーナー権限があるかどうかを取得。
`void`	`importAnnotsFromFDF(PtlParamInput inParam)` マークアップ注釈のFDFからのインポート。
`void`	`importAnnotsFromPDF(PtlParamInput inParam)` マークアップ注釈のPDFからのインポート。
`PtlFormFieldValues`	`importFormFieldsFromFDF(PtlParamInput inParam)` フォームフィールドデータのFDFからのインポート。
`void`	`importFormFieldsFromXFDF(PtlParamInput inParam)` フォームフィールドデータのXFDF文書からのインポート。
`boolean`	`isEncrypted()` 暗号化されているかどうかを取得。
`boolean`	`isEncryptedOnlyEmbeddedFiles()` 添付ファイルのみ暗号化されているかどうかを取得。
`boolean`	`isPDFA()` PDF/Aかどうかを取得。
`boolean`	`isPDFX()` PDF/Xかどうかを取得。
`boolean`	`isSignatured()` 署名付きかどうかを取得。
`void`	`load(PtlParamInput inParam)` PDF文書をロード。
`boolean`	`optimize(PtlParamOptimize paramOptimize)` 最適化。
`void`	`removeEncrypt()` 暗号化情報を削除。
`void`	`removeWaterMark(java.lang.String name)` 透かしを削除。
`void`	`resetForm()` フォームフィールドデータのリセット。
`void`	`save(PtlParamOutput outParam)` PDF文書を保存。
`PtlSearchTextResults`	`searchText(PtlParamSearchText paramSearchText)` テキスト検索。
`int`	`searchTextAndDoProcess(PtlParamSearchText paramSearchText)` テキスト検索して後処理。
`void`	`setEncrypt(PtlEncrypt encrypt)` 暗号化情報を設定。
`void`	`setExportEmptyDataFlg(boolean flg)` 空データ出力フラグの設定。
`void`	`setPassword(java.lang.String password)` パスワードを設定。
`void`	`setPKCS12(PtlParamInput inPKCS12)` KCS#12を設定。
`void`	`setRestriction(PtlParamRestriction restriction)` 閲覧制限を設定。
`void`	`setSaveOption(PtlPDFDocument.SAVE_OPTION option)` 保存時のオプションを設定。

クラスから継承されたメソッド java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - PtlPDFDocument
```
public PtlPDFDocument()
               throws PtlException
```
    コンストラクタ
    
    例外:
    
    PtlException - 例外
  - PtlPDFDocument
```
public PtlPDFDocument(PtlPDFDocument obj)
               throws PtlException
```
    コピーコンストラクタ
    alias copy
    
    パラメータ:
    
    obj - コピー元オブジェクト。
    
    例外:
    
    PtlException - 例外
- メソッドの詳細
  - close
```
public void close()
```
    終了処理。
    このオブジェクトが抱えているネイティブ側にあるリソースなどを廃棄して終了処理を行なう。
    このオブジェクトを使い終わったら必ず呼ばなければならない。
    
    定義:
    
    close インタフェース内 java.lang.AutoCloseable
  - setPassword
```
public void setPassword(java.lang.String password)
                 throws PtlException
```
    パスワードを設定。
    
    パラメータ:
    
    password - パスワード。
    
    例外:
    
    PtlException - 例外
  - setPKCS12
```
public void setPKCS12(PtlParamInput inPKCS12)
               throws PtlException
```
    KCS#12を設定。
    
    パラメータ:
    
    inPKCS12 - InputParam
    
    例外:
    
    PtlException - 例外
  - load
```
public void load(PtlParamInput inParam)
          throws PtlException
```
    PDF文書をロード。
    
    パラメータ:
    
    inParam - InputParam
    
    例外:
    
    PtlException - 例外
  - setSaveOption
```
public void setSaveOption(PtlPDFDocument.SAVE_OPTION option)
                   throws PtlException
```
    保存時のオプションを設定。
    オプションを設定しないと再構築して保存されます。
    
    パラメータ:
    
    option - 保存オプション。SAVE_XXXのいずれかの値。
    
    例外:
    
    PtlException - 例外
  - save
```
public void save(PtlParamOutput outParam)
          throws PtlException
```
    PDF文書を保存。
    
    パラメータ:
    
    outParam - OutputParam
    
    例外:
    
    PtlException - 例外
  - isEncrypted
```
public boolean isEncrypted()
                    throws PtlException
```
    暗号化されているかどうかを取得。
    
    戻り値:
    
    true: 暗号化されている、false: 暗号化されていない。
    
    例外:
    
    PtlException - 例外
  - isEncryptedOnlyEmbeddedFiles
```
public boolean isEncryptedOnlyEmbeddedFiles()
                                     throws PtlException
```
    添付ファイルのみ暗号化されているかどうかを取得。
    
    戻り値:
    
    true: 暗号化されている、false: 暗号化されていない。
    
    例外:
    
    PtlException - 例外
  - hasOwnerAuthority
```
public boolean hasOwnerAuthority()
                          throws PtlException
```
    オーナー権限があるかどうかを取得。
    暗号化されていない場合、hasOwnerAuthorityはfalseです。
    
    暗号化されている場合は下記の通りです。
    
    ユーザーパスワード/オーナーパスワードの両方が設定されている場合、
    ユーザーパスワードでloadするとhasOwnerAuthorityはfalseです。
    オーナーパスワードでloadするとhasOwnerAuthorityはtrueです。
    
    ユーザーパスワードのみが設定されている場合、
    ユーザーパスワードでloadするとhasOwnerAuthorityはtrueです。
    
    オーナーパスワードのみが設定されている場合、
    オーナーパスワードでloadするとhasOwnerAuthorityはtrueです。
    パスワードの設定なしでloadするとhasOwnerAuthorityはfalseです。
    
    戻り値:
    
    true: 暗号化されている、false: 暗号化されていない。
    
    例外:
    
    PtlException - 例外
  - getEncrypt
```
public PtlEncrypt getEncrypt()
                      throws PtlException
```
    暗号化情報を取得。
    
    戻り値:
    
    暗号化情報。PtlEncryptStandardType1若しくはPtlEncryptStandardType2。
    
    例外:
    
    PtlException - 例外
  - setEncrypt
```
public void setEncrypt(PtlEncrypt encrypt)
                throws PtlException
```
    暗号化情報を設定。
    ※ 制限事項
    元のPDFの暗号化が256ビットAES暗号化でユーザーパスワードとオーナーパスワードが設定されている場合に制限事項があります。
    256ビットAES暗号化以外の暗号化に変更しユーザーパスワードを元のままとしたい場合はPtlEncryptStandardのsetUserPasswordで
    元のユーザーパスワードを設定する必要があります。
    また、V7.0以降のPDF Tool APIでは40bit暗号化が設定できません。
    そのため、encryptにPtlEncryptStandard40RC4が設定されていた場合、実行時に例外が発生します。
    
    パラメータ:
    
    encrypt - 暗号化情報
    
    例外:
    
    PtlException - 例外
  - removeEncrypt
```
public void removeEncrypt()
                   throws PtlException
```
    暗号化情報を削除。
    
    例外:
    
    PtlException - 例外
  - isSignatured
```
public boolean isSignatured()
                     throws PtlException
```
    署名付きかどうかを取得。
    
    戻り値:
    
    true: 署名付き、false: 署名付きでない。
    
    例外:
    
    PtlException - 例外
  - isPDFA
```
public boolean isPDFA()
               throws PtlException
```
    PDF/Aかどうかを取得。
    
    戻り値:
    
    true: PDF/A、false: PDF/Aでない。
    
    例外:
    
    PtlException - 例外
  - getPDFAType
```
public PtlPDFDocument.PDFA_TYPE getPDFAType()
                                     throws PtlException
```
    PDF/Aタイプを取得。
    
    戻り値:
    
    PDFA_TYPE。
    
    例外:
    
    PtlException - 例外
  - isPDFX
```
public boolean isPDFX()
               throws PtlException
```
    PDF/Xかどうかを取得。
    
    戻り値:
    
    true: PDF/X、false: PDF/Xでない。
    
    例外:
    
    PtlException - 例外
  - getDocProperty
```
public PtlDocProperty getDocProperty()
                              throws PtlException
```
    文書プロパティを取得。
    
    戻り値:
    
    文書プロパティ。
    
    例外:
    
    PtlException - 例外
  - getPageCount
```
public int getPageCount()
                 throws PtlException
```
    ページ数を取得。
    
    戻り値:
    
    ページ数
    
    例外:
    
    PtlException - 例外
  - getPages
```
public PtlPages getPages()
                  throws PtlException
```
    ページコンテナを取得。
    
    戻り値:
    
    ページコンテナ。
    
    例外:
    
    PtlException - 例外
  - hasOutlines
```
public boolean hasOutlines()
                    throws PtlException
```
    アウトライン(しおり)を持っているかどうかを取得。
    
    戻り値:
    
    true: 持っている、false: 持っていない。
    
    例外:
    
    PtlException - 例外
  - getRootOutline
```
public PtlOutline getRootOutline()
                          throws PtlException
```
    ルートアウトライン(しおり)を取得。
    ルートは仮想のしおりで一番上位にあり、他のしおりをたどっていく基点となります。
    アウトラインを持っていなくてもルートは取得されます。
    
    戻り値:
    
    ルートアウトライン。
    
    例外:
    
    PtlException - 例外
  - hasEmbeddedFiles
```
public boolean hasEmbeddedFiles()
                         throws PtlException
```
    添付ファイルを持っているかどうかを取得。
    PDF文書が添付ファイルを持っているかどうかを取得します。
    ここでの添付ファイルには添付ファイル注釈の添付ファイルは含まれません。
    
    戻り値:
    
    true: 持っている、false: 持っていない。
    
    例外:
    
    PtlException - 例外
  - getEmbeddedFiles
```
public PtlEmbeddedFiles getEmbeddedFiles()
                                  throws PtlException
```
    添付ファイルコンテナを取得。
    
    戻り値:
    
    添付ファイルコンテナ。
    
    例外:
    
    PtlException - 例外
  - appendWaterMark
```
public void appendWaterMark(PtlParamWaterMark waterMark)
                     throws PtlException
```
    透かしを設定。
    
    パラメータ:
    
    waterMark - 透かしのパラメータ
    
    例外:
    
    PtlException - 例外
  - removeWaterMark
```
public void removeWaterMark(java.lang.String name)
                     throws PtlException
```
    透かしを削除。
    
    パラメータ:
    
    name - 削除する透かしの名前
    
    例外:
    
    PtlException - 例外
  - setRestriction
```
public void setRestriction(PtlParamRestriction restriction)
                    throws PtlException
```
    閲覧制限を設定。
    注意：
    閲覧制限の内容を解析されないようオーナーパスワードの設定は必ず行ってください。
    
    パラメータ:
    
    restriction - 閲覧制限のパラメータ
    
    例外:
    
    PtlException - 例外
  - optimize
```
public boolean optimize(PtlParamOptimize paramOptimize)
                 throws PtlException
```
    最適化。
    
    パラメータ:
    
    paramOptimize - 最適化のパラメータ
    
    戻り値:
    
    true: 最適化された、false: 最適化されない。
    
    例外:
    
    PtlException - 例外
  - embedFonts
```
public boolean embedFonts()
                   throws PtlException
```
    フォント埋め込み。
    埋め込まれていないフォントを埋め込みフォントにします。
    ※ 埋め込みに使われるフォントがインストールされていないと埋め込み対象であっても埋め込みされません。
    
    戻り値:
    
    true: フォント埋め込みされた、false: フォント埋め込みされない。
    
    例外:
    
    PtlException - 例外
  - importAnnotsFromFDF
```
public void importAnnotsFromFDF(PtlParamInput inParam)
                         throws PtlException
```
    マークアップ注釈のFDFからのインポート。
    マークアップ注釈をFDFから取り込みます。
    
    パラメータ:
    
    inParam - InputParam
    
    例外:
    
    PtlException - 例外
  - importAnnotsFromPDF
```
public void importAnnotsFromPDF(PtlParamInput inParam)
                         throws PtlException
```
    マークアップ注釈のPDFからのインポート。
    マークアップ注釈をPDFから取り込みます。
    
    パラメータ:
    
    inParam - InputParam
    
    例外:
    
    PtlException - 例外
  - exportAnnotsToFDF
```
public void exportAnnotsToFDF(PtlParamOutput outParam)
                       throws PtlException
```
    マークアップ注釈のFDF文書へのエクスポート。
    マークアップ注釈をFDFに書き出します。
    
    パラメータ:
    
    outParam - OutputParam
    
    例外:
    
    PtlException - 例外
  - importFormFieldsFromFDF
```
public PtlFormFieldValues importFormFieldsFromFDF(PtlParamInput inParam)
                                           throws PtlException
```
    フォームフィールドデータのFDFからのインポート。
    フォームフィールドデータをFDFから取り込みフォームフィールドに設定します。
    
    パラメータ:
    
    inParam - InputParam
    
    戻り値:
    
    PtlFormFieldValues 設定できなかったフォームフィールド
    
    例外:
    
    PtlException - 例外
  - exportFormFieldsToFDF
```
public void exportFormFieldsToFDF(PtlParamOutput outParam)
                           throws PtlException
```
    フォームフィールドデータのFDF文書へのエクスポート。
    フォームフィールドデータをFDFに書き出します。
    
    パラメータ:
    
    outParam - OutputParam
    
    例外:
    
    PtlException - 例外
  - exportFormFieldsToXFDF
```
public void exportFormFieldsToXFDF(PtlParamOutput outParam)
                            throws PtlException
```
    フォームフィールドデータのXFDF文書へのエクスポート。
    フォームフィールドデータをXFDFに書き出します。
    
    パラメータ:
    
    outParam - OutputParam
    
    例外:
    
    PtlException - 例外
  - importFormFieldsFromXFDF
```
public void importFormFieldsFromXFDF(PtlParamInput inParam)
                              throws PtlException
```
    フォームフィールドデータのXFDF文書からのインポート。
    フォームフィールドデータをXFDFから取り込みフォームフィールドに設定します。
    
    パラメータ:
    
    inParam - IntputParam
    
    例外:
    
    PtlException - 例外
  - resetForm
```
public void resetForm()
               throws PtlException
```
    フォームフィールドデータのリセット。
    すべてのフォームフィールドデータを初期化します。
    
    例外:
    
    PtlException - 例外
  - setExportEmptyDataFlg
```
public void setExportEmptyDataFlg(boolean flg)
                           throws PtlException
```
    空データ出力フラグの設定。
    空のフォームフィールドデータを出力するかどうかを設定します。
    
    パラメータ:
    
    flg - 空のフォームデータを出力するか否か(trueなら出力する。
    
    例外:
    
    PtlException - 例外
  - searchTextAndDoProcess
```
public int searchTextAndDoProcess(PtlParamSearchText paramSearchText)
                           throws PtlException
```
    テキスト検索して後処理。
    検索できるのはコンテントに描画されるテキストエレメントからユニコードとして文字を取得できるもののみです。
    検索するテキストはコンテントに記述されている順番に取得されるのでビューワで見える通りの文字の並びとは限りません。
    またテキストに見えても実際は画像であったりパスであったりする場合もこれらは検索対象となりません。
    パラメータとしてPtlParamSearchTextAndHighlightが使用された場合は、検索された文字列に対してHighlight注釈処理が行われます。
    パラメータとしてPtlParamSearchTextAndSetMaskが使用された場合は、検索された文字列に対してMask処理が行われます。
    ※ 注意事項
    Mask処理は検索されたものは無条件に処理されます。
    定型文書でない一般文書などでは想定外のテキストがMask処理されてしまうことがありますのでこの関数の使用には
    十分注意して下さい。
    (例) "元日", "本日"のようにテキストが取得された場合、"日本"で検索するとヒットして"日"と"本"は削除されていまいます。
    
    パラメータ:
    
    paramSearchText - テキスト検索のパラメータ(PtlParamSearchTextAndHighlight若しくはPtlParamSearchTextAndSetMask)
    
    戻り値:
    
    検索されたテキストの数。
    
    例外:
    
    PtlException - 例外
  - searchText
```
public PtlSearchTextResults searchText(PtlParamSearchText paramSearchText)
                                throws PtlException
```
    テキスト検索。
    
    検索できるのはコンテントに描画されるテキストエレメントからユニコードとして文字を取得できるもののみです。
    検索するテキストはコンテントに記述されている順番に取得されるのでビューワで見える通りの文字の並びとは限りません。
    またテキストに見えても実際は画像であったりパスであったりする場合もこれらは検索対象となりません。
    
    パラメータ:
    
    paramSearchText - テキスト検索のパラメータ
    
    戻り値:
    
    PtlSearchTextResults。
    
    例外:
    
    PtlException - 例外

クラス PtlPDFDocument

ネストされたクラスのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

PtlPDFDocument

PtlPDFDocument

メソッドの詳細

close

setPassword

setPKCS12

load

setSaveOption

save

isEncrypted

isEncryptedOnlyEmbeddedFiles

hasOwnerAuthority

getEncrypt

setEncrypt

removeEncrypt

isSignatured

isPDFA

getPDFAType

isPDFX

getDocProperty

getPageCount

getPages

hasOutlines

getRootOutline

hasEmbeddedFiles

getEmbeddedFiles

appendWaterMark

removeWaterMark

setRestriction

optimize

embedFonts

importAnnotsFromFDF

importAnnotsFromPDF

exportAnnotsToFDF

importFormFieldsFromFDF

exportFormFieldsToFDF

exportFormFieldsToXFDF

importFormFieldsFromXFDF

resetForm

setExportEmptyDataFlg

searchTextAndDoProcess

searchText