PtlOpenMode

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

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

java.lang.AutoCloseable
```
public class PtlOpenMode
extends java.lang.Object
implements java.lang.AutoCloseable
```
PDFの開き方を表現したクラスです。
PtlOpenModeはPtlDocPropertyから取得して使用します。

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

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`PtlOpenMode.PAGE_LAYOUT` ページレイアウトタイプ文書を開いたときに使われるページレイアウトです。
`static class`	`PtlOpenMode.PAGE_MODE` ページモード文書を開いたときのページ表示方法です。

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`UI_OPTION_HIDE_MENUBAR` メニューバーを非表示
`static int`	`UI_OPTION_HIDE_TOOLBAR` ツールバーを非表示
`static int`	`UI_OPTION_HIDE_WINDOWUI` ウィンドウコントロールを非表示
`static int`	`UI_OPTION_NONE` なし
`static int`	`WINDOWS_OPTION_CENTER_WINDOW` ウィンドウを画面中央に配置
`static int`	`WINDOWS_OPTION_FIT_WINDOW` ページにウィンドウサイズを合あわせる
`static int`	`WINDOWS_OPTION_FULL_SCREEN` フルスクリーンモードで開く
`static int`	`WINDOWS_OPTION_NONE` なし

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

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

PtlOpenMode()
コンストラクタ

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

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`close()` 終了処理。
`boolean`	`getDisplayDocTitle()` ウィンドウのタイトルバーに文書タイトルを表示するかどうかのを取得。
`PtlAction`	`getOpenAction()` オープンアクションを取得。
`PtlDest`	`getOpenDest()` オープン時の宛先を取得。
`PtlOpenMode.PAGE_LAYOUT`	`getPageLayout()` ページレイアウトを取得。
`PtlOpenMode.PAGE_MODE`	`getPageMode()` ページモードを取得。
`int`	`getUIOption()` ユーザーインターフェイスオプションを取得。
`int`	`getWindowOption()` ウィンドウオプションを取得。
`boolean`	`hasPageLayout()` ページレイアウトを持っているかを取得。
`boolean`	`hasPageMode()` ページモードを持っているかを取得。
`void`	`removeOpenAction()` オープンアクションを削除。
`void`	`setDisplayDocTitle(boolean docTitle)` ウィンドウのタイトルバーに文書タイトルを表示するかどうかを設定。
`void`	`setOpenAction(PtlAction action)` オープンアクションを設定。
`void`	`setOpenDest(PtlDest dest)` オープン時の宛先を設定。
`void`	`setPageLayout(PtlOpenMode.PAGE_LAYOUT pageLayout)` ページレイアウトを設定。
`void`	`setPageMode(PtlOpenMode.PAGE_MODE pageMode)` ページモードを設定。
`void`	`setUIOption(int option)` ユーザーインターフェイスオプションを設定。
`void`	`setWindowOption(int option)` ウィンドウオプションを設定。

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

- フィールドの詳細
  - WINDOWS_OPTION_NONE
```
public static final int WINDOWS_OPTION_NONE
```
    なし
    
    関連項目:
    
    定数フィールド値
  - WINDOWS_OPTION_FIT_WINDOW
```
public static final int WINDOWS_OPTION_FIT_WINDOW
```
    ページにウィンドウサイズを合あわせる
    
    関連項目:
    
    定数フィールド値
  - WINDOWS_OPTION_CENTER_WINDOW
```
public static final int WINDOWS_OPTION_CENTER_WINDOW
```
    ウィンドウを画面中央に配置
    
    関連項目:
    
    定数フィールド値
  - WINDOWS_OPTION_FULL_SCREEN
```
public static final int WINDOWS_OPTION_FULL_SCREEN
```
    フルスクリーンモードで開く
    
    関連項目:
    
    定数フィールド値
  - UI_OPTION_NONE
```
public static final int UI_OPTION_NONE
```
    なし
    
    関連項目:
    
    定数フィールド値
  - UI_OPTION_HIDE_MENUBAR
```
public static final int UI_OPTION_HIDE_MENUBAR
```
    メニューバーを非表示
    
    関連項目:
    
    定数フィールド値
  - UI_OPTION_HIDE_TOOLBAR
```
public static final int UI_OPTION_HIDE_TOOLBAR
```
    ツールバーを非表示
    
    関連項目:
    
    定数フィールド値
  - UI_OPTION_HIDE_WINDOWUI
```
public static final int UI_OPTION_HIDE_WINDOWUI
```
    ウィンドウコントロールを非表示
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - PtlOpenMode
```
public PtlOpenMode()
            throws PtlException
```
    コンストラクタ
    
    例外:
    
    PtlException - 例外
  - PtlOpenMode
```
public PtlOpenMode(PtlOpenMode obj)
            throws PtlException
```
    コピーコンストラクタ
    alias copy
    
    パラメータ:
    
    obj - コピー元オブジェクト。
    
    例外:
    
    PtlException - 例外
- メソッドの詳細
  - close
```
public void close()
```
    終了処理。
    このオブジェクトが抱えているネイティブ側にあるリソースなどを廃棄して終了処理を行なう。
    このオブジェクトを使い終わったら必ず呼ばなければならない。
    
    定義:
    
    close インタフェース内 java.lang.AutoCloseable
  - hasPageMode
```
public boolean hasPageMode()
                    throws PtlException
```
    ページモードを持っているかを取得。
    
    戻り値:
    
    true: 持っている、false: 持っていない。
    
    例外:
    
    PtlException - 例外
  - getPageMode
```
public PtlOpenMode.PAGE_MODE getPageMode()
                                  throws PtlException
```
    ページモードを取得。
    
    戻り値:
    
    ページモード。PAGE_MODE_XXXのいずれかの値。
    
    例外:
    
    PtlException - 例外
  - setPageMode
```
public void setPageMode(PtlOpenMode.PAGE_MODE pageMode)
                 throws PtlException
```
    ページモードを設定。
    同時にsetWindowOptionでWINDOWS_OPTION_FULL_SCREENを指定すると後に設定したほうが反映されます。
    
    パラメータ:
    
    pageMode - ページモード。PAGE_MODE_XXXのいずれかの値。
    
    例外:
    
    PtlException - 例外
  - hasPageLayout
```
public boolean hasPageLayout()
                      throws PtlException
```
    ページレイアウトを持っているかを取得。
    
    戻り値:
    
    true: 持っている、false: 持っていない。
    
    例外:
    
    PtlException - 例外
  - getPageLayout
```
public PtlOpenMode.PAGE_LAYOUT getPageLayout()
                                      throws PtlException
```
    ページレイアウトを取得。
    
    戻り値:
    
    ページレイアウト。PAGE_LAYOUT_XXXのいずれかの値。
    
    例外:
    
    PtlException - 例外
  - setPageLayout
```
public void setPageLayout(PtlOpenMode.PAGE_LAYOUT pageLayout)
                   throws PtlException
```
    ページレイアウトを設定。
    
    パラメータ:
    
    pageLayout - ページレイアウト。PAGE_LAYOUT_XXXのいずれかの値。
    
    例外:
    
    PtlException - 例外
  - getOpenAction
```
public PtlAction getOpenAction()
                        throws PtlException
```
    オープンアクションを取得。
    PtlActionを取得後、タイプを確認の上使用して下さい。
    
    戻り値:
    
    PtlAction。
    
    例外:
    
    PtlException - 例外
  - setOpenAction
```
public void setOpenAction(PtlAction action)
                   throws PtlException
```
    オープンアクションを設定。
    同時にsetOpenDestを使用すると後に設定したほうが反映されます。
    AcrobatではPtlActionLaunch(PDFを指定したもの)、PtlActionGoToRを設定しても動作しません。
    
    パラメータ:
    
    action - アクション。
    
    例外:
    
    PtlException - 例外
  - getOpenDest
```
public PtlDest getOpenDest()
                    throws PtlException
```
    オープン時の宛先を取得。
    PtlDestを取得後、タイプを確認の上使用して下さい。
    GoToRの宛先は取得されません。GoToRの宛先はgetOpenActionから取得して下さい。
    
    戻り値:
    
    宛先
    
    例外:
    
    PtlException - 例外
  - setOpenDest
```
public void setOpenDest(PtlDest dest)
                 throws PtlException
```
    オープン時の宛先を設定。
    同時にsetOpenActionを使用すると後に設定したほうが反映されます。
    
    パラメータ:
    
    dest - 宛先
    
    例外:
    
    PtlException - 例外
  - removeOpenAction
```
public void removeOpenAction()
                      throws PtlException
```
    オープンアクションを削除。
    
    例外:
    
    PtlException - 例外
  - getWindowOption
```
public int getWindowOption()
                    throws PtlException
```
    ウィンドウオプションを取得。
    ウィンドウオプションが論理和で指定されています。
    
    戻り値:
    
    ウィンドウオプション。WINDOW_OPTION_XXXのウィンドウオプション。
    
    例外:
    
    PtlException - 例外
  - setWindowOption
```
public void setWindowOption(int option)
                     throws PtlException
```
    ウィンドウオプションを設定。
    ウィンドウオプションを論理和で指定します。
    同時にsetPageModeを使用すると後に設定したほうが反映されます。
    
    パラメータ:
    
    option - ウィンドウオプション。WINDOW_OPTION_XXXのウィンドウオプション。
    
    例外:
    
    PtlException - 例外
  - getDisplayDocTitle
```
public boolean getDisplayDocTitle()
                           throws PtlException
```
    ウィンドウのタイトルバーに文書タイトルを表示するかどうかのを取得。
    
    戻り値:
    
    true: 表示、false: 非表示。
    
    例外:
    
    PtlException - 例外
  - setDisplayDocTitle
```
public void setDisplayDocTitle(boolean docTitle)
                        throws PtlException
```
    ウィンドウのタイトルバーに文書タイトルを表示するかどうかを設定。
    
    パラメータ:
    
    docTitle - true: 表示、false: 非表示。
    
    例外:
    
    PtlException - 例外
  - getUIOption
```
public int getUIOption()
                throws PtlException
```
    ユーザーインターフェイスオプションを取得。
    ユーザーインターフェイスオプションが論理和で指定されています。
    
    戻り値:
    
    ユーザーインターフェイスオプション。UI_OPTION_XXXのユーザーインターフェイスオプション。
    
    例外:
    
    PtlException - 例外
  - setUIOption
```
public void setUIOption(int option)
                 throws PtlException
```
    ユーザーインターフェイスオプションを設定。
    ユーザーインターフェイスオプションを論理和で指定します。
    
    パラメータ:
    
    option - ユーザーインターフェイスオプション。UI_OPTION_XXXのユーザーインターフェイスオプション。
    
    例外:
    
    PtlException - 例外

クラス PtlOpenMode

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

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

WINDOWS_OPTION_NONE

WINDOWS_OPTION_FIT_WINDOW

WINDOWS_OPTION_CENTER_WINDOW

WINDOWS_OPTION_FULL_SCREEN

UI_OPTION_NONE

UI_OPTION_HIDE_MENUBAR

UI_OPTION_HIDE_TOOLBAR

UI_OPTION_HIDE_WINDOWUI

コンストラクタの詳細

PtlOpenMode

PtlOpenMode

メソッドの詳細

close

hasPageMode

getPageMode

setPageMode

hasPageLayout

getPageLayout

setPageLayout

getOpenAction

setOpenAction

getOpenDest

setOpenDest

removeOpenAction

getWindowOption

setWindowOption

getDisplayDocTitle

setDisplayDocTitle

getUIOption

setUIOption