PtlOutline

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

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

java.lang.AutoCloseable
```
public class PtlOutline
extends java.lang.Object
implements java.lang.AutoCloseable
```
PDFのアウトライン(しおり)を表現したクラスです。

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static int FLAG_BOLD
ボールド

static int FLAG_ITALIC
イタリック

static int FLAG_NORMAL
ノーマル

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`FLAG_BOLD` ボールド
`static int`	`FLAG_ITALIC` イタリック
`static int`	`FLAG_NORMAL` ノーマル

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

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

PtlOutline()
コンストラクタ

PtlOutline(PtlOutline obj)
コピーコンストラクタ

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`appendLastChild(PtlOutline item)` 子アウトラインを追加。
`void`	`appendNextSibling(PtlOutline item)` 兄弟アウトラインを追加。
`void`	`close()` 終了処理。
`void`	`destroy()` 自分自身及び子アウトラインを削除。
`PtlAction`	`getAction()` アクションを取得。
`PtlColorDeviceRGB`	`getColor()` アウトラインタイトルの色を取得。
`PtlDest`	`getDest()` 宛先を取得。
`PtlOutline`	`getFirstChild()` 最初の子アウトラインを取得。
`int`	`getFlags()` アウトラインフラグを取得。
`PtlOutline`	`getLastChild()` 最後の子アウトラインを取得。
`PtlOutline`	`getNextSibling()` 次の兄弟アウトラインを取得。
`PtlOutline`	`getParent()` 親アウトラインを取得。
`PtlOutline`	`getPrevSibling()` 前の兄弟アウトラインを取得。
`java.lang.String`	`getTitle()` アウトラインタイトル文字列を取得。
`boolean`	`hasChild()` 子アウトラインを持つかどうかを取得。
`boolean`	`hasNextSibling()` 次の兄弟アウトラインを持つかどうかを取得。
`boolean`	`hasParent()` PDF表示時の子アウトラインをオープンするかどうかを取得。
`boolean`	`hasPrevSibling()` 前の兄弟アウトラインを持つかどうかを取得。
`boolean`	`isOpen()` PDF表示時の子アウトラインをオープンするかどうかを取得。
`boolean`	`isRoot()` ルートかどうかを取得。
`void`	`removeAction()` アクションを削除。
`void`	`removeChildren()` 子アウトラインを削除。
`void`	`setAction(PtlAction action)` アクションを設定。
`void`	`setColor(PtlColorDeviceRGB color)` アウトラインタイトルの色を設定。
`void`	`setDest(PtlDest dest)` 宛先を設定。
`void`	`setFlags(int flags)` アウトラインフラグを設定。
`void`	`setOpen(boolean open)` PDF表示時の子アウトラインをオープンするかどうかを設定。
`void`	`setTitle(java.lang.String title)` アウトラインタイトル文字列を設定。

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

- フィールドの詳細
  - FLAG_NORMAL
```
public static final int FLAG_NORMAL
```
    ノーマル
    
    関連項目:
    
    定数フィールド値
  - FLAG_ITALIC
```
public static final int FLAG_ITALIC
```
    イタリック
    
    関連項目:
    
    定数フィールド値
  - FLAG_BOLD
```
public static final int FLAG_BOLD
```
    ボールド
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - PtlOutline
```
public PtlOutline()
           throws PtlException
```
    コンストラクタ
    
    例外:
    
    PtlException - 例外
  - PtlOutline
```
public PtlOutline(PtlOutline obj)
           throws PtlException
```
    コピーコンストラクタ
    
    パラメータ:
    
    obj - コピー元オブジェクト。
    
    例外:
    
    PtlException - 例外
- メソッドの詳細
  - close
```
public void close()
```
    終了処理。
    このオブジェクトが抱えているネイティブ側にあるリソースなどを廃棄して終了処理を行ないます。
    このオブジェクトを使い終わったら必ず呼ばなければなりません。
    
    定義:
    
    close インタフェース内 java.lang.AutoCloseable
  - isRoot
```
public boolean isRoot()
               throws PtlException
```
    ルートかどうかを取得。
    ルートは仮想のしおりで一番上位にあり、他のしおりをたどっていく基点となります。
    ルートは基点なので名前などはありません。
    
    戻り値:
    
    true: ルート項目である。false: ルート項目でない。
    
    例外:
    
    PtlException - 例外
  - getTitle
```
public java.lang.String getTitle()
                          throws PtlException
```
    アウトラインタイトル文字列を取得。
    
    戻り値:
    
    アウトラインタイトル
    
    例外:
    
    PtlException - 例外
  - setTitle
```
public void setTitle(java.lang.String title)
              throws PtlException
```
    アウトラインタイトル文字列を設定。
    
    パラメータ:
    
    title - アウトラインタイトル
    
    例外:
    
    PtlException - 例外
  - getAction
```
public PtlAction getAction()
                    throws PtlException
```
    アクションを取得。
    PtlActionを取得後、タイプを確認の上使用して下さい。
    
    戻り値:
    
    アクション
    
    例外:
    
    PtlException - 例外
  - setAction
```
public void setAction(PtlAction action)
               throws PtlException
```
    アクションを設定。
    同時にsetDestを使用すると後に設定したほうが反映されます。
    
    パラメータ:
    
    action - アクション
    
    例外:
    
    PtlException - 例外
  - removeAction
```
public void removeAction()
                  throws PtlException
```
    アクションを削除。
    
    例外:
    
    PtlException - 例外
  - getDest
```
public PtlDest getDest()
                throws PtlException
```
    宛先を取得。
    PtlDestを取得後、タイプを確認の上使用して下さい。
    GoToRの宛先は取得されません。GoToRの宛先はActionGoToRから取得して下さい。
    
    戻り値:
    
    宛先
    
    例外:
    
    PtlException - 例外
  - setDest
```
public void setDest(PtlDest dest)
             throws PtlException
```
    宛先を設定。
    
    パラメータ:
    
    dest - 宛先
    
    例外:
    
    PtlException - 例外
  - getColor
```
public PtlColorDeviceRGB getColor()
                           throws PtlException
```
    アウトラインタイトルの色を取得。
    
    戻り値:
    
    色
    
    例外:
    
    PtlException - 例外
  - setColor
```
public void setColor(PtlColorDeviceRGB color)
              throws PtlException
```
    アウトラインタイトルの色を設定。
    
    パラメータ:
    
    color - 色
    
    例外:
    
    PtlException - 例外
  - getFlags
```
public int getFlags()
             throws PtlException
```
    アウトラインフラグを取得。
    フラグの定義が論理和で指定されています。
    
    戻り値:
    
    フラグ。FLAG_XXXのフラグ。
    
    例外:
    
    PtlException - 例外
  - setFlags
```
public void setFlags(int flags)
              throws PtlException
```
    アウトラインフラグを設定。
    フラグの定義を論理和で指定します。
    
    パラメータ:
    
    flags - フラグ。FLAG_XXXのフラグ。
    
    例外:
    
    PtlException - 例外
  - isOpen
```
public boolean isOpen()
               throws PtlException
```
    PDF表示時の子アウトラインをオープンするかどうかを取得。
    
    戻り値:
    
    PDF表示時の子アウトラインをオープンする指定。trueならオープンする。
    
    例外:
    
    PtlException - 例外
  - setOpen
```
public void setOpen(boolean open)
             throws PtlException
```
    PDF表示時の子アウトラインをオープンするかどうかを設定。
    
    パラメータ:
    
    open - PDF表示時の子アウトラインをオープンする指定。trueならオープンする。
    
    例外:
    
    PtlException - 例外
  - hasParent
```
public boolean hasParent()
                  throws PtlException
```
    PDF表示時の子アウトラインをオープンするかどうかを取得。
    
    戻り値:
    
    PDF表示時の子アウトラインをオープンする指定。trueならオープンする。
    
    例外:
    
    PtlException - 例外
  - getParent
```
public PtlOutline getParent()
                     throws PtlException
```
    親アウトラインを取得。
    存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
    この関数の使用前にhasParent関数で親アウトラインの有無を確認してください。
    
    戻り値:
    
    親アウトライン。ない場合は例外をスローします。
    
    例外:
    
    PtlException - 例外
  - hasChild
```
public boolean hasChild()
                 throws PtlException
```
    子アウトラインを持つかどうかを取得。
    
    戻り値:
    
    true: 子アウトラインを持つ。false: 子アウトラインを持たない。
    
    例外:
    
    PtlException - 例外
  - getFirstChild
```
public PtlOutline getFirstChild()
                         throws PtlException
```
    最初の子アウトラインを取得。
    存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
    この関数の使用前にhasChild関数で子アウトラインの有無を確認してください。
    
    戻り値:
    
    子アウトライン。ない場合は例外をスローします。
    
    例外:
    
    PtlException - 例外
  - getLastChild
```
public PtlOutline getLastChild()
                        throws PtlException
```
    最後の子アウトラインを取得。
    存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
    この関数の使用前にhasChild関数で子アウトラインの有無を確認してください。
    
    戻り値:
    
    子アウトライン。ない場合は例外をスローします。
    
    例外:
    
    PtlException - 例外
  - hasPrevSibling
```
public boolean hasPrevSibling()
                       throws PtlException
```
    前の兄弟アウトラインを持つかどうかを取得。
    
    戻り値:
    
    true: 前の兄弟アウトラインを持つ。false: 前の兄弟アウトラインを持たない。
    
    例外:
    
    PtlException - 例外
  - getPrevSibling
```
public PtlOutline getPrevSibling()
                          throws PtlException
```
    前の兄弟アウトラインを取得。
    存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
    この関数の使用前にhasPrevSibling関数で前の兄弟アウトラインの有無を確認してください。
    
    戻り値:
    
    兄弟のアウトライン。ない場合は例外をスローします。
    
    例外:
    
    PtlException - 例外
  - hasNextSibling
```
public boolean hasNextSibling()
                       throws PtlException
```
    次の兄弟アウトラインを持つかどうかを取得。
    
    戻り値:
    
    true: 次の兄弟アウトラインを持つ。false: 次の兄弟アウトラインを持たない。
    
    例外:
    
    PtlException - 例外
  - getNextSibling
```
public PtlOutline getNextSibling()
                          throws PtlException
```
    次の兄弟アウトラインを取得。
    存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
    この関数の使用前にhasNextSibling関数で次の兄弟アウトラインの有無を確認してください。
    
    戻り値:
    
    兄弟のアウトライン。ない場合は例外をスローします。
    
    例外:
    
    PtlException - 例外
  - appendLastChild
```
public void appendLastChild(PtlOutline item)
                     throws PtlException
```
    子アウトラインを追加。
    最後に、子アウトラインを追加します。
    自分自身がルート項目，若しくはルート項目の子孫でない場合、例外が発生します。
    
    パラメータ:
    
    item - 子アウトライン
    
    例外:
    
    PtlException - 例外
  - appendNextSibling
```
public void appendNextSibling(PtlOutline item)
                       throws PtlException
```
    兄弟アウトラインを追加。
    最後に、兄弟アウトラインを追加します。
    自分自身がルート項目，若しくはルート項目の子孫でない場合、例外が発生します。
    
    パラメータ:
    
    item - 兄弟アウトライン
    
    例外:
    
    PtlException - 例外
  - removeChildren
```
public void removeChildren()
                    throws PtlException
```
    子アウトラインを削除。
    
    例外:
    
    PtlException - 例外
  - destroy
```
public void destroy()
             throws PtlException
```
    自分自身及び子アウトラインを削除。
    
    例外:
    
    PtlException - 例外

クラス PtlOutline

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

FLAG_NORMAL

FLAG_ITALIC

FLAG_BOLD

コンストラクタの詳細

PtlOutline

PtlOutline

メソッドの詳細

close

isRoot

getTitle

setTitle

getAction

setAction

removeAction

getDest

setDest

getColor

setColor

getFlags

setFlags

isOpen

setOpen

hasParent

getParent

hasChild

getFirstChild

getLastChild

hasPrevSibling

getPrevSibling

hasNextSibling

getNextSibling

appendLastChild

appendNextSibling

removeChildren

destroy