5.1.4 OwfPropertiesクラス

Javaインタフェースに渡す印刷方法やその他属性情報を保持します。

なお、OwfProperties クラスを使用して帳票を出力する場合、帳票の出力に関する各属性を
PrintPropertiesクラスのsetPropertyメソッドで指定することを推奨します。

setProperty メソッドについては、オンラインマニュアル“アプリケーション作成ガイド”のsetPropertyメソッドの記載を参照してください。

java.lang.Object
 ∟ com.fujitsu.systemwalker.outputassist.connector.OwfProperties

public class OwfProperties
extends java.lang.Object
implements java.io.Serializable

OwfPropertiesクラスのsetDestinationメソッドで指定するフィールドを以下に示します。

表5.38 OwfPropertiesクラスのsetDestinationメソッドで指定するフィールド
定数	説明
DESTINATION_PREVIEW	プレビューします。
DESTINATION_PRINT	印刷します。

OwfPropertiesクラスのsetPrtPreventionExメソッドで指定するフィールドを以下に示します。

表5.39 OwfPropertiesクラスのsetPrtPreventionExメソッドで指定するフィールド
定数	説明
PRTPREVENTION_FALSE	印刷を抑止しません。
PRTPREVENTION_TWICE	2重印刷を抑止します。
PRTPREVENTION_TRUE	印刷を抑止します。

OwfPropertiesクラスのsetOwfEmbedEUDCメソッドで指定するフィールドを以下に示します。

表5.40 OwfPropertiesクラスのsetOwfEmbedEUDCメソッドで指定するフィールド
定数	説明
EMBEDEUDC_FALSE	外字をエンベッド（貼り付け）しません。
EMBEDEUDC_ALL	外字をエンベッド（貼り付け）します。

OwfPropertiesクラスのコンストラクタを以下に示します。

表5.41 OwfPropertiesクラスのコンストラクタ
コンストラクタの概要
OwfProperties() OwfPropertiesオブジェクトを生成します。

OwfPropertiesクラスのメソッドを以下に示します。

表5.42 OwfPropertiesクラスのメソッド
メソッドの分類	メソッドの概要 W：アプリケーションサーバがWindowsの場合に使用できるメソッドです。 S：アプリケーションサーバがSolarisの場合に使用できるメソッドです。 L：アプリケーションサーバがLinuxの場合に使用できるメソッドです。共：どの環境でも使用できるメソッドです。
ユーザ資源情報に関するメソッド	共	void	setLcVisualFile(java.lang.String file) (*1) メディアデータファイル名を指定します。
動作情報に関するメソッド	共	void	setDestination(int mode) Webプラグイン起動時の動作モードを指定します。
	共	void	setOpenPrtDlg(boolean openprtdlg) 印刷時（setDestinationメソッドに「DESTINATION_PRINT」を指定した場合）に印刷画面を表示するかどうかを指定します。
	共	void	setPrtClose(boolean closeflag) 印刷完了後、Webブラウザを閉じるかどうかを指定します。
	共	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) (*1) 任意のフォルダに格納されている外字フォントファイルを登録します。
プレビュー情報に関するメソッド	共	void	setPreviewRate(java.lang.String rate) プレビュー時のズーム率を指定します。
	共	void	setPrtPreventionEx(int prevention) プレビュー時の印刷制御方法を指定します。
	共	void	setPrtPrevention(boolean prtprevention) プレビューからの2重印刷を抑止するかどうかを指定します。なお、Windows版 ListCREATOR V10.0L30および Solaris版 ListCREATOR 10.2 以降およびList Creator 6.0以降は、プレビューからの2重印刷を抑止するかどうかの指定は、setPrtPreventionExメソッドを使用することを推奨します。
作業用ディレクトリ情報に関するメソッド	共	void	setWorkDirectory(java.lang.String dir) (*1) OWFファイル生成時の作業ディレクトリを指定します。

*1：
帳票出力サーバがUNIX系OSの場合、ファイルパスに、全角文字および半角カナ文字は指定できません。

public

OwfProperties()

用途: OwfPropertiesオブジェクトを生成します。

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

ポイント

OWFファイル生成（Webアプリケーション連携機能）に関するサポート範囲や留意事項、外字エンベッドやフォントの登録などについては、オンラインマニュアル“環境設定・帳票運用編”を参照してください。

public void

setLcVisualFile(java.lang.String file)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

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

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

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

パラメータ

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

例外: ConnectorException

注意

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

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

public void

setDestination(int mode)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

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

このメソッドの呼び出しを省略した場合、「DESTINATION_PREVIEW」が指定されたものとして動作します。

パラメータ

mode：

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

DESTINATION_PREVIEW：: プレビューします（初期値）。

DESTINATION_PRINT：: 印刷します。

例外: ConnectorException

public void

setOpenPrtDlg(boolean openprtdlg)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

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

このメソッドの呼び出しを省略すると、印刷時に印刷画面を表示しません。

パラメータ

openprtdlg：

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

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

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

例外: ConnectorException

public void

setPrtClose(boolean closeflag)

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

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

このメソッドの呼び出しを省略すると、印刷が完了してもWebブラウザは閉じません。

パラメータ

closeflag：

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

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

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

注意

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

public void

setOwfEmbedEUDC(int eudcembedtype)

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

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

このメソッドの呼び出しを省略すると、外字をエンベッドしません。

パラメータ

eudcembedtype：

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

EMBEDEUDC_FALSE：: 外字をエンベッドしません。

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

備考

エンベッドする外字は、以下の方法で登録する必要があります（登録されていない外字はエンベッドされません）。
- 環境設定によるフォントの登録
- setOwfRegFontメソッド、またはsetOwfRegFontCollectionメソッドによるフォントの登録

public void

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

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

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

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

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

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

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

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

パラメータ

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

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

order：: TTCファイルを指定するときは、TTCファイル内の何番目の書体を登録するかを指定します。
先頭の書体を登録する場合は、「1」を指定します。

例外: ConnectorException

注意

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

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

public void

setPreviewRate(java.lang.String rate)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

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

このメソッドの呼び出しを省略すると、「0」が指定されたものとして動作します。

パラメータ

rate：

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

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

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

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

例外: ConnectorException

public void

setPrtPreventionEx(int prevention)

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

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

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

パラメータ

prevention：

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

PRTPREVENTION_FALSE：: 印刷を抑止しません。

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

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

public void

setPrtPrevention(boolean prtprevention)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

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

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

パラメータ

prtprevention：

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

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

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

例外: ConnectorException

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

public void

setWorkDirectory(java.lang.String dir)

throws ConnectorException

用途

このメソッドによる指定よりも、PrintPropertiesクラスのsetPropertyメソッドで、このメソッドに対応するキーと値による指定を推奨します。

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

パラメータ

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

例外: ConnectorException

備考

このメソッドにより作業用ディレクトリを指定しない場合は、次のディレクトリが使用されます。

Windows上でOWFファイルを生成する場合

以下の優先順序で有効になります。

環境変数TMPで指定されているパス
環境変数TEMPで指定されているパス

UNIX系OS上でOWFファイルを生成する場合

以下の優先順序で有効になります。

環境変数TMPDIRで指定されているパス
/var/tmp配下

5.1.4 OwfPropertiesクラス

5.1.4.1 フィールドの概要

5.1.4.2 コンストラクタの概要

5.1.4.3 メソッドの概要

5.1.4.4 コンストラクタの詳細

5.1.4.5 メソッドの詳細