PtlAnnot

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

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

java.lang.AutoCloseable

直系の既知のサブクラス:

PtlAnnotLink, PtlAnnotMarkup, PtlAnnotPopup
```
public class PtlAnnot
extends java.lang.Object
implements java.lang.AutoCloseable
```
PDFの注釈を表現したクラスです。
すべての注釈クラスのベースクラスです。

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

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`PtlAnnot.ANNOT_TYPE` 注釈のタイプ
`static class`	`PtlAnnot.BORDER_LINE_WIDTH` 境界線幅
`static class`	`PtlAnnot.BORDER_STYLE` 境界線スタイル

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`FLAG_HIDDEN` 注釈タイプあるいはハンドラの有無にかかわらず、この注釈の表示、印刷、およびユーザとの対話をできないようにします。
`static int`	`FLAG_INVISIBLE` 標準タイプに属さず、注釈ハンドラがない場合は、表示しません。
`static int`	`FLAG_LOCKED` 削除やプロパティを変更することはできなくなります。
`static int`	`FLAG_LOCKED_CONTENTS` 注釈の内容を変更することはできなくなります。
`static int`	`FLAG_NOROTATE` 注釈の外観をページにあわせて回転しません。
`static int`	`FLAG_NOVIEW` スクリーン上に表示されず、ユーザとの対話もできなくなります。
`static int`	`FLAG_NOZOOM` 注釈の外観をページの倍率にあわせて拡縮しません。
`static int`	`FLAG_PRINT` ページが印刷される場合は注釈も印刷されます。
`static int`	`FLAG_READONLY` ユーザとの対話ができなくなります。
`static int`	`FLAG_TOGGLE_NOVIEW` 特定のイベントに対して NoView フラグの解釈を反転します。

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

コンストラクタ
コンストラクタと説明
`PtlAnnot(int type)`
`PtlAnnot(PtlAnnot.ANNOT_TYPE type)` コンストラクタ
`PtlAnnot(PtlAnnot obj)` コピーコンストラクタ alias copy

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`close()` 終了処理。
`int`	`getAnnotFlags()` 注釈フラグを取得。
`PtlAnnot.BORDER_STYLE`	`getBorderStyle()` 境界線スタイルを取得。
`PtlAnnot.BORDER_LINE_WIDTH`	`getBorderWidth()` 境界線幅をBORDER_LINE_WIDTHで取得。
`float`	`getBorderWidthNative()` 注釈に設定してある境界線幅を直接取得。
`PtlColor`	`getColor()` 色を取得。
`PtlDate`	`getDate()` 日時を取得。
`PtlColor`	`getInteriorColor()` 内部色を取得。
`PtlRect`	`getRect()` 矩形座標を取得。
`java.lang.String`	`getTextContents()` 内容を取得。
`PtlAnnot.ANNOT_TYPE`	`getType()` 注釈タイプを取得。
`boolean`	`isMarkup()` マークアップ注釈か否かを取得。
`void`	`setAnnotFlags(int flag)` 注釈フラグを設定。
`void`	`setBorderStyle(PtlAnnot.BORDER_STYLE style)` 境界線スタイルを設定。
`void`	`setBorderWidth(PtlAnnot.BORDER_LINE_WIDTH width)` 境界線幅をBORDER_LINE_WIDTHで設定。
`void`	`setBorderWidthNative(float width)` 注釈の境界線幅を数値で直接設定。
`void`	`setColor(PtlColorDeviceRGB color)` 色を設定。
`void`	`setDate(PtlDate date)` 日時を設定。
`void`	`setInteriorColor(PtlColorDeviceRGB color)` 内部色を設定。
`void`	`setRect(PtlRect rectMM)` 矩形座標を設定。
`void`	`setTextContents(java.lang.String contents)` 内容を設定。

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

- フィールドの詳細
  - FLAG_INVISIBLE
```
public static final int FLAG_INVISIBLE
```
    標準タイプに属さず、注釈ハンドラがない場合は、表示しません。
    
    関連項目:
    
    定数フィールド値
  - FLAG_HIDDEN
```
public static final int FLAG_HIDDEN
```
    注釈タイプあるいはハンドラの有無にかかわらず、この注釈の表示、印刷、およびユーザとの対話をできないようにします。
    
    関連項目:
    
    定数フィールド値
  - FLAG_PRINT
```
public static final int FLAG_PRINT
```
    ページが印刷される場合は注釈も印刷されます。
    
    関連項目:
    
    定数フィールド値
  - FLAG_NOZOOM
```
public static final int FLAG_NOZOOM
```
    注釈の外観をページの倍率にあわせて拡縮しません。
    
    関連項目:
    
    定数フィールド値
  - FLAG_NOROTATE
```
public static final int FLAG_NOROTATE
```
    注釈の外観をページにあわせて回転しません。
    
    関連項目:
    
    定数フィールド値
  - FLAG_NOVIEW
```
public static final int FLAG_NOVIEW
```
    スクリーン上に表示されず、ユーザとの対話もできなくなります。
    
    関連項目:
    
    定数フィールド値
  - FLAG_READONLY
```
public static final int FLAG_READONLY
```
    ユーザとの対話ができなくなります。
    
    関連項目:
    
    定数フィールド値
  - FLAG_LOCKED
```
public static final int FLAG_LOCKED
```
    削除やプロパティを変更することはできなくなります。
    
    関連項目:
    
    定数フィールド値
  - FLAG_TOGGLE_NOVIEW
```
public static final int FLAG_TOGGLE_NOVIEW
```
    特定のイベントに対して NoView フラグの解釈を反転します。
    
    関連項目:
    
    定数フィールド値
  - FLAG_LOCKED_CONTENTS
```
public static final int FLAG_LOCKED_CONTENTS
```
    注釈の内容を変更することはできなくなります。
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - PtlAnnot
```
public PtlAnnot(PtlAnnot.ANNOT_TYPE type)
         throws PtlException
```
    コンストラクタ
    
    パラメータ:
    
    type - タイプ
    
    例外:
    
    PtlException - 例外
  - PtlAnnot
```
public PtlAnnot(int type)
         throws PtlException
```
    例外:
    
    PtlException
  - PtlAnnot
```
public PtlAnnot(PtlAnnot obj)
         throws PtlException
```
    コピーコンストラクタ
    alias copy
    
    パラメータ:
    
    obj - コピー元オブジェクト。
    
    例外:
    
    PtlException - 例外
- メソッドの詳細
  - close
```
public void close()
```
    終了処理。
    このオブジェクトが抱えているネイティブ側にあるリソースなどを廃棄して終了処理を行ないます。
    このオブジェクトを使い終わったら必ず呼ばなければなりません。
    
    定義:
    
    close インタフェース内 java.lang.AutoCloseable
  - getType
```
public PtlAnnot.ANNOT_TYPE getType()
                            throws PtlException
```
    注釈タイプを取得。
    
    戻り値:
    
    注釈タイプ
    
    例外:
    
    PtlException - 例外
  - isMarkup
```
public boolean isMarkup()
                 throws PtlException
```
    マークアップ注釈か否かを取得。
    マークアップ注釈か否かを取得します。
    
    戻り値:
    
    true: マークアップ注釈。false: マークアップ注釈でない。
    
    例外:
    
    PtlException - 例外
  - getRect
```
public PtlRect getRect()
                throws PtlException
```
    矩形座標を取得。
    座標の単位はmmで原点(0,0)は左下となりますので注意してください。
    
    戻り値:
    
    矩形座標(PtlRect)
    
    例外:
    
    PtlException - 例外
  - setRect
```
public void setRect(PtlRect rectMM)
             throws PtlException
```
    矩形座標を設定。
    座標の単位はmmで原点(0,0)は左下となりますので注意してください。
    ※ 注意事項
    PtlAnnotTextMarkupはPtlQuadPointsにQuadPointを追加したら自動的に矩形座標は設定されますので
    この関数で矩形座標を設定しないでください。
    
    パラメータ:
    
    rectMM - 矩形座標(PtlRect)
    
    例外:
    
    PtlException - 例外
  - getTextContents
```
public java.lang.String getTextContents()
                                 throws PtlException
```
    内容を取得。
    テキスト文字列の内容を取得します。
    注意：
    このテキスト文字列は以下の目的で使用されます。
```
 ・注釈用に表示されるテキスト
 ・可読な形式での注釈コンテンツの代替説明
 
```
    戻り値:
    
    テキスト文字列
    
    例外:
    
    PtlException - 例外
  - setTextContents
```
public void setTextContents(java.lang.String contents)
                     throws PtlException
```
    内容を設定。
    テキスト文字列の内容を設定します。
    注意：
    このテキスト文字列は以下の目的で使用されます。
```
 ・注釈用に表示されるテキスト
 ・可読な形式での注釈コンテンツの代替説明
 
```
    パラメータ:
    
    contents - テキスト文字列
    
    例外:
    
    PtlException - 例外
  - getDate
```
public PtlDate getDate()
                throws PtlException
```
    日時を取得。
    
    戻り値:
    
    日時オブジェクト(PtlDate)
    
    例外:
    
    PtlException - 例外
  - setDate
```
public void setDate(PtlDate date)
             throws PtlException
```
    日時を設定。
    
    パラメータ:
    
    date - 設定する日時オブジェクト(PtlDate)
    
    例外:
    
    PtlException - 例外
  - getAnnotFlags
```
public int getAnnotFlags()
                  throws PtlException
```
    注釈フラグを取得。
    フラグの定義が論理和で指定されています。
    
    戻り値:
    
    フラグ。FLAG_XXXのフラグ。
    
    例外:
    
    PtlException - 例外
  - setAnnotFlags
```
public void setAnnotFlags(int flag)
                   throws PtlException
```
    注釈フラグを設定。
    フラグの定義を論理和で指定します。
    設定しない場合は、各注釈により下記の値が設定されたとみなされます。
    PtlAnnotText : FLAG_PRINT|FLAG_NOZOOM|FLAG_NOROTATE
    PtlAnnotLink : 0
    PtlAnnotStamp : FLAG_PRINT
    PtlAnnotPopup : FLAG_PRINT|FLAG_NOZOOM|FLAG_NOROTATE
    PtlAnnotFileAttachment : FLAG_PRINT|FLAG_NOZOOM|FLAG_NOROTATE
    
    パラメータ:
    
    flag - フラグ。FLAG_XXXのフラグ。
    
    例外:
    
    PtlException - 例外
  - getColor
```
public PtlColor getColor()
                  throws PtlException
```
    色を取得。
    下記注釈の色を取得します。
    ・FreeText : 線の色
    ・Line : 線の色
    ・Square : 線の色
    ・Circle : 線の色
    ・PolyLine : 線の色
    ・Polygon : 線の色
    ・Caret : Caretの色
    ・Ink : 線の色
    ・Squiggly : 線の色
    ・Highlight: Highlightの色
    ・Strikeout: Strikeoutの色
    ・Underline: Underlineの色
    
    戻り値:
    
    色が設定されている場合は、PtlColorDeviceRGB。そうでない場合はPtlColorNone。
    
    例外:
    
    PtlException - 例外
  - setColor
```
public void setColor(PtlColorDeviceRGB color)
              throws PtlException
```
    色を設定。
    下記注釈の色を設定します。
    ・FreeText : 線の色
    ・Line : 線の色
    ・Square : 線の色
    ・Circle : 線の色
    ・PolyLine : 線の色
    ・Polygon : 線の色
    ・Caret : Caretの色
    ・Ink : 線の色
    ・Squiggly : 線の色
    ・Highlight: Highlightの色
    ・Strikeout: Strikeoutの色
    ・Underline: Underlineの色
    
    パラメータ:
    
    color - 色
    
    例外:
    
    PtlException - 例外
  - getInteriorColor
```
public PtlColor getInteriorColor()
                          throws PtlException
```
    内部色を取得。
    下記注釈の内部色を取得します。
    ・FreeText
    ・Line
    ・Square
    ・Circle
    ・PolyLine
    ・Polygon
    
    戻り値:
    
    色が設定されている場合は、PtlColorDeviceRGB。そうでない場合はPtlColorNone。
    
    例外:
    
    PtlException - 例外
  - setInteriorColor
```
public void setInteriorColor(PtlColorDeviceRGB color)
                      throws PtlException
```
    内部色を設定。
    下記注釈の内部色を設定します。
    ・FreeText
    ・Line
    ・Square
    ・Circle
    ・PolyLine
    ・Polygon
    
    パラメータ:
    
    color - 色
    
    例外:
    
    PtlException - 例外
  - getBorderStyle
```
public PtlAnnot.BORDER_STYLE getBorderStyle()
                                     throws PtlException
```
    境界線スタイルを取得。
    
    戻り値:
    
    境界線スタイル。BORDER_XXXのいずれかの値。
    
    例外:
    
    PtlException - 例外
  - setBorderStyle
```
public void setBorderStyle(PtlAnnot.BORDER_STYLE style)
                    throws PtlException
```
    境界線スタイルを設定。
    
    パラメータ:
    
    style - 境界線スタイル。BORDER_XXXのいずれかの値。
    
    例外:
    
    PtlException - 例外
  - getBorderWidth
```
public PtlAnnot.BORDER_LINE_WIDTH getBorderWidth()
                                          throws PtlException
```
    境界線幅をBORDER_LINE_WIDTHで取得。
    境界線幅をPDFの設定値そのままで取得したい場合は、getBorderWidthNative()を使ってください。
    
    戻り値:
    
    境界線幅。BORDER_WIDTH_XXXのいずれかの値。
    
    例外:
    
    PtlException - 例外
  - setBorderWidth
```
public void setBorderWidth(PtlAnnot.BORDER_LINE_WIDTH width)
                    throws PtlException
```
    境界線幅をBORDER_LINE_WIDTHで設定。
    境界線幅を指定した数値で直接設定したい場合は、setBorderWidthNative()を使ってください。
    
    パラメータ:
    
    width - 境界線幅。BORDER_WIDTH_XXXのいずれかの値。
    
    例外:
    
    PtlException - 例外
  - getBorderWidthNative
```
public float getBorderWidthNative()
                           throws PtlException
```
    注釈に設定してある境界線幅を直接取得。
    
    戻り値:
    
    境界線幅。
    
    例外:
    
    PtlException - 例外
  - setBorderWidthNative
```
public void setBorderWidthNative(float width)
                          throws PtlException
```
    注釈の境界線幅を数値で直接設定。
    
    パラメータ:
    
    width - 境界線幅。mm単位で指定してください。
    
    例外:
    
    PtlException - 例外

クラス PtlAnnot

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

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

FLAG_INVISIBLE

FLAG_HIDDEN

FLAG_PRINT

FLAG_NOZOOM

FLAG_NOROTATE

FLAG_NOVIEW

FLAG_READONLY

FLAG_LOCKED

FLAG_TOGGLE_NOVIEW

FLAG_LOCKED_CONTENTS

コンストラクタの詳細

PtlAnnot

PtlAnnot

PtlAnnot

メソッドの詳細

close

getType

isMarkup

getRect

setRect

getTextContents

setTextContents

getDate

setDate

getAnnotFlags

setAnnotFlags

getColor

setColor

getInteriorColor

setInteriorColor

getBorderStyle

setBorderStyle

getBorderWidth

setBorderWidth

getBorderWidthNative

setBorderWidthNative