JSDoc: Class: pmueditsrc

Constructor

new pmueditsrc(hsrc)

インスタンスオブジェクトの作成。

Parameters:

Name	Type	Description
`hsrc`	Number

Author:

株式会社ワイ・エス・エス

Returns:

生成されたインスタンスオブジェクト

Example

// PDFページ配置の対象ファイルクラスのインスタンスを生成します。
// @param {Number} hsrc
var editsrc = new pmueditsrc(hsrc);

Extends

pmusrc

Members

m_encode

Properties:

Name	Type	Description
`m_encode`	String	getBytes()などで使用するエンコード文字列です。文字列を取り扱うメソッドを使用する際は、事前に当メンバへ"MS932"を指定してください。指定しなかった場合、全角文字にて文字化けが発生し、正常に処理されない可能性があります。

Overrides:

pmusrc#m_encode

Example

// @property {String} m_encode getBytesなどで使用するエンコード文字列です。
editsrc.m_encode = "MS932";

Methods

bytetostr(bstr) → {String}

バイナリのNumber[]をStringに変換して返します。
アプリケーション側で何らかの事情でエンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。

Parameters:

Name	Type	Description
`bstr`	Array.<Number>	変換を行う配列

Inherited From:

pdfmakeup#bytetostr

Returns:

bstrがヌルの場合は、ヌルを返します。
m_encodeが、ヌルの場合はnew String(bstr)を返します。
m_encodeが、ヌルでない場合はnew String(str,m_encode)を返します。

Type: String

Example

// バイナリのNumber[]をStringに変換して返します。
// 使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
// @param {Number[]} bstr 変換を行う配列
makeup.m_encode = "MS932";
var convertedString = makeup.bytetostr(binaryArray);

getdocinfo(infotype) → {String}

文書情報を文字列で返します。

Parameters:

Name	Type	Description
`infotype`	String	以下の文書情報の種類を指定します。 "APP":アプリケーション "CONVERTER":PDF変換プログラム "CREATOR":作成者 "FASTWEBVIEW":Web用に最適化の状況 "ISPDFA":PDF/Aか否か "KEYWORD":キーワード "OPENINGPAGE":ページの初期表示の種類 "OPENINGPAGELAYOUT":初期表示のページレイアウト "OPENINGPAGEPAGE":ページの初期表示のページ番号 "OPENINGPAGEZOOM":ページの初期表示の表示縮尺 "OPENINGPANEL":初期表示のパネル "PDFAVERSION":PDF/Aのバージョン "PDFVERSIONNO":PDF形式のバージョン/番号形式 "PDFVERSIONSTR":PDF形式のバージョン/文字列形式 "PORTFOLIO":ポートフォリオファイルか "SUBTITLE":サブタイトル "TITLE":タイトル "XFAFORM":XFA Formファイルか

Inherited From:

pmusrc#getdocinfo

Returns:

infotypeで指定した情報の文字列を返します。
また、オープンされていない、読取エラー等の場合はnullを返します。

Type: String

Example

// 文書情報を文字列で返します。
// @param {String} infotype 文書情報の種類を指定します。 ⇒ "KEYWORD":キーワード
var keyrowd = src.getdocinfo("KEYWORD");

getdocinfovalue(infotype) → {Number}

文書情報を値で返します。

Parameters:

Name	Type	Description
`infotype`	String	以下の文書情報の種類を指定します。 "APP":アプリケーション "CONVERTER":PDF変換プログラム "CREATOR":作成者 "FASTWEBVIEW":Web用に最適化の状況 "ISPDFA":PDF/Aか否か "KEYWORD":キーワード "OPENINGPAGE":ページの初期表示の種類 "OPENINGPAGELAYOUT":初期表示のページレイアウト "OPENINGPAGEPAGE":ページの初期表示のページ番号 "OPENINGPAGEZOOM":ページの初期表示の表示縮尺 "OPENINGPANEL":初期表示のパネル "PDFAVERSION":PDF/Aのバージョン "PDFVERSIONNO":PDF形式のバージョン/番号形式 "PDFVERSIONSTR":PDF形式のバージョン/文字列形式 "PORTFOLIO":ポートフォリオファイルか "SUBTITLE":サブタイトル "TITLE":タイトル "XFAFORM":XFA Formファイルか

Inherited From:

pmusrc#getdocinfovalue

Returns:

infotypeで指定した情報の値を返します。
また、文字列タイプを指定した場合は0を返します。

Type: Number

Example

// 文書情報を文字列で返します。
// @param {String} infotype 文書情報の種類を指定します。 ⇒ "OPENINGPAGELAYOUT":初期表示のページレイアウト
var openingpagelayout = src.getdocinfovalue("OPENINGPAGELAYOUT");

geterror() → {String}

最後のエラーの要因メッセージを返します。

Inherited From:

pdfmakeup#geterror

Returns:

エラーの要因メッセージ

Type: String

geterrorno() → {Number}

最後のエラー要因(数値)を返します。

Inherited From:

pdfmakeup#geterrorno

Returns:

エラー要因(数値)

Type: Number

getpagecount() → {Number}

オープンした切出し元のPDFのページ数を返します。

Inherited From:

pmusrc#getpagecount

Returns:

オープンした切出し元のPDFのページ数

Type: Number

getpageinfo(page) → {pmupageinfo}

指定ページのページ情報を返します。

Parameters:

Name	Type	Description
`page`	Number	指定ページ

Inherited From:

pmusrc#getpageinfo

Returns:

PDFのページ情報クラス

Type: pmupageinfo

getsecurityinfo() → {pmusecinfo}

セキュリティ情報クラスを返します。

Inherited From:

pmusrc#getsecurityinfo

Returns:

セキュリティ情報クラス

Type: pmusecinfo

getversion() → {String}

バージョン(文字列)を返します。

Inherited From:

pdfmakeup#getversion

Returns:

バージョン(文字列)

Type: String

getversionno() → {Number}

バージョン(数値)を返します。

Inherited From:

pdfmakeup#getversionno

Returns:

バージョン(数値)

Type: Number

init() → {Number}

内部メンバの初期化等を行います。

Inherited From:

pmusrc#init

Returns:

正常時は0、エラー時は-1を返します。

Type: Number

initwithetcpath(etcpath) → {Number}

内部メンバの初期化等を行います。環境ファイルパスを指定できます。

Parameters:

Name	Type	Description
`etcpath`	String	環境ファイルパス

Inherited From:

pmusrc#initwithetcpath

Returns:

正常時は0、エラー時は-1を返します。

Type: Number

openpdf(filename, passwd) → {Number}

切出し元のPDFファイルをオープンします。

Parameters:

Name	Type	Description
`filename`	String	切り出し元PDF
`passwd`	String	切り出し元PDFのパスワード

Inherited From:

pmusrc#openpdf

Returns:

Type: Number

openpdfforinfo(filename, passwd, level) → {Number}

情報取得用にPDFファイルをオープンします。

Parameters:

Name	Type	Description
`filename`	String	オープンするPDFファイル名を指定します。
`passwd`	String	オープンするPDFのパスワードを指定します。
`level`	Number	現状常に0を指定します。 0以外を指定した場合はエラーとなります。

Inherited From:

pmusrc#openpdfforinfo

Returns:

Type: Number

release()

pmueditsrcクラスは、pmueditクラスに管理される為、何もしません。
このメソッドは呼び出さないで下さい。

Overrides:

pmusrc#release

See:

pmuedit

setlayer(layer) → {Number}

どのレイヤに含めるかを設定します。

Parameters:

Name	Type	Description
`layer`	pmuobjlayer	pmuedit.createlayer()で作成したインスタンスを指定します。レイヤ指定を無効にするにはnullを指定します。

See:

pmuedit#createlayer

Returns:

Type: Number

setmargin(xm, ym) → {Number}

setorigin()で指定した基本位置からの原点の移動量を指定します。

Parameters:

Name	Type	Description
`xm`	Number	水平方向移動量
`ym`	Number	垂直方向移動量

See:

#setorigin

Returns:

Type: Number

setoptionvalue(optiontype, optionvalue) → {Number}

各種オプションを設定します。

Parameters:

Name	Type	Description
`optiontype`	String	オプションの種類を表す文字列 "PORTFOLIOERROR":ポートフォリオファイルをエラーにする "XFAFORMERROR":XFA Formファイルをエラーにする "PAGETREEVALIDATE":ページツリーの整合性をチェックする
`optionvalue`	Number

Inherited From:

pdfmakeup#setoptionvalue

Returns:

Type: Number

Example

// 各種オプションを設定します。
// @param {String} optiontype オプションの種類を表す文字列 ⇒ "PORTFOLIOERROR":ポートフォリオファイルをエラーにする
// @param {Number} optionvalue
makeup.setoptionvalue("PORTFOLIOERROR", 1);

setorder(order) → {Number}

pmuedit.outpage()によるページ配置時の上下関係を設定します。

Parameters:

Name	Type	Description
`order`	Number	任意の数値を指定します。 0が一番下になります。 0以下は0と見なされます。

See:

pmuedit#outpage

Returns:

Type: Number

setorigin(origin) → {Number}

pmuedit.outpage()によるページ配置時の原点位置を設定します。

Parameters:

Name	Type	Description
`origin`	String	原点位置を指定します。 "LT":左上 "LM":左中段 "LB":左下 "CT":中央上 "CM":中央中段 "CB":中央下 "RT":右上 "RM":右中段 "RB":右下

See:

pmuedit#outpage

Returns:

Type: Number

Example

// pmuedit.outpageによるページ配置時の原点位置を設定します。
//@param {String} origin 原点位置を指定します。 ⇒ "LM":左中段
editsrc.setorigin("LM");

setpage(page) → {Number}

pmuedit.outpage()によるページ配置対象のページを設定します。

Parameters:

Name	Type	Description
`page`	Number	pmuedit.outpage()が出力する、対象になるページを指定します(1以上の値)。存在しないページ番号を指定した場合は、ページ配置対象になりません。

See:

pmuedit#outpage

Returns:

Type: Number

setpdfamode(bpdfamode, reserved) → {Number}

Parameters:

Name	Type	Description
`bpdfamode`	boolean
`reserved`	Number

Inherited From:

pdfmakeup#setpdfamode

Returns:

Type: Number

setscale(scale) → {Number}

縮尺を指定します。

Parameters:

Name	Type	Description
`scale`	Number	縮尺を指定します。1.0が等倍です

Returns:

Type: Number

settemppath(temppath) → {Number}

処理中で使用する、一時ファイルの作成先を指定します。

Parameters:

Name	Type	Description
`temppath`	String	一時ファイルの作成先

Inherited From:

pmusrc#settemppath

Returns:

正常時:0, エラー時:負の値

Type: Number

settransoff() → {Number}

透過モードの設定を無効にします。

Returns:

Type: Number

settransparency(transmode, transparency) → {Number}

透過モードを設定します。

Parameters:

Name	Type	Description
`transmode`	String	以下の透過のモードを指定します。 "SRC":描画色をそのまま透過描画色として使用します。 "MULTIPLY":描画色と背景色とを乗算した値を透過描画色として使用します。描画色と背景色のどちらかが黒の場合は透過描画色も必ず黒になります。
`transparency`	Number	0(透明)～100(不透明)の値

Returns:

Type: Number

Example

// 透過モードを設定します。
// @param {String} transmode 透過のモードを指定します。 ⇒ "SRC":描画色をそのまま透過描画色として使用します。
// @param {Number} transparency 0(透明)～100(不透明)の値 ⇒ 50:半透明
editsrc.settransparency("SRC", 50);

strtobyte(bstr) → {Array.<Number>}

StringをバイナリとしてNumber[]に変換して返します。
アプリケーション側で何らかの事情でエンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。

Parameters:

Name	Type	Description
`bstr`	String	変換を行う文字列

Inherited From:

pdfmakeup#strtobyte

Returns:

strがヌルの場合は、ヌルを返します。
m_encodeが、ヌルの場合はstr.getBytes()を返します。
m_encodeが、ヌルでない場合はstr.getBytes(m_encode)を返します。

Type: Array.<Number>

Example

// StringをバイナリとしてNumber[]に変換して返します。
// 使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
// @param {String} bstr 変換を行う文字列
makeup.m_encode = "MS932";
var binaryString = strtobyte("sample");