PdfPresetParam (JavaAPI API)

java.lang.Object
- net.createform.common.PdfPresetParam

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

java.io.Serializable, java.lang.Cloneable
```
public class PdfPresetParam
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
実行ランタイムの印刷プリセットパラメータオブジェクトクラス。
印刷プリセットを実行オプションから設定するための拡張実行オプションクラスです。

印刷プリセットでは以下の項目が設定可能です。
- ページの拡大/縮小
- 両面印刷モード
- ページサイズに合わせて用紙を選択
- 印刷ページ指定
- 部数
各印刷プリセットオプションの指定は、setXXX メソッドによって行います。例えば、ページの拡大/縮小"なし"設定を行う場合は、setScaling(PdfPresetParam.OPTION_PRESET_NOSCALING) を指定します。ページサイズに合わせて用紙を選択する設定を行う場合は、setTrayBySize(true) を指定します。

設定した印刷プリセットオプションは RuntimeParam オブジェクトにセットして使用します。
```
 PdfPresetParam preset = new PdfPresetParam();
 preset.setScaling(PdfPresetParam.OPTION_PRESET_NOSCALING);
 preset.setDuplex(PdfPresetParam.OPTION_PRESET_DUPLEXLONG);
 preset.setTrayBySize(true);
 preset.setRange("1-2,5-");
 preset.setNumCopy(3);

 RuntimeParam param = new RuntimeParam();
 param.setWorkDir("/somewhere/work_dir");
 param.setStyleFile("sample.sty");
 param.setOutFile("/somewhere/outfile_dir/sample.pdf");
 param.setDataFile("/somewhere/datafile_dir/sample.csv");
 param.setPdfPresetParam(preset);

 CCast libcall = new CCast();
 int RetVal = libcall.executeRuntime(param);
 
```
※ 印刷プリセットを設定した PDF ファイルを開くためには Acrobat 8.0 以上が必要となります。 Acrobat 7.0 以前では閲覧できませんのでご注意下さい。ページの拡大/縮小の設定のみであれば、Acrobat 7.0以上が必要となり、Acrobat 6.0 以前では閲覧できません。
導入されたバージョン:

v11.0

関連項目:

RuntimeParam, 直列化された形式

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static java.lang.String`	`OPTION_PRESET` 印刷プリセット設定オプション "-Y"
`static java.lang.String`	`OPTION_PRESET_DEFAULTSCALING` 印刷プリセットページの拡大/縮小 "デフォルト"設定オプション "-Ys0"
`static java.lang.String`	`OPTION_PRESET_DUPLEXLONG` 印刷プリセット両面印刷モード "両面(左右に開く)"設定オプション "-Yd1"
`static java.lang.String`	`OPTION_PRESET_DUPLEXSHORT` 印刷プリセット両面印刷モード "両面(上下に開く)"設定オプション "-Yd2"
`static java.lang.String`	`OPTION_PRESET_NOSCALING` 印刷プリセットページの拡大/縮小 "なし"設定オプション "-Ys1"
`static java.lang.String`	`OPTION_PRESET_NUMCOPY` 印刷プリセット部数設定オプション "-Yc"
`static java.lang.String`	`OPTION_PRESET_RANGE` 印刷プリセット印刷範囲ページ設定オプション "-Yr"
`static java.lang.String`	`OPTION_PRESET_RANGE_END` 印刷プリセット印刷範囲終了ページ設定オプション "-Yre"
`static java.lang.String`	`OPTION_PRESET_RANGE_SE` 印刷プリセット印刷ページ設定オプション "-Yrse"
`static java.lang.String`	`OPTION_PRESET_RANGE_START` 印刷プリセット印刷範囲開始ページ設定オプション "-Yrs"
`static java.lang.String`	`OPTION_PRESET_SIMPLEX` 印刷プリセット両面印刷モード "片面"設定オプション "-Yd0"
`static java.lang.String`	`OPTION_PRESET_TRAY_OFF` 印刷プリセットページサイズに合わせて用紙を"選択しない"設定オプション "-Ytn"
`static java.lang.String`	`OPTION_PRESET_TRAY_ON` 印刷プリセットページサイズに合わせて用紙を"選択する"設定オプション "-Yto"
`static java.lang.String`	`OPTION_PRESET_URANGE` 印刷プリセット印刷範囲ユニット設定オプション "-Yu"
`static java.lang.String`	`OPTION_PRESET_URANGE_END` 印刷プリセット印刷範囲終了ユニット設定オプション "-Yue"
`static java.lang.String`	`OPTION_PRESET_URANGE_SE` 印刷プリセット印刷ユニット設定オプション "-Yuse"
`static java.lang.String`	`OPTION_PRESET_URANGE_START` 印刷プリセット印刷範囲開始ユニット設定オプション "-Yus"
`static int`	`PRESET_DEFAULTSCALING` ページの拡大/縮小 - デフォルト
`static int`	`PRESET_DUPLEXLONG` 両面印刷モードフラグ - 両面(左右に開く)
`static int`	`PRESET_DUPLEXSHORT` 両面印刷モードフラグ - 両面(上下に開く)
`static int`	`PRESET_NOSCALING` ページの拡大/縮小 - なし
`static int`	`PRESET_SIMPLEX` 両面印刷モードフラグ - 片面

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

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

PdfPresetParam()

コンストラクタ
コンストラクタと説明
`PdfPresetParam()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`java.lang.Object`	`clone()`
`protected java.lang.String`	`generateCommandLine()` 与えられたパラメータからコマンドライン文字列を生成します。
`java.lang.String`	`getCommandLine()` 設定されているコマンドライン文字列を返します。
`int`	`getDuplex()` 設定されている両面印刷モードを返します。
`int`	`getNumCopy()` 設定されている部数を返します。
`java.lang.String`	`getRange()` 設定されている複数のページの印刷範囲を返します。
`int`	`getRangeEnd()` 設定されている印刷範囲の終了ページを返します。
`int`	`getRangeSE()` 設定されている印刷ページを返します。
`int`	`getRangeStart()` 設定されている印刷範囲の開始ページを返します。
`int`	`getScaling()` ページの拡大/縮小がなしかどうかを返します。
`java.lang.String`	`getUnitRange()` 設定されている複数のユニットの印刷範囲を返します。
`int`	`getUnitRangeEnd()` 設定されている印刷範囲の終了ユニットを返します。
`int`	`getUnitRangeSE()` 設定されている印刷ユニットを返します。
`int`	`getUnitRangeStart()` 設定されている印刷範囲の開始ユニットを返します。
`void`	`init()` すべてのプロパティを初期化します。
`boolean`	`isTrayBySize()` ページサイズに合わせて用紙を選択設定をしているかどうかを返します。
`protected void`	`parse()` コマンドライン文字列を解析する。
`void`	`setCommandLine(java.lang.String commandline)` コマンドライン文字列を設定します。
`void`	`setDuplex(int duplex)` 両面印刷モードの設定を行います。
`void`	`setNumCopy(int copy)` 部数の設定を行います。
`void`	`setRange(java.lang.String page)` 複数のページの印刷範囲を設定します。
`void`	`setRangeEnd(int epage)` 印刷範囲の終了ページの設定を行います。
`void`	`setRangeSE(int sepage)` 印刷ページの設定を行います。
`void`	`setRangeStart(int spage)` 印刷範囲の開始ページの設定を行います。
`void`	`setScaling(int scaling)` ページの拡大/縮小をなしにするかどうかを設定をします。
`void`	`setTrayBySize(boolean traybysize)` ページサイズに合わせて用紙を選択設定を行います。
`void`	`setUnitRange(java.lang.String unit)` 複数のユニットの印刷範囲を設定します。
`void`	`setUnitRangeEnd(int eunit)` 印刷範囲の終了ユニットの設定を行います。
`void`	`setUnitRangeSE(int seunit)` 印刷ユニットの設定を行います。
`void`	`setUnitRangeStart(int sunit)` 印刷範囲の開始ユニットの設定を行います。

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

- フィールドの詳細
  - OPTION_PRESET
```
public static final java.lang.String OPTION_PRESET
```
    印刷プリセット設定オプション "-Y"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_DEFAULTSCALING
```
public static final java.lang.String OPTION_PRESET_DEFAULTSCALING
```
    印刷プリセットページの拡大/縮小 "デフォルト"設定オプション "-Ys0"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_NOSCALING
```
public static final java.lang.String OPTION_PRESET_NOSCALING
```
    印刷プリセットページの拡大/縮小 "なし"設定オプション "-Ys1"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_SIMPLEX
```
public static final java.lang.String OPTION_PRESET_SIMPLEX
```
    印刷プリセット両面印刷モード "片面"設定オプション "-Yd0"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_DUPLEXLONG
```
public static final java.lang.String OPTION_PRESET_DUPLEXLONG
```
    印刷プリセット両面印刷モード "両面(左右に開く)"設定オプション "-Yd1"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_DUPLEXSHORT
```
public static final java.lang.String OPTION_PRESET_DUPLEXSHORT
```
    印刷プリセット両面印刷モード "両面(上下に開く)"設定オプション "-Yd2"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_TRAY_ON
```
public static final java.lang.String OPTION_PRESET_TRAY_ON
```
    印刷プリセットページサイズに合わせて用紙を"選択する"設定オプション "-Yto"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_TRAY_OFF
```
public static final java.lang.String OPTION_PRESET_TRAY_OFF
```
    印刷プリセットページサイズに合わせて用紙を"選択しない"設定オプション "-Ytn"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_RANGE
```
public static final java.lang.String OPTION_PRESET_RANGE
```
    印刷プリセット印刷範囲ページ設定オプション "-Yr"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_RANGE_START
```
public static final java.lang.String OPTION_PRESET_RANGE_START
```
    印刷プリセット印刷範囲開始ページ設定オプション "-Yrs"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_RANGE_END
```
public static final java.lang.String OPTION_PRESET_RANGE_END
```
    印刷プリセット印刷範囲終了ページ設定オプション "-Yre"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_RANGE_SE
```
public static final java.lang.String OPTION_PRESET_RANGE_SE
```
    印刷プリセット印刷ページ設定オプション "-Yrse"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_URANGE
```
public static final java.lang.String OPTION_PRESET_URANGE
```
    印刷プリセット印刷範囲ユニット設定オプション "-Yu"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_URANGE_START
```
public static final java.lang.String OPTION_PRESET_URANGE_START
```
    印刷プリセット印刷範囲開始ユニット設定オプション "-Yus"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_URANGE_END
```
public static final java.lang.String OPTION_PRESET_URANGE_END
```
    印刷プリセット印刷範囲終了ユニット設定オプション "-Yue"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_URANGE_SE
```
public static final java.lang.String OPTION_PRESET_URANGE_SE
```
    印刷プリセット印刷ユニット設定オプション "-Yuse"
    
    関連項目:
    
    定数フィールド値
  - OPTION_PRESET_NUMCOPY
```
public static final java.lang.String OPTION_PRESET_NUMCOPY
```
    印刷プリセット部数設定オプション "-Yc"
    
    関連項目:
    
    定数フィールド値
  - PRESET_DEFAULTSCALING
```
public static final int PRESET_DEFAULTSCALING
```
    ページの拡大/縮小 - デフォルト
    
    関連項目:
    
    setScaling(int), getScaling(), 定数フィールド値
  - PRESET_NOSCALING
```
public static final int PRESET_NOSCALING
```
    ページの拡大/縮小 - なし
    
    関連項目:
    
    setScaling(int), getScaling(), 定数フィールド値
  - PRESET_SIMPLEX
```
public static final int PRESET_SIMPLEX
```
    両面印刷モードフラグ - 片面
    
    関連項目:
    
    setDuplex(int), getDuplex(), 定数フィールド値
  - PRESET_DUPLEXLONG
```
public static final int PRESET_DUPLEXLONG
```
    両面印刷モードフラグ - 両面(左右に開く)
    
    関連項目:
    
    setDuplex(int), getDuplex(), 定数フィールド値
  - PRESET_DUPLEXSHORT
```
public static final int PRESET_DUPLEXSHORT
```
    両面印刷モードフラグ - 両面(上下に開く)
    
    関連項目:
    
    setDuplex(int), getDuplex(), 定数フィールド値
- コンストラクタの詳細
  - PdfPresetParam
```
public PdfPresetParam()
```
- メソッドの詳細
  - generateCommandLine
```
protected java.lang.String generateCommandLine()
```
    与えられたパラメータからコマンドライン文字列を生成します。
    
    戻り値:
    
    コマンドライン文字列
  - parse
```
protected void parse()
```
    コマンドライン文字列を解析する。
  - setScaling
```
public void setScaling(int scaling)
```
    ページの拡大/縮小をなしにするかどうかを設定をします。
    - PRESET_DEFAULTSCALING - デフォルト
    - PRESET_NOSCALING - なし
    パラメータ:
    
    scaling - ページの拡大/縮小をなしにするかどうか
  - getScaling
```
public int getScaling()
```
    ページの拡大/縮小がなしかどうかを返します。
    - PRESET_DEFAULTSCALING - デフォルト
    - PRESET_NOSCALING - なし
    戻り値:
    
    ページの拡大/縮小がなしかどうか
  - setDuplex
```
public void setDuplex(int duplex)
```
    両面印刷モードの設定を行います。
    - PRESET_SIMPLEX - 片面
    - PRESET_DUPLEXLONG - 両面(左右に開く)
    - PRESET_DUPLEXSHORT - 両面(上下に開く)
    パラメータ:
    
    duplex - 両面印刷モード
  - getDuplex
```
public int getDuplex()
```
    設定されている両面印刷モードを返します。
    - PRESET_SIMPLEX - 片面
    - PRESET_DUPLEXLONG - 両面(左右に開く)
    - PRESET_DUPLEXSHORT - 両面(上下に開く)
    戻り値:
    
    両面印刷モード
  - setTrayBySize
```
public void setTrayBySize(boolean traybysize)
```
    ページサイズに合わせて用紙を選択設定を行います。
    
    パラメータ:
    
    traybysize - ページサイズに合わせて用紙を選択設定をするかどうか
  - isTrayBySize
```
public boolean isTrayBySize()
```
    ページサイズに合わせて用紙を選択設定をしているかどうかを返します。
    
    戻り値:
    
    許可しないかどうか
  - setRangeStart
```
public void setRangeStart(int spage)
```
    印刷範囲の開始ページの設定を行います。
    
    パラメータ:
    
    spage - 印刷範囲の開始ページ
  - getRangeStart
```
public int getRangeStart()
```
    設定されている印刷範囲の開始ページを返します。
    
    戻り値:
    
    印刷範囲の開始ページ
  - setRangeEnd
```
public void setRangeEnd(int epage)
```
    印刷範囲の終了ページの設定を行います。
    
    パラメータ:
    
    epage - 印刷範囲の終了ページ
  - getRangeEnd
```
public int getRangeEnd()
```
    設定されている印刷範囲の終了ページを返します。
    
    戻り値:
    
    印刷範囲の終了ページ
  - setRangeSE
```
public void setRangeSE(int sepage)
```
    印刷ページの設定を行います。
    
    パラメータ:
    
    sepage - 印刷ページ
  - getRangeSE
```
public int getRangeSE()
```
    設定されている印刷ページを返します。
    
    戻り値:
    
    印刷ページ
  - setRange
```
public void setRange(java.lang.String page)
```
    複数のページの印刷範囲を設定します。
    
    パラメータ:
    
    page - 複数の印刷範囲のページ
  - getRange
```
public java.lang.String getRange()
```
    設定されている複数のページの印刷範囲を返します。
    
    戻り値:
    
    複数の印刷範囲のページ
  - setUnitRangeStart
```
public void setUnitRangeStart(int sunit)
```
    印刷範囲の開始ユニットの設定を行います。
    
    パラメータ:
    
    sunit - 印刷範囲の開始ユニット
  - getUnitRangeStart
```
public int getUnitRangeStart()
```
    設定されている印刷範囲の開始ユニットを返します。
    
    戻り値:
    
    印刷範囲の開始ユニット
  - setUnitRangeEnd
```
public void setUnitRangeEnd(int eunit)
```
    印刷範囲の終了ユニットの設定を行います。
    
    パラメータ:
    
    eunit - 印刷範囲の終了ユニット
  - getUnitRangeEnd
```
public int getUnitRangeEnd()
```
    設定されている印刷範囲の終了ユニットを返します。
    
    戻り値:
    
    印刷範囲の終了ユニット
  - setUnitRangeSE
```
public void setUnitRangeSE(int seunit)
```
    印刷ユニットの設定を行います。
    
    パラメータ:
    
    seunit - 印刷ユニット
  - getUnitRangeSE
```
public int getUnitRangeSE()
```
    設定されている印刷ユニットを返します。
    
    戻り値:
    
    印刷ユニット
  - setUnitRange
```
public void setUnitRange(java.lang.String unit)
```
    複数のユニットの印刷範囲を設定します。
    
    パラメータ:
    
    unit - 複数の印刷範囲のユニット
  - getUnitRange
```
public java.lang.String getUnitRange()
```
    設定されている複数のユニットの印刷範囲を返します。
    
    戻り値:
    
    複数の印刷範囲のユニット
  - setNumCopy
```
public void setNumCopy(int copy)
```
    部数の設定を行います。
    1 ：1部
    2 ：2部
    3 ：3部
    4 ：4部
    5 ：5部
    
    パラメータ:
    
    copy - 部数
  - getNumCopy
```
public int getNumCopy()
```
    設定されている部数を返します。
    1 ：1部
    2 ：2部
    3 ：3部
    4 ：4部
    5 ：5部
    
    戻り値:
    
    部数
  - setCommandLine
```
public void setCommandLine(java.lang.String commandline)
```
    コマンドライン文字列を設定します。
```
 (ex.)
 PdfPresetParam preset = new PdfPresetParam();
 preset.setCommandLine("-Ys1 -Yd2 -Yto -Yr2-3,5- -Yc3");
 
```
    パラメータ:
    
    commandline - コマンドライン文字列
  - getCommandLine
```
public java.lang.String getCommandLine()
```
    設定されているコマンドライン文字列を返します。
```
 (ex.)
 "-Ys1 -Yd2 -Yto -Yr2-3,5- -Yc3"
 
```
    戻り値:
    
    コマンドライン文字列
  - init
```
public void init()
```
    すべてのプロパティを初期化します。
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    オーバーライド:
    
    clone クラス内 java.lang.Object
    
    例外:
    
    java.lang.CloneNotSupportedException

クラス PdfPresetParam

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

OPTION_PRESET

OPTION_PRESET_DEFAULTSCALING

OPTION_PRESET_NOSCALING

OPTION_PRESET_SIMPLEX

OPTION_PRESET_DUPLEXLONG

OPTION_PRESET_DUPLEXSHORT

OPTION_PRESET_TRAY_ON

OPTION_PRESET_TRAY_OFF

OPTION_PRESET_RANGE

OPTION_PRESET_RANGE_START

OPTION_PRESET_RANGE_END

OPTION_PRESET_RANGE_SE

OPTION_PRESET_URANGE

OPTION_PRESET_URANGE_START

OPTION_PRESET_URANGE_END

OPTION_PRESET_URANGE_SE

OPTION_PRESET_NUMCOPY

PRESET_DEFAULTSCALING

PRESET_NOSCALING

PRESET_SIMPLEX

PRESET_DUPLEXLONG

PRESET_DUPLEXSHORT

コンストラクタの詳細

PdfPresetParam

メソッドの詳細

generateCommandLine

parse

setScaling

getScaling

setDuplex

getDuplex

setTrayBySize

isTrayBySize

setRangeStart

getRangeStart

setRangeEnd

getRangeEnd

setRangeSE

getRangeSE

setRange

getRange

setUnitRangeStart

getUnitRangeStart

setUnitRangeEnd

getUnitRangeEnd

setUnitRangeSE

getUnitRangeSE

setUnitRange

getUnitRange

setNumCopy

getNumCopy

setCommandLine

getCommandLine

init

clone