jp.co.intra_mart.product.pdfmaker

インタフェース IODocPageWriter

すべてのスーパーインタフェース:

PageWriter

非推奨です。

intra-mart Accel Platform では、このクラスは使用できません。

public interface IODocPageWriter
extends PageWriter

このクラスは、単票用レイアウトからPDFファイルを作成するための インターフェースです。
このインターフェースを実装したクラスのインスタンスを利用することにより、 PDFファイルを作成することができます。 このインターフェースの実装は、IODocPageBuilder クラスから 取得することができます。

PDFファイルは、defineData メソッドや defineText メソッドで 単票レイアウトに埋め込むデータを 定義して、close メソッドを呼び出すことで作成することができます。 １つのPDFファイルに複数ページ作成する場合には、 １ページ分のデータを設定後 newPage メソッドによりページの区切りを 通知して、次のページのデータを設定します。これを、ページ数分だけ 繰り返し処理します。
PDFファイル作成時に使用するレイアウトは、 このインターフェースの実装を取得した IODocPageBuilder クラスの インスタンスで定義されているレイアウトファイルになります。

IODocPageWriter のインスタンスは、使い終わったら破棄する前に必ず release メソッドを実行して下さい。 release メソッドを実行せずにインスタンスを破棄してしまうと メモリが開放されず、その後のアプリケーション実行に影響してしまいます。

IODocPageWriter の１つのインスタンスは、１つのPDF(または中間)ファイルを 作成するためだけに利用します。 １つのインスタンスで複数のPDFファイルを連続で作成することはできません。
また、IODocPageWriter のインスタンスは同期化されません。 複数のスレッドから同時に IODocPageWriter のインスタンスにアクセスした場合、 正しくPDFファイルを作成することができません。

導入されたバージョン:

PDF-Designer Version 3.2

関連項目:

IODocPageBuilder

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	defineData(String id, String data) 非推奨です。 PDFファイルへの埋め込みデータを指定します。
void	defineText(String id, String text) 非推奨です。 文字枠に対するデータを設定します。
void	newPage() 非推奨です。 改ページ指定を行います。
File	outputFile() 非推奨です。 出力先ファイルを取得します。

インタフェースから継承されたメソッド jp.co.intra_mart.product.pdfmaker.PageWriter

close, release

メソッドの詳細

defineData

void defineData(String id,
                String data)
         throws PDFException

非推奨です。

PDFファイルへの埋め込みデータを指定します。
レイアウト作成時に設定しておいた識別子に埋め込みデータをマップします。 埋め込みデータは、PDFファイル作成時にマップされた識別子の 位置に置換されます。

パラメータ:

id - データ識別子

data - 識別子にマップするPDFファイルへの埋め込みデータ

例外:

PDFException - データ設定エラー

newPage

void newPage()
      throws PDFException

非推奨です。

改ページ指定を行います。

例外:

PDFException - データ設定エラー

defineText

void defineText(String id,
                String text)
         throws PDFException

非推奨です。

文字枠に対するデータを設定します。 このメソッドは、defineData メソッドと似ていますが、 文字列 text 内で改行コードを扱うことができるという点において、 異なります。

パラメータ:

id - 識別子

text - テキストデータ

例外:

PDFException - データ設定エラー

関連項目:

defineData(String, String)

outputFile

File outputFile()

非推奨です。

出力先ファイルを取得します。
このオブジェクトがPDFデータを作成する場合、 このメソッドの返すファイルはPDFファイルになります。 また、このオブジェクトがIOD中間データを作成する場合、 このメソッドの返すファイルはIOD中間ファイルになります。

定義:

outputFile インタフェース内 PageWriter

戻り値:

PDFファイルの出力先ファイル