JSDoc: Class: pmuobjlayedlayer

Constructor

new pmuobjlayedlayer()

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

Author:

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

Returns:

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

Example

// pmulayed用レイヤオブジェクトクラスのインスタンスを生成します。
var objlayedlayer = new pmuobjlayedlayer();

Extends

pmuobjlayer

Members

m_encode

Properties:

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

Overrides:

pmuobjlayer#m_encode

Example

// @property {String} m_encode getBytesなどで使用するエンコード文字列です。
objlayedlayer.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);

deletelayer() → {Number}

レイヤの削除

Returns:

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

Type: Number

getcreator() → {String}

レイヤの作成者を取得します。

Returns:

レイヤの作成者

Type: String

geterror() → {String}

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

Inherited From:

pdfmakeup#geterror

Returns:

エラーの要因メッセージ

Type: String

geterrorno() → {Number}

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

Inherited From:

pdfmakeup#geterrorno

Returns:

エラー要因(数値)

Type: Number

getintent() → {String}

レイヤのIntent属性を取得します。

Returns:

"VIEW":表示プログラム上で、表示・非表示等の切り替えが可能です。
"DESIGN":表示プログラム上で、表示・非表示等の切り替えが出来ません。
文字列の負の値:異常時

Type: String

getlock() → {Number}

レイヤのロック属性を取得します。

Returns:

0:設定されていません。
1:設定されています。
文字列の負の値:異常時

Type: Number

getname() → {String}

レイヤ名属性を取得します。

Returns:

レイヤ名

Type: String

getstatedefault() → {String}

レイヤのデフォルト状態を取得します。

Returns:

"OFF":常にオフです。
"ON":常にオンです。
文字列の負の値:異常時

Type: String

getstateexport() → {String}

レイヤのエクスポート状態を取得します。

Returns:

"DEFAULT":状況に依存します。
"OFF":常にオフです。
"ON":常にオンです。
文字列の負の値:異常時

Type: String

getstateprint() → {String}

レイヤの印刷状態を取得します。

Returns:

"DEFAULT":状況に依存します。
"OFF":常にオフです。
"ON":常にオンです。
文字列の負の値:異常時

Type: String

getstateview() → {String}

レイヤの表示状態を取得します。

Returns:

"DEFAULT":状況に依存します。
"OFF":常にオフです。
"ON":常にオンです。
文字列の負の値:異常時

Type: String

getuidisplay() → {Number}

UIのレイヤの一覧への表示有無を取得します。

Returns:

0:非表示
1:表示
負の値:異常時

Type: Number

getversion() → {String}

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

Inherited From:

pdfmakeup#getversion

Returns:

バージョン(文字列)

Type: String

getversionno() → {Number}

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

Inherited From:

pdfmakeup#getversionno

Returns:

バージョン(数値)

Type: Number

setcreator(creator) → {Number}

レイヤの作成者を設定します。

Parameters:

Name	Type	Description
`creator`	String	作成者に設定する文字列

Inherited From:

pmuobjlayer#setcreator

Returns:

Type: Number

Example

// レイヤの作成者を設定します。
// @param {String} creator 作成者に設定する文字列
objlayer.setcreator("作成者１");

setintent(intent) → {Number}

レイヤのIntent属性を設定します。

Parameters:

Name	Type	Description
`intent`	String	以下のIntent属性を指定します。 "VIEW":表示プログラム上で、表示・非表示等の切り替えが可能です。 "DESIGN":表示プログラム上で、表示・非表示等の切り替えが出来ません。

Inherited From:

pmuobjlayer#setintent

Returns:

Type: Number

Example

// レイヤのIntent属性を設定します。
// @param {String} intent Intent属性を指定します。 ⇒ "VIEW":表示プログラム上で、表示・非表示等の切り替えが可能です。
objlayer.setintent("VIEW");

setlock(block) → {Number}

レイヤのロック属性を設定します。

Parameters:

Name	Type	Description
`block`	boolean	ロックの有無

Inherited From:

pmuobjlayer#setlock

Returns:

Type: Number

setname(name) → {Number}

レイヤ名属性を設定します。

Parameters:

Name	Type	Description
`name`	String	レイヤ名に設定する文字列

Inherited From:

pmuobjlayer#setname

Returns:

Type: Number

Example

// レイヤ名属性を設定します。
//@param {String} name レイヤ名に設定する文字列
objlayer.setname("レイヤ１");

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

setstatedefault(state) → {Number}

レイヤのデフォルト状態を設定します。

Parameters:

Name	Type	Description
`state`	String	以下のステート値を指定します。 "OFF":常にオフです。 "ON":常にオンです。

Inherited From:

pmuobjlayer#setstatedefault

Returns:

Type: Number

Example

// レイヤのデフォルト状態を設定します。
// @param {String} state ステート値を指定します。 ⇒ "ON":常にオンです。
objlayer.setstatedefault("ON");

setstateexport(state) → {Number}

レイヤのエクスポート状態を設定します。

Parameters:

Name	Type	Description
`state`	String	以下のステート値を指定します。 "DEFAULT":状況に依存します。 "OFF":常にオフです。 "ON":常にオンです。

Inherited From:

pmuobjlayer#setstateexport

Returns:

Type: Number

Example

// レイヤのエクスポート状態を設定します。
// @param {String} state ステート値を指定します。 ⇒ "DEFAULT":状況に依存します。
objlayer.setstateexport("DEFAULT");

setstateprint(state) → {Number}

レイヤの印刷状態を設定します。

Parameters:

Name	Type	Description
`state`	String	以下のステート値を指定します。 "DEFAULT":状況に依存します。 "OFF":常にオフです。 "ON":常にオンです。

Inherited From:

pmuobjlayer#setstateprint

Returns:

Type: Number

Example

// レイヤの印刷状態を設定します。
// @param {String} state ステート値を指定します。 ⇒ "DEFAULT":状況に依存します。
objlayer.setstateprint("DEFAULT");

setstateview(state) → {Number}

レイヤの表示状態を設定します。

Parameters:

Name	Type	Description
`state`	String	以下のステート値を指定します。 "DEFAULT":状況に依存します。 "OFF":常にオフです。 "ON":常にオンです。

Inherited From:

pmuobjlayer#setstateview

Returns:

Type: Number

Example

// レイヤの表示状態を設定します。
// @param {String} state ステート値を指定します。 ⇒ "DEFAULT":状況に依存します。
objlayer.setstateview("DEFAULT");

setuidisplay(bdisp) → {Number}

UIのレイヤの一覧への表示有無を設定します。

Parameters:

Name	Type	Description
`bdisp`	boolean	表示の有無

Inherited From:

pmuobjlayer#setuidisplay

Returns:

Type: Number

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