Class: IOCela

IOCela(path)

new IOCela(path)

連票用レイアウトファイルと、CSV形式のデータファイル又はレコードデータからIOD又はPDF形式ファイルを生成するAPIです。
各定義ファイルおよびデータファイルは Public Storage に保存しておく必要があります。
実行後に作成されるIOD/PDFファイルは、Public Storage に作られます。
Parameters:
Name Type Description
path String DEFレイアウト定義ファイル
Author:
  • 株式会社ワイ・エス・エス
Throws:
例外発生時スロー
Type
Exception

Methods

copySecurity(flgname)

PDFセキュリティのテキスト抽出コピー許可フラグを設定します。
Parameters:
Name Type Description
flgname String テキスト抽出コピー許可フラグ文字列(COPY_AND_ACCESSBILITY_ENABLE/COPY_AND_ACCESSBILITY_DISABLE)

createTempFile() → {String}

アプリケーションサーバの管理するテンポラリディレクトリ上にテンポラリファイルを作成し、その絶対パス名を返却します。
Returns:
テンポラリファイルの絶対パス
Type
String

defineApplication(appliname)

PDF文書情報作成アプリケーション名を設定します。
Parameters:
Name Type Description
appliname String 作成アプリケーション名

defineAuthor(author)

PDF文書情報作成者を設定します。
Parameters:
Name Type Description
author String 作成者

defineSubTitle(subtitle)

PDF文書情報サブタイトルを設定します。
Parameters:
Name Type Description
subtitle String 文書サブタイトル

defineTitle(title)

PDF文書情報タイトルを設定します。
Parameters:
Name Type Description
title String 文書タイトル

getMessage() → {String}

実行結果メッセージを取得します。
Returns:
結果メッセージ文字列
Type
String

modifySecurity(flgname)

PDFセキュリティの編集許可フラグを設定します。
Parameters:
Name Type Description
flgname String

printSecurity(flgname)

PDFセキュリティの印刷許可フラグを設定します。
Parameters:
Name Type Description
flgname String 印刷許可フラグ文字列(PRINT_ENABLE/PRINT_DISABLE)

setCharset(charset)

内部生成ファイル文字エンコード形式セットです。
内部で作成されるオブジェクトデータ形式によるDATデータファイルの文字列エンコード形式を設定します。
指定されない場合はデフォルトのMS932形式でファイルが作成されます。
Parameters:
Name Type Description
charset String 文字エンコード形式

setCSV(path)

CSV形式データファイル・パスを設定します。
DAT形式ファイル、オブジェクト直接指定方式との同時使用はできません。
Parameters:
Name Type Description
path String CSV形式データファイルパス(Public Storageからの相対形式で表されるパス名[英数字])

setData(id, data)

IOCela文書内IOD向けオブジェクトデータをセットします。
識別子データのみの出力の場合は、データ文字列にはブランクを設定します。
Parameters:
Name Type Description
id String 埋め込み識別子ID
data String 埋め込みデータ文字列

setDocData(docdata)

IOCela文書内に組み込まれるIODレイアウトファイルへの埋め込みデータファイル(DAT)をセットします。
当埋め込みデータファイルは、setDocIodメソッド内に記載されるIODレイアウトファイル内へ埋め込まれます。
Parameters:
Name Type Description
docdata String 埋め込みDATファイル(Public Storageからの相対形式で表されるパス名[英数字])

setDocIod(dociod)

IOCela文書内に貼り付けるIODocレイアウトファイル(IOD)をセットします。
当IODファイル内に記載される埋め込みデータファイルは、setDocData(String)メソッドで登録します。
Parameters:
Name Type Description
dociod String 埋め込みIODファイル(Public Storageからの相対形式で表されるパス名[英数字])

setImageData(id, filepath)

IOCela文書内IOD向けオブジェクトデータ(イメージ)をセットします。
Parameters:
Name Type Description
id String 埋め込み識別子ID
filepath String 埋め込みイメージファイル(Public Storageからの相対形式で表されるパス名[英数字])

setOpenPassword(openpass)

PDFオープンパスワードを設定します。
Parameters:
Name Type Description
openpass String オープンパスワード

setRecord(datarecord)

IOCela出力用データレコードをセットします。
レコード単位でのデータをセットします。連続で呼び出すことにより複数レコードデータを順次登録します。
Parameters:
Name Type Description
datarecord String 埋め込み用データレコード

setSecurityPassword(secpass)

PDFセキュリティパスワードを設定します。
Parameters:
Name Type Description
secpass String セキュリティパスワード

setTextBoxData(textboxdata)

IOCela文書内IOD向けオブジェクトデータ(文字枠用)のデータをセットします。
文字枠の1行分(改行コードまで)のデータレコードをセットします。
複数行指定の場合は、連続して当メソッドを呼び出します。
Parameters:
Name Type Description
textboxdata String 埋め込みデータ文字列

setTextBoxEnd()

IOCela文書内IOD向けオブジェクトデータ(文字枠用)の終了宣言です。
文字枠データ文字列を全てセット後、必ず呼び出す必要が有ります。

setTextBoxStart(id)

IOCela文書内IOD向けオブジェクトデータ(文字枠用)の開始宣言です。
文字枠内部データ埋め込み前に必ず呼び出す必要が有ります。
Parameters:
Name Type Description
id String 埋め込み識別子ID(文字枠)

toIOD(path) → {Number}

IODファイルを生成します。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
Parameters:
Name Type Description
path String 出力IODファイル(Public Storageからの相対形式で表されるパス名[英数字])
Returns:
処理戻り値(0:正常終了/-1以下:何らかのエラー)
Type
Number

toPDF(path) → {Number}

PDFファイルを生成します。
処理内部で発生した例外については、戻り値となる処理コード、及びgetMessage()により取得できる返却メッセージにより確認してください。
Parameters:
Name Type Description
path String 出力PDFファイル(Public Storageからの相対形式で表されるパス名[英数字])
Returns:
処理戻り値(0:正常終了/-1以下:何らかのエラー)
Type
Number