9.5.1 OwfFileクラス

表9.1 OwfFileクラスのコンストラクタ
コンストラクタの概要
OwfFile(java.lang.String pathname) OWFファイルのパス名から、OwfFileインスタンスを生成します。
OwfFile(java.lang.String parent, java.lang.String child) OWFファイルのディレクトリ名とファイル名から、OwfFileインスタンスを生成します。
OwfFile(java.io.File parent, java.lang.String child) OWFファイルのディレクトリ名とファイル名から、OwfFileインスタンスを生成します。

表9.2 OwfFileクラスのメソッド
分類	メソッドの概要
OWFファイル生成	void	doPack() OWFファイルを生成します。
ユーザ資源情報	void	setScriptFile(java.lang.String name)(*1) 1つの帳票出力時の帳票名を指定します。
void	setScriptFile(java.lang.String name, int encoding)(*1) 1つの帳票出力時の帳票名を指定します。
void	setAssetsDir(java.lang.String dir) 帳票格納ディレクトリをフルパスで指定します。
void	setDataFile(java.lang.String pathname)(*1) データファイル名をフルパスで指定します。
void	setDataFile(java.lang.String pathname, int encoding)(*1) データファイル名と入力データの文字コード系を指定します。
void	setXmlDataRoot(java.lang.String xmlroot) 入力データ形式が「XML形式」で、XMLルートとデータルートが異なる場合に、XMLデータ中のデータルートの親要素のパスを指定します。
void	setBarCodeData(int barcode) バーコードCODE128、EAN-128の入力データのエンコード方法を指定します。
void	setLcVisualFile(java.lang.String pathname) メディアデータファイル名をフルパスで指定します。
マルチフォーム出力用ユーザ資源情報	void	setGrpOut(int group)(*1) マルチフォーム出力するかどうかを指定します。
void	setLcForm(java.lang.String names) (*1) マルチフォーム出力時の帳票名を指定します。
void	setLcForm(java.lang.String names, int encoding) (*1) マルチフォーム出力時の帳票名を指定します。
void	setGrpDelimitMode(int mode) マルチフォーム用帳票名データ区切り文字種別を指定します。
void	setGrpDelimit(java.lang.String delimit) マルチフォーム用帳票名データ区切り文字を指定します。
void	setGrpBytes(int length) マルチフォーム用帳票名データフィールド長を指定します。
識別情報	void	setOutputName(java.lang.String title) 出力時のタイトルを指定します。
void	setTtlComment(java.lang.String comment) 出力時のコメントを指定します。
動作情報	void	setDestination(int mode) Webプラグイン起動時の動作モードを指定します。
void	setStartPage(int page) 出力を開始するページ番号を指定します。
void	setEndPage(int page) 出力を終了するページ番号を指定します。
void	setReplaceString(java.lang.String replace) SET演算子の「%」置換文字列を指定します。
void	setOutputScale(int scale) 用紙サイズに合わせた拡大/縮小指定を指定します。
void	setStartPosition(int gridunit, float startposx, float startposy) 帳票出力時の原点位置を指定します。
void	setLFCode(int mode) 入力データ形式が「可変長」、「固定長」、または「CSV形式」の入力データ中の改行コード（0x0D0Aまたは0x0A）のみの行の制御方法を指定します。
void	setFFCode(int mode) 入力データ形式が「可変長」、「固定長」、または「CSV形式」の入力データ中の改ページコード（0x0D0Cまたは0x0C）の制御方法を指定します。
void	setOpenPrtDlg(boolean openprtdlg) 印刷時（setDestinationメソッドに「1」を指定した場合）に印刷画面を表示するかどうかを指定します。
void	setPrtClose(boolean closeflag) 印刷完了後、Webブラウザを閉じるかどうかを指定します。
void	setNoData(boolean nodata) 入力データにレコードが存在しない場合に、エラーとなるかどうかを指定します。
void	setOwfEmbedEUDC(int eudcembedtype) OWFファイルに外字をエンベッド（貼り付け）するかどうかを指定します。
void	setOwfRegFont(java.lang.String ttfpath, java.lang.String ttepath) setOwfRegFontCollection(java.lang.String ttcpath, java.lang.String ttepath, int order) 任意のフォルダに格納されている外字フォントファイルを登録します。
プレビュー情報	void	setPreviewRate(java.lang.String rate) プレビュー時のズーム率を指定します。
void	setPrtPreventionEx(int prevention) プレビュー時の印刷制御方法を指定します。
void	setPrtPrevention(boolean prtprevention) プレビューからの2重印刷を抑止するかどうかを指定します。なお、Windows版 ListCREATOR V10.0L30以降およびList Creator V6.0L10以降、またはSolaris版 ListCREATOR 10.2 以降およびList Creator 6.0以降は、プレビューからの2重印刷を抑止するかどうかの指定は、setPrtPreventionExメソッドを使用することを推奨します。
印刷情報	void	setPrinterName(java.lang.String name) 出力先の印刷プリンタ名を指定します。
void	setPrintBin(int printbin) プリンタの給紙方法を指定します。
void	setPrintBinName(java.lang.String name) プリンタの給紙口名を指定します。
void	setItemPrintBin(java.lang.String item) プリンタの給紙方法/給紙口名切り替え指定を指定します。
void	setCopyNumber(int number) 帳票の印刷部数を指定します。
void	setCollate(boolean collate) 部単位で印刷するときに指定します。
void	setPrintSide(int side) 印刷面指定を指定します。
void	setItemPrintSide(java.lang.String item) 印刷面切り替え指定を指定します。
void	setGrpNewPaper(boolean newpaper) マルチフォーム出力時に新しい用紙に印刷する指定を指定します。
void	setPaperCode(java.lang.String form) 印刷する用紙名を指定します。
印刷属性情報	void	setPrtMode(int mode) 出力開始時の動作モードを指定します。
void	setJobHResume(java.lang.String date) 保留状態を解除するまでの期間を指定します。
void	setJobPriority(int priority) 出力時の優先順位を指定します。
void	setInForm(java.lang.String hostname) メッセージの通知先を指定します。
void	setJobBanner(int jobbanner) 区切りページ出力指定を指定します。
void	setJobWait(boolean wait) 出力の完了を待ち合わせるときに指定します。
void	setJobWaitMode(int mode) 出力完了の待ち合わせモードを指定します。
void	setJobPaperCode(java.lang.String form) 用紙交換メッセージの用紙名、および常に用紙交換メッセージを通知するかどうかを指定します。
作業用ディレクトリ情報	void	setWorkDirectory(java.lang.String dir) OWFファイル生成時の作業ディレクトリを指定します。
文字コード変換情報	void	setFileEucType(java.lang.String euctype) OWFファイル生成時のEUCコード種別を指定します。
void	setCodeconvReplace(boolean replace) OWFファイル生成時の代替文字の動作を指定します。

●OWFファイル生成に関するメソッド

public void

doPack()

throws OwfFileException

用途

このメソッドを呼び出す前に指定した情報を元に、OWFファイルを生成します。

帳票名は必ず指定しておいてください。

なお、doPackメソッドでは、OWFファイルの生成時に作業ファイルなどを作成するために作業ディレクトリを使用します。作業ディレクトリについては、“setWorkDirectoryメソッド”の説明を参照してください。

例外

OwfFileException

OWFファイル生成中にエラーが発生した場合

注意

すでに同一名のファイルが存在した場合、例外（OwfFileException[reason:ERR_CANNOT_WRITE]）が発生します。
ただし、存在するファイルのサイズが0バイトの場合、例外は発生せずに上書きされます。

●ユーザ資源情報に関するメソッド

public void

setScriptFile(java.lang.String name)

用途

1つの帳票を出力する場合（setGrpOutメソッドで「0」を指定した場合）に、使用する帳票名を指定します。

1つの帳票を出力する場合（setGrpOutメソッドで「0」を指定した場合）は、このメソッドで帳票名を必ず指定してください。

パラメータ

name：: 1つの帳票を出力するときに使用する帳票名を指定します。

備考

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、帳票名をsetLcFormメソッドで指定するので、このメソッドで指定する必要はありません。

public void

setScriptFile(java.lang.String name, int encoding)

用途

1つの帳票を出力する場合（setGrpOutメソッドで「0」を指定した場合）に、使用する帳票名と帳票の文字コード系を指定します。

1つの帳票を出力する場合（setGrpOutメソッドで「0」を指定した場合）は、このメソッドで帳票名を必ず指定してください。

パラメータ

name：: 1つの帳票を出力するときに使用する帳票名を指定します。

encoding：

1つの帳票を出力するときに使用する帳票の文字コード系を指定します。

1：: Shift-JIS（アプリケーションサーバがWindows/Solarisの場合のみ）

2：: EUC（setFileEucTypeメソッドにしたがいます）

4：: UNICODE（UTF8）

例外

IllegalArgumentException

複数の帳票を指定した場合

備考

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、帳票名をsetLcFormメソッドで指定するので、このメソッドで指定する必要はありません。

public void

setAssetsDir(java.lang.String dir)

用途

帳票格納ディレクトリをフルパスで指定します。

【Windows版】を使用する場合
このメソッドの呼び出しを省略すると、Windows上でOWFファイルを生成する場合は、環境設定画面の［全般］タブで指定されている帳票格納ディレクトリが有効になります（List Creatorデザイナをインストールしている場合は、帳票格納ディレクトリを帳票定義一覧画面のオプション画面からも切り替えることができます）。
【UNIX系OS版】を使用する場合
このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。
1. 環境変数OA_ASSETSDIRで指定した帳票格納ディレクトリ
2. prsetassetsdirコマンドで指定した帳票格納ディレクトリ

パラメータ

dir：: 帳票格納ディレクトリをフルパスで指定します。

例外

IllegalArgumentException

存在しないディレクトリを指定した場合

public void

setDataFile(java.lang.String pathname)

用途

データファイル名をフルパスで指定します。

1つの帳票を出力する場合（setGrpOutメソッドで「0」を指定した場合）に、このメソッドの呼び出しを省略すると、OWFファイル生成時、帳票格納ディレクトリ配下の帳票名と同名のデータファイル（「帳票名.dat」）が指定されたものとして動作します。

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、このメソッドでデータファイル名を必ず指定してください。

パラメータ

pathname：: データファイル名を259バイト以内のフルパスで指定します。

注意

データファイル中のデータは、Windows上でXML形式以外の入力データを使用してOWFファイルを生成する場合は、Shift-JISの文字で記述してください。
UNIX系OS上でOWFファイルを生成する場合は、動作環境の言語（環境変数LANGおよび環境変数OA_EUCTYPEの文字コード）にしたがった文字で記述してください。

public void

setDataFile(java.lang.String pathname, int encoding)

用途

データファイル名と入力データの文字コード系を指定します。

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、このメソッドでデータファイル名を必ず指定してください。

パラメータ

pathname：: データファイル名を259バイト以内のフルパスで指定します。

encoding：

データファイルの文字コード系を指定します。

1：: Shift-JIS（アプリケーションサーバがWindows/Solarisのみ）

2：: UNICODE（UCS2リトルエンディアン）

3：: UNICODE（UCS2ビッグエンディアン）

4：: UNICODE（UTF8）

5：: EUC（UNIX系OS上でOWFファイルを生成する場合のみ使用できます）

注意

データファイルの文字コード系の「5（EUC）」は、UNIX系OS上でOWFファイルを生成する場合のみ指定できます。
Windows上でOWFファイルを生成する場合に「5（EUC）」を指定しても、「1（Shift-JIS）」が指定されたものとして動作します。
データファイルの文字コード系の「5（EUC）」は、UNIX系OS上でOWFファイルを生成する場合、setFileEucTypeメソッドで指定するエンコーディング種別にしたがいます。
データファイル中のデータは、指定した入力データの文字コード系で指定してください。
入力データ形式が「XML形式」の場合は、必ずencodingに「1（Shift-JIS）」を指定してください。入力データ形式が「XML形式」の場合は、XMLファイル中のXML宣言で文字コード系を指定します。XMLファイル中のXML宣言を省略した場合、またはXML宣言で文字コード系の指定を省略した場合は、UNICODE（UTF8）とみなします。
UNIX系OS上で出力できる文字については、以下を参照してください。
- オンラインマニュアル“環境設定・帳票運用編”の出力できる文字について（Webアプリケーション連携時）の記載

public void

setXmlDataRoot(java.lang.String xmlroot)

用途

入力データ形式が「XML形式」で、XMLルートとデータルートが異なる場合に、XMLデータ中のデータルートの親要素のパスを指定します。

データルートの親要素のパスは、「スラッシュ（/）」を始点にデータルートの親要素までの要素名を「スラッシュ（/）」で区切って指定します。それ以外の指定はできません。

XMLデータ中のこのメソッドで指定したパス直下にデータルートが複数存在する場合は、すべてのデータルートを検索します。

このメソッドの呼び出しを省略すると、以下の優先順序で帳票のデータルートを検索します。

XMLルートとデータルートが同じ名前の場合、XMLルートをデータルートとみなします。
XMLルートとデータルートが異なる場合、XMLルート直下の子要素の中からデータルートを検索します。

パラメータ

xmlroot：: XMLデータ中のデータルートの親要素のパスを指定します。

public void

setBarCodeData(int barcode)

用途: バーコードCODE128、EAN-128の入力データのエンコード方法を指定します。

パラメータ

barcode：

バーコードCODE128、EAN-128の入力データのエンコード方法を指定します。

0（省略値）：: CODE128、EAN-128の入力データにエンコードしないデータを指定します。

1：: CODE128、EAN-128の入力データにBASE64エンコードしたデータを指定します。

注意

このメソッドを指定する場合は、帳票設計時に対象となるバーコード項目（CODE128、EAN-128）に、以下の指定をしてください。
- 対象となるバーコード項目のプロパティの［プロパティ］タブの項目長
  BASE64エンコードする前のバーコードデータの長さに+2した長さ
- データ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのデータ項目のバイト数（入力データ形式が「固定長」の場合）
  BASE64エンコードした後のバイト数
以下の場合、このメソッドに「1」を指定しないでください。
- データ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブの該当するデータ項目にオペランドを指定した場合
- データ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのオペランドに該当するデータ項目名を指定した場合
- データ定義画面の［拡張定義］タブに該当するデータ項目名を指定した場合

public void

setLcVisualFile(java.lang.String pathname)

用途

メディアデータファイル名をフルパスで指定します。

複数のファイルを使用する場合は、以下のように「セミコロン（;）」で区切って指定します。

ファイル名1;ファイル名2;ファイル名3

パラメータ

pathname：: メディアデータファイル名をフルパスで指定します。

注意

組込みメディア項目に対するデータファイル中のメディアデータファイル名は、ファイル名のみを指定してください。

●マルチフォーム出力用ユーザ資源情報に関するメソッド

public void

setGrpOut(int group)

用途

マルチフォーム出力するかどうかを指定します。

マルチフォーム出力する場合は、使用する帳票名をsetLcFormメソッドで、データから帳票名を取り出すための区切り文字の種別をsetGrpDelimitModeメソッドで指定してください。また、必要に応じて、実際に使用する区切り文字をsetGrpDelimitメソッドで、データファイル中の帳票名データのフィールド長をsetGrpBytesメソッドで指定してください。

パラメータ

group：

マルチフォーム出力するかどうかを指定します。

0（省略値）：: マルチフォーム出力しません（1つの帳票を出力します）。

1：: マルチフォーム出力します。

public void

setLcForm(java.lang.String names)

用途

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）に、使用する帳票名を指定します。

帳票名は、「セミコロン（;）」で区切って複数指定します。

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、このメソッドで帳票名を必ず指定してください。

パラメータ

names：: マルチフォーム出力する場合に、使用する帳票名を指定します。

備考

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、帳票名をデータファイルで指定します。

public void

setLcForm(java.lang.String names, int encoding)

用途

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）に、使用する帳票名と帳票コード系を指定します。

帳票名は、「セミコロン（;）」で区切って複数指定します。

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、このメソッドで帳票名を必ず指定してください。

パラメータ

names：: マルチフォーム出力する場合に、使用する帳票名を指定します。

encoding：

マルチフォーム出力する場合に、使用する帳票コード系を指定します。

1：: Shift-JIS（アプリケーションサーバがWindows/Solarisの場合のみ）

2：: EUC（setFileEucTypeメソッドにしたがいます）

4：: UNICODE（UTF8）

備考

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、帳票名をデータファイルで指定します。

public void

setGrpDelimitMode(int mode)

用途

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）に、入力データから帳票名を取り出すための区切り文字の種別を指定します。区切り文字の種別は、データ定義画面の［環境定義］タブで指定した入力データ形式と区切り文字にしたがって指定します。

任意の区切り文字を使用する場合（このメソッドで「0」を指定した場合）は、実際に使用する区切り文字をsetGrpDelimitメソッドで指定してください。setGrpDelimitメソッドで帳票名データ区切り文字を指定しない場合、「バーティカルバー（|）」が指定されたものとして動作します。

入力データ形式が「固定長」の場合（このメソッドで「3」または「4」を指定した場合）は、帳票名データのフィールド長をsetGrpBytesメソッドで必ず指定してください。

パラメータ

mode：

マルチフォーム用帳票名データ区切り文字種別を指定します。

0：: 以下の場合に指定します。
‐入力データ形式が「可変長」、区切り文字が「バーティカルバー（|）」「シャープ（#）」「アスタリスク（*）」「任意」のいずれか
の場合
‐入力データ形式が「CSV形式」、区切り文字が「カンマ（,）」の場合

1：: 入力データ形式が「可変長」、区切り文字が「1個以上の空白」の場合に指定します。

2：: 以下の場合に指定します。
‐入力データが「可変長」、区切り文字が「タブ」の場合
‐入力データが「CSV形式」、区切り文字が「タブ」の場合

3：: 入力データ形式が「固定長」、区切り文字が「区切り文字なし」の場合に指定します。

4：: 入力データ形式が「固定長」、区切り文字が「区切り文字あり」の場合に指定します。

5：: 入力データ形式が「XML形式」の場合に指定します。

注意

データファイルの文字コード系がUNICODE（UCS2/UTF8）で、入力データ形式が「固定長」で、区切り文字に「区切り文字あり」を指定した場合、データファイル中の区切り文字には、文字コードが0x007F/0x7F以下の文字を指定してください。

public void

setGrpDelimit(java.lang.String delimit)

用途

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）で、任意の区切り文字を使用する場合（setGrpDelimitModeメソッドで「0」を指定した場合）に、実際に使用する区切り文字を指定します。区切り文字は、データ定義画面の［環境設定］タブで指定した入力データ形式と区切り文字にしたがって指定します。

このメソッドの呼び出しを省略すると、「バーティカルバー（|）」が指定されたものとして動作します。

パラメータ

delimit：: マルチフォーム用帳票名データ区切り文字を1バイトの文字列で指定します。

例外

IllegalArgumentException

2文字以上の文字列を指定した場合

注意

データファイルの文字コード系がUNICODE（UCS2/UTF8）の場合、文字コードが0x007F/0x7F以下の文字を指定してください。

public void

setGrpBytes(int length)

用途

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）に、データファイル中の帳票名データのフィールド長を指定します。

入力データ形式が「固定長」の場合（setGrpDelimitModeメソッドで「3」または「4」を指定した場合）は、必ずこのメソッドで帳票名データフィールド長を指定してください。「区切り文字あり」の場合は、区切り文字を含まない長さをしてください。

パラメータ

length：: マルチフォーム用帳票名データフィールド長を指定します。

●識別情報に関するメソッド

public void

setOutputName(java.lang.String title)

用途

タイトルを指定します。

このメソッドの呼び出しを省略すると、帳票名がタイトルになります。

パラメータ

title：

タイトルを64 バイト以内で指定します。

以下の文字は指定しないでください。指定した場合、該当する文字が「ハイフン（-）」に置換されます。

「/」、「,」、「:」、「;」、「*」、「?」、「"」、「<」、「>」、「|」、「\」

public void

setTtlComment(java.lang.String comment)

用途

帳票に関するコメントを指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

帳票業務情報のプロパティ画面の［全般］タブで指定したコメント
指定されない

パラメータ

comment：

帳票に関するコメントを64バイト以内で指定します。

以下の文字は指定しないでください。

「;」、「"」

●動作情報に関するメソッド

public void

setDestination(int mode)

用途: Webプラグイン起動時の動作モードを指定します。

パラメータ

mode：

Webプラグインの動作モードを指定します。

0（省略値）：: プレビューします。

1：: 印刷します。

public void

setStartPage(int page)

用途

出力を開始するページ番号を指定します。

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、全帳票を通してのページ番号を指定します。

このメソッドの呼び出しを省略すると、1 ページ目から出力を開始します。

パラメータ

page：: 出力を開始するページ番号を指定します。

public void

setEndPage(int page)

用途

出力を終了するページ番号を指定します。

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、全帳票を通してのページ番号を指定します。

このメソッドの呼び出しを省略すると、最終ページまで出力します。

パラメータ

page：: 出力を終了するページ番号を指定します。

public void

setReplaceString(java.lang.String replace)

用途

データ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのデータ項目のオペランドでSET演算子に変数「%」を指定した場合に、「%」の置換文字列を指定します。［データ定義（レポート頭書き）］タブのデータ項目用の置換文字列に続けて［データ定義］タブのデータ項目用の置換文字列を指定します。置換文字列の指定形式については、オンラインマニュアル“環境設定・帳票運用編”のSET演算子/SELECT文の置換文字列の指定形式についての記載を参照してください。

SET演算子に変数「%」を指定した場合は、このメソッドで必ず置換文字列を指定してください。

パラメータ

replace：: SET演算子の置換文字列を指定します。

備考

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）は、使用するすべての帳票に対してこのメソッドで指定した同じ置換文字列が有効になります。

例

以下に指定例を示します。この例では、データ定義画面の［データ定義］タブで「会社コード」と「会社名」に「SET(%)」を指定し、帳票の出力時に「会社コード」の「%」を数字定数「123」に、「会社名」の「%」を文字定数「○×商会」に置換しています。

データ定義画面の［データ定義］タブでの指定

データ項目名	オペランド
会社コード会社名郵便番号住所名前	SET(%)←数字定数「123」に置換したい SET(%)←文字定数「○×商会」に置換したい

データ項目名

オペランド

会社コード
会社名
郵便番号
住所
名前

SET(%)←数字定数「123」に置換したい

SET(%)←文字定数「○×商会」に置換したい

⇒帳票の出力時に、「"123;"○×商会""」と指定します。

public void

setOutputScale(int scale)

用途: 指定した用紙サイズに合わせて帳票を拡大または縮小して出力したい場合に、出力したい用紙サイズを指定します。指定された用紙サイズが定義された用紙サイズよりも大きい場合は、指定された用紙サイズに拡大されます。指定された用紙サイズが定義された用紙サイズよりも小さい場合は、指定された用紙サイズに縮小されます。なお、拡大または縮小を行った場合、横幅と縦幅の比率は保たれます。

パラメータ

scale：

用紙サイズに合わせて拡大/縮小する場合に、用紙サイズを指定します。

0（省略値）：: 帳票様式定義画面のプロパティ画面の［拡大/縮小印刷］タブの拡大/縮小指定にしたがいます。

1：: A3用紙

2：: A4用紙

3：: A5用紙

4：: A6用紙

5：: B4用紙

6：: B5用紙

7：: はがき

8：: Letter

9：: Legal

10：: 任意

注意

「任意（10）」は、Windowsの場合のみ有効になります。
このメソッドで「任意（10）」以外を指定してsetPaperCodeメソッドを指定した場合はエラーになります。また、このメソッドで「任意（10）」を指定して、setPaperCodeメソッドを指定しない場合もエラーになります。
以下の場合、用紙サイズのみ有効になり、拡大/縮小は有効になりません。
- 拡大/縮小がサポートされていないプリンタを使用した場合

public void

setStartPosition(int gridunit, float startposx, float startposy)

用途: 帳票出力時の原点位置を指定します。

パラメータ

gridunit：

帳票出力時の原点位置指定時の単位を指定します。

0（省略値）：: 帳票様式定義のプロパティ画面の余白タブで設定した原点位置指定の設定にしたがいます。

1：: インチ単位で指定します。

2：: ミリ単位で指定します。

startposx：

印刷開始時の横方向の位置を、インチ単位またはミリ単位で指定します。

0.00～22.50：: インチ単位指定の場合（gridunitパラメータに「1」を指定した場合）は、0.00～22.50の範囲で指定します。

0.0～571.5：: ミリ単位指定の場合（gridunitパラメータに「2」を指定した場合）は、0.0～571.5の範囲で指定します。

startposy：

印刷開始時の縦方向の位置を、インチ単位またはミリ単位で指定します。

0.00～22.50：: インチ単位指定の場合（gridunitパラメータに「1」を指定した場合）は、0.00～22.50の範囲で指定します。

0.0～571.5：: ミリ単位指定の場合（gridunitパラメータに「2」を指定した場合）は、0.0～571.5の範囲で指定します。

public void

setLFCode(int mode)

用途: 入力データ形式が「可変長」、「固定長」、または「CSV形式」の入力データ中の改行コード（0x0D0Aまたは0x0A）のみの行の制御方法を指定します。

パラメータ

mode：

入力データ形式が「可変長」、「固定長」、または「CSV形式」の入力データ中の改行コード（0x0D0Aまたは0x0A）のみの行の制御方法を指定します。

0（省略値）：: 改行コードのみの行は読み飛ばします。改行コードがなかったものとして動作します。

1：: 改行コードのみの行は改行処理だけを行います。空の1行が出力されます。

注意

このメソッドは、入力データ形式が「可変長」、「固定長」、「CSV形式」の場合に有効です。「XML形式」の場合はエラーとなります。
このメソッドは、以下の帳票形式を使用する際に指定します。
- フリーフレーム形式
- 集計表形式
- 伝票形式
- 矩形繰返し形式
- タックシール形式
カード形式の場合、このメソッドで「1」（改行コードのみの行は改行処理だけを行う指定）を指定をしないでください。指定した場合、入力データが出力されない空ページが出力されることになります。
このメソッドで「1」（改行コードのみの行は改行処理だけを行う指定）を指定した場合、データ定義画面の［データ定義］タブのデータ項目のオペランドにBREAKを指定すると、意図しない動作（データのある行と改行コードのみの行でBREAKが発生したことになる）となります。

public void

setFFCode(int mode)

用途: 入力データ形式が「可変長」、「固定長」、または「CSV形式」の入力データ中の改ページコード（0x0D0Cまたは0x0C）の制御方法を指定します。

パラメータ

mode：

入力データ形式が「可変長」、「固定長」、または「CSV形式」の入力データ中の改ページコード（0x0D0Cまたは0x0C）の制御方法を指定します。

0（省略値）：: 改ページ処理および改ページコードの読み飛ばしを行いません。改ページコードを意識せずに入力データの読み込みを行うため、改ページコードが含まれる場合は不当な文字列として出力される場合があります。

1：: 改ページ処理を行います。

2：

改ページ処理を行わず、改ページコードは読み飛ばします。

改ページコードがなかったものとして動作します。

注意

このメソッドは入力データ形式が「可変長」、「固定長」、「CSV形式」の場合に有効です。「XML形式」の場合はエラーとなります。
このメソッドは以下の帳票形式を使用する際に指定します。
- フリーフレーム形式
- 集計表形式
- 伝票形式
- 矩形繰返し形式
- タックシール形式
カード形式の場合、このメソッドで「1」（改ページ処理を行う指定）を指定しないでください。指定した場合、入力データが出力されない空ページが出力されることになります。カード形式で改ページコードを含んだ入力データを使用する場合は、「2」を指定してください。
List Creatorは改行コード（0x0A）までを1レコードとして判断していますが、改ページコード（0x0C）のみ現れた場合も1レコードの終端＋改ページと判断して処理を行います。

備考

改ページコード（0x0D0Cまたは0x0C）の前には、改行コード（0x0D0Aまたは0x0A）は、あってもなくても構いません。

public void

setOpenPrtDlg(boolean openprtdlg)

用途: 印刷時（setDestinationメソッドに「1」を指定した場合）に印刷画面を表示するかどうかを指定します。印刷画面を表示する場合は、印刷出力時の情報を指定することができます。

パラメータ

openprtdlg：

印刷時（setDestinationメソッドに「1」を指定した場合）に印刷画面を表示するかどうかを指定します。

false（省略値）：: 印刷時（setDestinationメソッドに「1」を指定した場合）に印刷画面を表示しません。

true：: 印刷時（setDestinationメソッドに「1」を指定した場合）に印刷画面を表示します。

public void

setPrtClose(boolean closeflag)

用途: 印刷完了後、Webブラウザを閉じるかどうかを指定します。

パラメータ

closeflag：

印刷完了後、Webブラウザを閉じるかどうかを指定します。

false（省略値）：: 印刷完了後に、Webブラウザを閉じません。

true：: 印刷完了後に、Webブラウザを閉じます。

注意

このメソッドは、setDestinationメソッドに「1」を指定して印刷した場合のみ有効となります。
HTMLのフレーム機能使用時には設定しないでください。

public void

setNoData(boolean nodata)

用途: 入力データにレコードが存在しない場合に、エラーとなるかどうかを指定します。

パラメータ

nodata：

入力データにレコードが存在しない場合に、エラーとなるかどうかを指定します。

false（省略値）：: エラーとします。

true：

エラーとせず出力します。

入力データにレコードが存在しない場合もエラーになりません。その場合、レコードが存在しない項目は、以下のように出力されます。

‐テキスト項目
出力されません（空白となります）。

‐数字項目
0が出力されます。

‐OCR-B項目
出力されません（空白となります）。

‐ラジオボタン項目
選択されません。

‐チェックボックス項目
選択されません。

‐バーコード項目
出力されません（空白となります）。

‐組込みメディア項目
出力されません（空白となります）。

‐郵便番号項目
出力されません（空白となります）。

‐矩形テキスト項目
出力されません（空白となります）。

注意

以下の場合、このメソッドは指定しないでください。
- 入力データ形式が「XML形式」の場合

備考

入力データにレコードが存在する場合は、通常の帳票出力時の印刷動作となります。ただし、該当するデータが存在しない項目については、このメソッドの出力と同じ印刷動作となります。
マルチフォーム出力時、入力データファイルにレコードが存在しない状態とは、以下の条件をすべて満たす状態を指します。
- 帳票名およびマルチフォーム用帳票名データ区切り文字が記述されている
- レコードには帳票名に続くデータが存在しない
- 同一の帳票名に対してレコードが連続していない
  レコードが連続している場合は、入力データにレコードが存在すると判断するため、このメソッドの動作指定は1レコード目にのみ有効となりますが、以降のレコードは通常の帳票出力時の印刷動作となります。

public void

setOwfEmbedEUDC(int eudcembedtype)

用途: OWFファイルに外字をエンベッド（貼り付け）するかどうかを指定します。

パラメータ

eudcembedtype：

OWFファイルに外字をエンベッド（貼り付け）するかどうかを指定します。

0（省略値）：: 外字をエンベッドしません。

1：: 外字をエンベッドします。

備考

エンベッドする外字は、以下の方法で登録する必要があります（登録されていない外字はエンベッドされません）。
環境設定によるフォントの登録
setOwfRegFontメソッド、またはsetOwfRegFontCollectionメソッドによるフォントの登録
フォントの登録については、オンラインマニュアル“環境設定・帳票運用編”の外字エンベッド機能についての記載を参照してください。

public void

setOwfRegFont(java.lang.String ttfpath, java.lang.String ttepath)

setOwfRegFontCollection(java.lang.String ttcpath, java.lang.String ttepath, int order)

用途

任意のフォルダに格納されている外字フォントファイルを登録します。

複数ファイルの登録を行う場合は、「セミコロン（;）」で区切って指定します。ただし、同じフォントファイルに対して複数回指定した場合は、最後に指定した外字フォントファイルが有効になります。

このメソッドによる外字フォントファイルの登録は、以下のような場合に使用します。

環境設定で登録されていないフォントの外字をエンベッドしたい場合
環境設定で登録されているフォントの外字を、一時的に異なる外字に変更し、変更した外字をエンベッドしたい場合

このメソッドの呼び出しを省略する、またはこのメソッドで登録されなかったフォントについては、環境設定で登録したフォントが有効になります。

フォントの登録については、オンラインマニュアル“環境設定・帳票運用編”の外字エンベッド機能についての記載を参照してください。

パラメータ

ttfpath/ttcpath：: フォントファイル（TTFファイルまたはTTCファイル）へのフルパスを指定します。

ttepath：: リンクする外字フォントファイル（TTEファイル）へのフルパスを指定します。

order：

TTCファイルを指定するときは、TTCファイル内の何番目の書体を登録するかを指定します。

先頭の書体を登録する場合は、「1」を指定します。

例外

IllegalArgumentException

orderに「0」を指定した場合

注意

環境設定で登録されているフォントに対して、このメソッドで外字フォントファイルを登録した場合、このメソッドで指定した外字フォントファイルが有効になります。
setOwfRegFontメソッドを指定する場合、ttfpathパラメータにTTCファイルを指定することはできません。指定した場合、例外（OwfFileException[reason:ERR_INVALID_PARAMETER]）が発生します。
setOwfRegFontCollectionメソッドを指定する場合、ttcpathパラメータにTTFファイルを指定することはできません。
外字フォントファイル名が同一で格納先が異なる指定は行わないでください。
ファイルパスに「カンマ（,）」、「セミコロン（;）」は指定できません。

●プレビュー情報に関するメソッド

public void

setPreviewRate(java.lang.String rate)

用途: プレビュー時のズーム率を指定します。

パラメータ

rate：

プレビュー時のズーム率を指定します。

0（ゼロ）（省略値）：: ページ全体を表示する場合に指定します。

W：: ページの横幅に合わせて表示する場合に指定します。

30～200：: 30～200（%）の範囲で文字列で指定します。

public void

setPrtPreventionEx(int prevention)

用途

プレビュー時の印刷制御方法を指定します。

このメソッドに「0」を指定するか、またはこのメソッドの呼び出しを省略すると、setPrtPreventionメソッドの指定が有効になります。

パラメータ

prevention：

プレビュー時の印刷制御方法を指定します。

0（省略値）：: 印刷を抑止しません。

1：: 2重印刷を抑止します。

2：: 印刷を抑止します。

public void

setPrtPrevention(boolean prtprevention)

用途

プレビューからの2重印刷を抑止するかどうかを指定します。なお、Windows版 ListCREATOR V10.0L30以降およびList Creator V6.0L10以降、またはSolaris版 ListCREATOR 10.2 以降およびList Creator 6.0以降は、プレビューからの2重印刷を抑止するかどうかの指定は、setPrtPreventionExメソッドを使用することを推奨します。

setPrtPreventionExメソッドに「1」または「2」が指定されている場合、このメソッドを指定しても無効となります。

パラメータ

prtprevention：

プレビューからの2重印刷を抑止するかどうかを指定します。

false（省略値）：: 2重印刷を抑止しません。

true：: 2重印刷を抑止します。

●印刷情報に関するメソッド

public void

setPrinterName(java.lang.String name)

用途

帳票を出力するときに使用する印刷プリンタ名を指定します。

指定できる印刷プリンタには、以下のものがあります。

ローカルプリンタ
Print Managerの高信頼プリンタ

また、ローカル出力およびOWFファイル生成時は、以下のリモートプリンタも指定できます（リモート帳票出力時、およびコネクタ連携時は指定できません）。

リモートプリンタ
Print Managerの高信頼リモートプリンタ

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

帳票業務情報のプロパティ画面の［印刷］タブで指定した印刷プリンタ名
プリンタフォルダで「通常使うプリンタ」に指定されているプリンタ名

パラメータ

name：: 出力先の印刷プリンタ名を指定します。

注意

印刷用プリンタ以外のプリンタを指定した場合、または通常使うプリンタが印刷用プリンタになっていない場合、帳票の出力は正しく行われません。

備考

印刷プリンタ名は、プリンタフォルダで表示されるプリンタ名を指定します。ただし、Windowsで帳票を出力する場合で、リモートプリンタを使用する場合は、「\\サーバ名\プリンタ名」の形式で指定します。

public void

setPrintBin(int printbin)

用途

用紙種別が単票の場合に、印刷プリンタの給紙方法を指定します。

給紙方法は、以下の優先順序で有効になります。

setItemPrintBinメソッドの指定にしたがった給紙方法/給紙口名
setPrintBinNameメソッドで指定した給紙口名
このメソッドで指定した給紙方法
帳票業務情報のプロパティ画面の［印刷］タブで指定した給紙方法/給紙口名

パラメータ

printbin：

印刷プリンタの給紙方法を指定します。

0：: 帳票定義一覧のプロパティ画面の［印刷］タブの給紙方法の指定にしたがいます。

1：: カットシートフィーダ

2：: ホッパ1

3：: ホッパ2

4：: ホッパ3

5：: ホッパ4

6：: 手差し

7：: 指定なし（プリンタドライバのプロパティの指定にしたがいます）

8：: 自動

注意

指定した方法で給紙されない場合は、給紙口名をsetPrintBinNameメソッドで指定してください
給紙方法に「7（指定なし）」を指定した場合、給紙口名をsetPrintBinNameメソッドで指定しても無効になります。給紙口名を指定する場合は、「7（指定なし）」以外を指定してください。
給紙方法に「8（自動）」を指定しても自動給紙が正しく動作しない場合は、プリンタドライバのプロパティで自動給紙を指定し、給紙方法に「7（指定なし）」を指定してください。
このメソッドで給紙方法を切り替えた場合、帳票業務情報のプロパティ画面の［印刷］タブで指定した給紙口名は無効になります。必要に応じて、給紙口名をsetPrintBinNameメソッドで指定してください。
その他の給紙方法を指定する場合は、給紙口名をsetPrintBinNameメソッドで指定してください。

public void

setPrintBinName(java.lang.String name)

用途

以下の場合に、印刷プリンタの給紙口名を256バイト以内で指定します。指定できる給紙口名は、プリンタドライバのプロパティで確認してください。

用紙種別が単票で、給紙方法で指定した給紙口に切り替わらない場合
用紙種別が連帳で、給紙口が正常に切り替わらない場合

給紙口名は、以下の優先順序で有効になります。

setItemPrintBinメソッドの指定にしたがった給紙方法/給紙口名
このメソッドで指定した給紙口名
setPrintBinメソッドで指定した給紙方法
帳票業務情報のプロパティ画面の［印刷］タブで指定した給紙方法/給紙口名

パラメータ

name：: 印刷プリンタの給紙口名を256バイト以内で指定します。

注意

給紙口名は、プリンタドライバによって異なります。プリンタドライバのプロパティで確認し、文字および空白の全角・半角の違い、空白の有無などに注意して、正確に指定してください。
給紙口名の前後に半角空白は指定しないでください。指定した場合、前後の半角空白を削除した給紙口名で動作します。そのため、正しい給紙口から出力されない場合があります。

public void

setItemPrintBin(java.lang.String item)

用途

用紙種別が単票で、マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）、帳票を切り替えたときに給紙方法/給紙口名も切り替える（各帳票で指定した給紙方法/給紙口名を有効にする）かどうかを指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

setPrintBinNameメソッドで指定した給紙口名
setPrintBinメソッドで指定した給紙方法
帳票業務情報のプロパティ画面の［印刷］タブで指定した給紙方法/給紙口名

パラメータ

item：: 帳票を切り替えたときに給紙方法/給紙口名も切り替える（各帳票で指定した給紙方法/給紙口名を有効にする）場合に、「!REPORT」を指定します。

注意

指定した給紙方法で給紙されない場合は、給紙口名を帳票業務情報のプロパティ画面の［印刷］タブで指定し、このメソッドを指定してください。
List Creatorの段組み印刷が指定されている場合、給紙口名の切り替え指定は無効になります。
指定しても、一番目に出力する帳票に定義されている給紙口名の指定にしたがって印刷されます。
プリンタの段組み印刷機能を使用する場合、このメソッドを指定しないでください。指定した場合、正しく動作しません。
プリンタによっては、帳票ごとに給紙方法/給紙口名を切り替えられないものもあります。必ず、実際に使用するプリンタで動作確認してください。

public void

setCopyNumber(int number)

用途

帳票の印刷部数を指定します。

部単位で印刷する場合は、setCollateメソッドで「true」を指定してください。

パラメータ

number：: 印刷部数を1 ～999の範囲で指定します。

注意

部単位で印刷する指定をせずに、プリンタドライバのプロパティで印刷部数が指定できないプリンタに出力した場合、印刷部数の指定は有効になりません（1部だけ印刷されます）。

public void

setCollate(boolean collate)

用途

このメソッドは、Windowsで帳票を出力する場合で、印刷プリンタ名にPrint Managerで定義したプリンタを指定し、setCopyNumberメソッドで印刷部数（1～999）を指定した場合にのみ有効となります。

部単位で印刷するかどうかを指定します。

パラメータ

collate：

部単位で印刷するかどうかを指定します。

false（省略値）：: 部単位で印刷しません。

true：: 部単位で印刷します。

注意

以下の場合、部単位での印刷は有効になりません（1部だけ印刷されます）。
- Print Managerの高信頼プリンタ・高信頼リモートプリンタではないプリンタに出力した場合

public void

setPrintSide(int side)

用途

両面印刷するかどうかを指定します。

印刷面指定は、以下の優先順序で有効になります。

setItemPrintSideメソッドの指定にしたがった両面印刷と、マルチフォーム出力時に帳票を切り替えたときに新しい用紙に印刷する指定
このメソッドとsetGrpNewPaperメソッドで指定した印刷面指定
帳票業務情報のプロパティ画面の［印刷］タブで指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）で、帳票を切り替えたときに印刷面も切り替える（各帳票で指定した印刷面指定を有効にする）場合は、
setItemPrintSideメソッドで「!REPORT」を指定してください。

パラメータ

side：

両面印刷するかどうかを指定します。

0：: 帳票業務情報のプロパティ画面の［印刷］タブで指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定にしたがいます。

1：: 片面印刷します。

2：: 両面印刷します。

注意

使用する印刷プリンタに両面印刷機能がない、または両面印刷機能が無効になっている場合、両面印刷の指定は有効になりません（片面で印刷されたり、白紙が出力されたりする場合があります）。

public void

setItemPrintSide(java.lang.String item)

用途

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）に、帳票を切り替えたときに印刷面も切り替える（各帳票で指定した印刷面指定を有効にする）かどうかを指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

setPrintSideメソッドとsetGrpNewPaperメソッドで指定した印刷面指定
帳票業務情報のプロパティ画面の［印刷］タブで指定した両面印刷と、マルチフォーム出力時の動作の帳票を切り替えたときに新しい用紙に印刷する指定

パラメータ

item：: 帳票を切り替えたときに印刷面も切り替える（各帳票で指定した印刷面指定を有効にする）場合に、「!REPORT」を指定します。

注意

使用する印刷プリンタに両面印刷機能がない、または両面印刷機能が無効になっている場合、両面印刷の指定は無効となります（片面で印刷されたり、白紙が出力されたりする場合があります）。
段組み印刷が指定されている場合は、両面印刷の指定は切り替えられません。指定を行っても、一番目に出力する帳票に定義されている両面印刷の指定にしたがって印刷されます。
プリンタの段組み印刷機能を使用する場合、このメソッドを指定しないでください。指定した場合、正しく動作しません。
プリンタによっては、帳票ごとに印刷面を切り替えられないものもあります。必ず、実際に使用するプリンタで動作確認してください。

public void

setGrpNewPaper(boolean newpaper)

用途

このメソッドは、setPrintSideメソッドで「0」以外を指定した場合にのみ有効です。

マルチフォーム出力する場合（setGrpOutメソッドで「1」を指定した場合）に、帳票を切り替えたときに同じ用紙に続けて印刷するか、新しい用紙に印刷するかを指定します。

パラメータ

newpaper：

帳票を切り替えたときに新しい用紙に印刷するかどうかを指定します。

false（省略値）：: 帳票を切り替えたときに同じ用紙に続けて印刷します。

true：: 帳票を切り替えたときに新しい用紙に印刷します。

注意

以下の場合、このメソッドに「true」を指定しないでください。指定した場合、正しく動作しません。
- プリンタの段組み印刷機能を使用する場合（List Creatorの段組みを使用した場合は、正しく動作します）
- プリンタの白紙の出力を抑止する機能を使用する場合

備考

データ定義画面の［データ定義（レポート頭書き）］タブ、［データ定義］タブのデータ項目にPAGE、TPAGE、PAGE-ALL、TPAGE-ALL、BPAGE、またはBTPAGEのいずれかを指定した項目が存在する帳票で、このメソッドで「true」を指定した場合、印刷せずにページ送りされた分はカウントされません。

public void

setPaperCode(java.lang.String form)

用途

印刷する用紙名を指定します。

このメソッドの呼び出しを省略すると、以下の優先順序で有効になります。

setOutputScaleメソッドで指定した用紙サイズ
帳票様式定義画面のプロパティ画面の［帳票定義体］タブで指定した用紙サイズ、または用紙名

パラメータ

form：

印刷する用紙名を64バイト以内で指定します。
64バイトを超える用紙名を指定した場合はエラーとなります。

false（省略値）：: 帳票を切り替えたときに同じ用紙に続けて印刷します。

true：: 帳票を切り替えたときに新しい用紙に印刷します。

注意

このメソッドは、帳票出力サーバがWindowsの場合のみ有効になります。
このメソッドと同時にsetOutputScaleメソッドを指定する場合、setOutputScaleメソッドで「任意（10）」以外を指定した場合はエラーとなります。
プリンタで使用できない用紙名を指定した場合は、A4の用紙サイズで印刷されます。
プリンタで利用できない用紙名を指定し、setOutputScaleメソッドで「任意（10）」を指定してプレビューした場合は白紙ページが表示されます。同様の指定で印刷した場合は白紙ページが印刷されます。

備考

指定した用紙に合わせて拡大/縮小を行う場合は、setOutputScaleメソッドに「任意（10）」を指定してください。

●印刷属性情報に関するメソッド

public void

setPrtMode(int mode)

用途

このメソッドは、Windowsで帳票を出力する場合で、印刷プリンタ名にPrint Managerで定義したプリンタを指定した場合にのみ有効です。

出力開始時の動作モードを指定します。

パラメータ

mode：

出力開始時の動作モードを指定します。

0（省略値）：: 帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面の出力開始時の動作モードの指定にしたがいます。

1：: すぐに帳票を出力します。

2：: すぐに帳票を出力しないで、いったんクライアント側のスプールに保留します。クライアント側とは、Webプラグインが動作するコンピュータを指します。

3：: すぐに帳票を出力しないで、いったんサーバ側のスプールに保留します。サーバ側とは、Print Managerの印刷サーバが動作するコンピュータを指します。

注意

サーバ側で保留する場合は、自動で保留解除できないため、手動で保留解除する必要があります。
Print Managerの印刷サーバとWebプラグインが同一コンピュータ上で動作する環境で運用しているときに帳票の出力を保留する場合は、以下のいずれかで出力開始モードをクライアント側で保留する指定にしておく必要があります。
- 帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面の出力開始時の動作モード
- setPrtModeメソッド（「2」を指定する）

public void

setJobHResume(java.lang.String date)

用途

このメソッドは、Windowsで帳票を出力する場合で、印刷プリンタ名にPrint Managerで定義したプリンタを指定した場合にのみ有効です。

スプールしたドキュメントの保留状態をいつ解除するかを指定します。

このメソッドの呼び出しを省略すると、以下の優先順位で有効になります。

帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面で指定した保留解除日時
自動保留解除しない

パラメータ

date：

保留解除日時をHHmmDDDの形式の文字列で指定します。

HH：: 00～23（時）の範囲で指定します。

mm：: 00～59（分）の範囲で指定します。

DDD：: 000～999（日後）の範囲で指定します。

注意

このメソッドを指定する場合は、以下のいずれかで出力開始時の動作モードをクライアント側で保留する指定にしておく必要があります。
- 帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面の出力開始時の動作モード
- setPrtModeメソッド（「2」を指定する）
保留状態のドキュメントを保留解除する日時は、最大20分の誤差が生じる場合があります。

public void

setJobPriority(int priority)

用途

このメソッドは、Windowsで帳票を出力する場合で、印刷プリンタ名にPrint Managerで定義したプリンタを指定した場合にのみ有効です。

帳票の出力処理の優先順位を指定します。

パラメータ

priority：

帳票の出力処理の優先順位を指定します。

0（省略値）：: 帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面の出力時の優先順位の指定にしたがいます。

1～99：: 出力時の優先順位を指定します。数字が大きいほど優先順位は高くなります。

public void

setInForm(java.lang.String hostname)

用途

このメソッドは、Windowsで帳票を出力する場合で、印刷プリンタ名にPrint Managerで定義したプリンタを指定した場合にのみ有効です。

帳票の出力中に出力装置にエラーが発生した場合や出力経過の通知メッセージの通知先を指定します。

このメソッドの呼び出しを省略すると、帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面で指定したメッセージの通知先が有効になります。

パラメータ

hostname：: メッセージの通知先をTCP/IP のホスト名またはIP アドレスで255バイト以内で指定します。

注意

コンピュータ名とTCP/IP のホスト名は同一となるようネットワークの指定を行ってください。コンピュータ名とTCP/IP のホスト名が異なる場合は、IP アドレスで指定してください。

備考

メッセージの通知先に指定したコンピュータで、Print Managerの「到着通知パネル」を起動しておいてください。

public void

setJobBanner(int jobbanner)

用途

このメソッドは、Windowsで帳票を出力する場合で、印刷プリンタ名にPrint Managerで定義したプリンタを指定した場合にのみ有効です。

区切りページを出力するかどうかを指定します。

このメソッドは、区切りページを出力しない場合にだけ指定してください。

パラメータ

jobbanner：

区切りページを出力するかどうかを指定します。

0（省略値）：: 帳票業務情報のプロパティ画面の［印刷］タブの区切りページ出力設定画面の指定にしたがいます。

1：: 区切りページを出力しません。

注意

区切りページ出力は、PrintMGR V10.0L10以降およびPrint Manager V6.0L10以降と連携する場合にのみ有効です。ただし、プリンタドライバの指定でRAWデータでスプールする指定になっている場合は、区切りページが出力されません。

public void

setJobWait(boolean wait)

用途

このメソッドは、Windowsで帳票を出力する場合で、印刷プリンタ名にPrint Managerで定義したプリンタを指定した場合にのみ有効です。

出力の完了を待ち合わせるかどうかを指定します。

このメソッドで「true」を指定した場合は、出力完了待ち合わせモードをsetJobWaitModeメソッドで指定してください。

パラメータ

wait：

出力の完了を待ち合わせるかどうかを指定します。

false（省略値）：: 出力完了を待ち合わせません（スプール完了時点で復帰します）。

true：: 出力完了を待ち合わせます（スプール完了後、setJobWaitModeメソッドで指定した時点で復帰します）。

注意

このメソッドで「true」を指定する場合は、以下のいずれかで出力開始時の動作モードをすぐに帳票を出力する指定にしておく必要があります。
- 帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面の出力開始時の動作モード
- setPrtModeメソッド（「1」を指定する）
以下に示すプリンタ装置以外では、実際の出力完了のタイミングがずれる場合や、エラーが正しく通知されない場合があります。
- VSP/VSシリーズ
- PrintiaLASER シリーズ（Printianavi 搭載機のみ）
- Print ManagerのLANプリンタ連携機能を使用して接続したネットワークプリンタ
帳票の出力完了待ち合わせ中にスプールドキュメントを他の出力装置に移動した場合、移動先の出力装置での出力完了を待ち合わせます。

public void

setJobWaitMode(int mode)

用途

このメソッドは、Windowsで帳票を出力する場合で、印刷プリンタ名にPrint Managerで定義したプリンタを指定し、setJobWaitメソッドで「true」を指定した場合にのみ有効です。

出力完了待ち合わせモードを指定します。

パラメータ

mode：

出力完了待ち合わせモードを指定します。

0（省略値）：

スプール完了後も以下のいずれかの状態になるまで帳票出力の終了を待ち合わせます。

‐帳票の出力完了

‐スプールドキュメント削除

‐スプールドキュメント保留

‐エラー発生

エラーの詳細については、オンラインマニュアル“Web手元印刷コンポーネント機能編”のメソッド

一覧についての記載を参照してください。

1：

スプール完了後も以下のいずれかの状態になるまで帳票出力の終了を待ち合わせます。

エラー発生時には復帰しません。

‐帳票の出力完了

‐スプールドキュメント削除

‐スプールドキュメント保留

注意

帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面で出力開始メッセージおよび用紙交換メッセージを通知する指定を行っている場合、「1」を指定してください。「0」を指定すると、出力開始メッセージおよび用紙メッセージの通知時に復帰値「-108」で帳票出力が復帰します。

public void

setJobPaperCode(java.lang.String form)

用途

以下の情報を「セミコロン（;）」で区切って指定します。

用紙交換メッセージを通知する用紙名
常に用紙交換メッセージを通知するかどうかの指定

このメソッドを指定した場合は、必ず「用紙交換メッセージを通知する用紙名」を指定してください。指定しない場合はエラーとなります。

用紙交換メッセージを通知する用紙名: 用紙交換メッセージを通知する用紙名を40 バイト以内で指定します。40バイトを超えた部分は切り捨てられます。用紙名には「セミコロン（;）」は指定できません。

常に用紙交換メッセージを通知するかどうかの指定

常に、用紙交換メッセージを通知するかどうかを指定します。

Y：: 常に用紙交換メッセージを通知します。
このメソッドで指定した用紙コードが前回の印刷時と同じでも、用紙交換メッセージを通知します。

N：: 用紙の変更時にのみ用紙交換メッセージを通知します。
このメソッドで指定した用紙コードが前回の印刷時から変更されている場合、用紙交換メッセージを通知します。

「常に用紙交換メッセージを通知するかどうかの指定」を省略した場合は、「N」が指定されたものとして動作します。

このメソッドの指定を省略した場合は、帳票業務情報のプロパティ画面の［印刷］タブの印刷属性設定画面の「常に用紙交換メッセージを通知する」と「以下の用紙名で通知する」の指定が有効になります。

パラメータ

form：: 「用紙交換メッセージを通知する用紙名」と「常に用紙交換メッセージを通知するかどうかの指定」をセミコロン（;）で区切って指定します。

注意

このメソッドは、Windowsの場合にのみ有効です。
出力開始メッセージも通知する場合、出力開始メッセージと用紙交換メッセージが二重で通知される場合があります。
「常に用紙交換メッセージを通知するかどうかの指定」に「N」を指定した場合、帳票の用紙情報とプリンタにセットされている用紙が同じでも、「用紙交換メッセージを通知する用紙名」で指定した用紙名が異なれば、用紙交換メッセージが通知されます。
VSP/VS シリーズのプリンタに印刷する場合、用紙交換メッセージを通知する指定を行うと、用紙交換メッセージが二重に通知される場合があります。

●作業用ディレクトリ情報に関するメソッド

public void

setWorkDirectory(java.lang.String dir)

用途: OWFファイル生成時の作業ディレクトリを指定します。

パラメータ

dir：: 作業用ディレクトリを指定します。

例外

IllegalArgumentException

存在しないディレクトリを指定した場合、またはディレクトリではなくファイルを指定した場合

備考

このメソッドにより作業用ディレクトリを指定しない場合は、次のディレクトリが使用されます。
Windows上でOWFファイルを生成する場合
以下の優先順序で有効になります。
1.環境変数TMPで指定されているパス
2.環境変数TEMPで指定されているパス
UNIX系OS上でOWFファイルを生成する場合
以下の優先順序で有効になります。
1.環境変数TMPDIRで指定されているパス
2./var/tmp配下

●文字コード変換情報に関するメソッド

public void

setFileEucType(java.lang.String euctype)

用途

UNIX系OS上でOWFファイルを生成する場合で、動作環境の言語（環境変数LANG）がEUCロケールの場合に、エンコーディング種別を指定します。

帳票やデータファイルは、doPackメソッドの呼び出し時に、指定されたエンコーディング種別からShift-JISの文字コードに変換されます。

以下の表にしたがって、エンコーディング種別を指定してください。

UNIX系OSの場合

入力データ形式	環境変数LANG	入力データの文字コード系	帳票の文字コード系	setFileEucTypeメソッドで指定する値
可変長/ 固定長/ CSV形式	ja(*1) ja_JP.eucJP	UNICODE （UCS2リトルエンディアン/ UCS2ビッグエンディアン/ UTF8）	EUC（U90）	u90
		UNICODE （UCS2リトルエンディアン/ UCS2ビッグエンディアン/ UTF8）	EUC（S90）	s90
		EUC（U90）	EUC（U90）	u90
		EUC（S90）	EUC（S90）	s90
		Solaris標準EUC(*1)	EUC（U90）	指定しない
XML形式	ja(*1) ja_JP.eucJP	Shift-JIS UNICODE（UTF8）日本語EUC（EUC-JP）	EUC（U90）	u90
XML形式	ja(*1) ja_JP.eucJP	Shift-JIS UNICODE（UTF8）日本語EUC（EUC-JP）	EUC（S90）	s90

*1：【Solaris版】のみ

パラメータ

euctype：

EUCロケール時のエンコーディング種別を指定します。

u90：: 富士通のU90コード体系を使用します。

s90：: 富士通のS90コード体系を使用します。

eucJP（省略値）：: Solaris標準EUCを使用します（SolarisでOWFファイルを生成する場合のみ指定できます）。

注意

SolarisのShift-JIS環境やWindowsでは文字コード変換を行わないため、このメソッドでエンコーディング種別を指定しても無視されます。
UNIX系OS上でOWFファイルを生成する場合については、以下を参照してください。
- オンラインマニュアル“環境設定・帳票運用編”の出力できる文字について（Webアプリケーション連携時）の記載

public void

setCodeconvReplace(boolean replace)

用途: UNIX系OS上でOWFファイルを生成する場合で、動作環境の言語（環境変数LANG）がEUCロケールまたはUNICODE（UTF8）ロケールの場合に、帳票やデータファイルをShift-JISの文字コードに変換します。その際に変換できない文字が存在した場合に代替文字を使用するかどうかを指定します。

パラメータ

replace：

OWFファイル生成時に代替文字を使用するかどうかを指定します。

true：: 代替文字を使用します。

false（省略値）：: 代替文字を使用しません。

注意

代替文字を使用しない指定をした場合は、doPackメソッドの呼び出し時に帳票やデータファイルにShift-JISに変換できない文字が存在すると、例外（OwfFileException[reason:ERR_CODE_CONVERT]）が発生します。
SolarisのShift-JIS環境やWindowsでは文字コード変換を行わないため、このメソッドで代替文字の使用について指定しても無視されます。

9.5.1 OwfFileクラス

9.5.1.1 コンストラクタの概要

9.5.1.2 メソッドの概要

9.5.1.3 コンストラクタの詳細

9.5.1.4 メソッドの詳細