JSDoc: Class: pmuoutline

Constructor

new pmuoutline(holopt)

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

Parameters:

Name	Type	Attributes	Description
`hol`	Number	<optional>	引数は省略可能です。

Author:

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

Returns:

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

Examples

// PDFしおりオブジェクトクラスのインスタンスを生成します。
var outline = new pmuoutline(hol);

// PDFしおりオブジェクトクラスのインスタンスを生成します。
// 引数は省略可能です。
var outline = new pmuoutline();

Extends

pdfmakeup

Members

m_encode

Properties:

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

Overrides:

pdfmakeup#m_encode

Example

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

Methods

add(oltype) → {pmuoutline|pmuoutlinepage|pmuoutlinepdf}

子階層の末尾に、新規にしおりを作成して、作成したしおりを返します。

Parameters:

Name	Type	Description
`oltype`	String	以下のしおりの種類を指定します。 "PAGE":ページジャンプ "PDF":別PDFへジャンプ "TEXT":テキストのみ

Returns:

新規に作成したしおりオブジェクトを返します。
引数oltypeに応じて、以下のクラスを返します。
"PAGE":pmuoutlinepage
"PDF":pmuoutlinepdf
"TEXT":pmuoutline

Type: pmuoutline | pmuoutlinepage | pmuoutlinepdf

Example

// 新規にしおりを作成して、作成したしおりを返します。
// @param {String} oltype しおりの種類を指定します。 ⇒ "PAGE":ページジャンプ
var poutline = outline.add("PAGE");

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);

geterror() → {String}

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

Inherited From:

pdfmakeup#geterror

Returns:

エラーの要因メッセージ

Type: String

geterrorno() → {Number}

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

Inherited From:

pdfmakeup#geterrorno

Returns:

エラー要因(数値)

Type: Number

getparent() → {pmuoutline}

一つ上のしおりオブジェクトを返します。

Returns:

一つ上のしおりオブジェクトを返します。

Type: pmuoutline

getroot() → {pmuoutline}

一番上(ルート)のしおりオブジェクトを返します。

Returns:

一番上(ルート)のしおりオブジェクトを返します。

Type: pmuoutline

getversion() → {String}

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

Inherited From:

pdfmakeup#getversion

Returns:

バージョン(文字列)

Type: String

getversionno() → {Number}

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

Inherited From:

pdfmakeup#getversionno

Returns:

バージョン(数値)

Type: Number

insert(index, oltype) → {pmuoutline|pmuoutlinepage|pmuoutlinepdf}

子階層の指定された挿入位置に、新規にしおりを作成して、作成したしおりを返します。

Parameters:

Name	Type	Description
`index`	Number	新規しおりの挿入位置を指定します。子階層の先頭の位置を「0」として指定してください。
`oltype`	String	以下のしおりの種類を指定します。 "PAGE":ページジャンプ "PDF":別PDFへジャンプ "TEXT":テキストのみ

Returns:

新規に作成したしおりオブジェクトを返します。
引数oltypeに応じて、以下のクラスを返します。
"PAGE":pmuoutlinepage
"PDF":pmuoutlinepdf
"TEXT":pmuoutline

Type: pmuoutline | pmuoutlinepage | pmuoutlinepdf

Example

// 指定された挿入位置に、新規にしおりを作成して、作成したしおりを返します。
// @param {Number} index 新規しおりの挿入位置を指定します。 ⇒ 1:子階層の上から2つ目の位置を指定
// @param {String} oltype しおりの種類を指定します。 ⇒ "PAGE":ページジャンプ
var poutline = outline.insert(1, "PAGE");

setcaption(caption) → {Number}

しおりの見出し文字列を設定します。

Parameters:

Name	Type	Description
`caption`	String	しおりの見出し文字列を指定します。

Returns:

正常時:0, 異常時:負の値

Type: Number

Example

// しおりの見出し文字列を設定します。
// @param {String} caption しおりの見出し文字列を指定します。
outline.setcaption("見出し１");

setexpand(bexpand) → {Number}

しおりを初期表示で開いた状態にするかを設定します。

Parameters:

Name	Type	Description
`bexpand`	boolean	true:開いた状態にする, false:開いた状態にしない

Returns:

正常時:0, 異常時:負の値

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);

setpdfamode(bpdfamode, reserved) → {Number}

Parameters:

Name	Type	Description
`bpdfamode`	boolean
`reserved`	Number

Inherited From:

pdfmakeup#setpdfamode

Returns:

Type: Number

setviewop(viewop, param1, param2, param3, param4) → {Number}

しおりのジャンプ先の表示操作を設定します。

Parameters:

Name	Type	Description
`viewop`	String	以下のしおりのジャンプ先の表示操作を指定します。 "PAGE":全体表示 "PAGEWIDTH":幅に合わせて表示 "PAGEHEIGHT":高さに合わせて表示 "DRAWPAGE":全体表示(描画域) "DRAWWIDTH":幅に合わせて表示(描画域) "DRAWHEIGHT":高さに合わせて表示(描画域) "XYZOOM":左上と表示倍率を指定 "RECT":指定した矩形部分を表示
`param1`	Number	しおりのジャンプ先の表示操作に合わせた値を指定します。 Y座標:PAGEWIDTH、DRAWWIDTHの場合 X座標:PAGEHEIGHT、DRAWHEIGHTの場合左上X座標:XYZOOM、RECTの場合 0:その他の場合
`param2`	Number	しおりのジャンプ先の表示操作に合わせた値を指定します。左上Y座標:XYZOOM、RECTの場合 0:その他の場合
`param3`	Number	しおりのジャンプ先の表示操作に合わせた値を指定します。表示倍率:XYZOOMの場合(1.0が等倍表示です) 右下X座標:RECTの場合 0:その他の場合
`param4`	Number	しおりのジャンプ先の表示操作に合わせた値を指定します。右下Y座標:RECTの場合 0:その他の場合

Returns:

正常時:0, 異常時:負の値

Type: Number

Examples

// しおりのジャンプ先の表示操作を設定します。
// @param {String} viewop しおりのジャンプ先の表示操作を指定します。 ⇒ "PAGE":全体表示
// @param {Number} param1 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ "PAGE"のため、0を指定
// @param {Number} param2 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ "PAGE"のため、0を指定
// @param {Number} param3 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ "PAGE"のため、0を指定
// @param {Number} param4 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ "PAGE"のため、0を指定
var result = outline.setviewop("PAGE", 0, 0, 0, 0);

// しおりのジャンプ先の表示操作を設定します。
// @param {String} viewop しおりのジャンプ先の表示操作を指定します。 ⇒ "PAGEHEIGHT":高さに合わせて表示
// @param {Number} param1 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ X座標
// @param {Number} param2 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ "PAGEHEIGHT"のため、0を指定
// @param {Number} param3 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ "PAGEHEIGHT"のため、0を指定
// @param {Number} param4 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ "PAGEHEIGHT"のため、0を指定
var result = outline.setviewop("PAGEHEIGHT", 100, 0, 0, 0);

// しおりのジャンプ先の表示操作を設定します。
// @param {String} viewop しおりのジャンプ先の表示操作を指定します。 ⇒ "XYZOOM":左上と表示倍率を指定
// @param {Number} param1 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ 左上X座標
// @param {Number} param2 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ 左上Y座標
// @param {Number} param3 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ 表示倍率
// @param {Number} param4 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ "XYZOOM"のため、0を指定
var result = outline.setviewop("XYZOOM", 200, 100, 1.5, 0);

// しおりのジャンプ先の表示操作を設定します。
// @param {String} viewop しおりのジャンプ先の表示操作を指定します。 ⇒ "RECT":指定した矩形部分を表示
// @param {Number} param1 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ 左上X座標
// @param {Number} param2 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ 左上Y座標
// @param {Number} param3 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ 右下X座標
// @param {Number} param4 しおりのジャンプ先の表示操作に合わせた値を指定します。 ⇒ 右下Y座標
var result = outline.setviewop("RECT", 100, 200, 200, 300);

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");