Constructor
new pmuobjtrans()
インスタンスオブジェクトの作成。
Returns:
生成されたインスタンスオブジェクト
Example
// 透過オブジェクトクラスのインスタンスを生成します。
var objtrans = new pmuobjtrans();
Extends
Members
m_encode
Properties:
Name | Type | Description |
---|---|---|
m_encode |
String | getBytes()などで使用するエンコード文字列です。 文字列を取り扱うメソッドを使用する際は、事前に当メンバへ"MS932"を指定してください。 指定しなかった場合、全角文字にて文字化けが発生し、正常に処理されない可能性があります。 |
- Overrides:
Example
// @property {String} m_encode getBytesなどで使用するエンコード文字列です。
objtrans.m_encode = "MS932";
Methods
bytetostr(bstr) → {String}
バイナリのNumber[]をStringに変換して返します。
アプリケーション側で何らかの事情で エンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
アプリケーション側で何らかの事情で エンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
Parameters:
Name | Type | Description |
---|---|---|
bstr |
Array.<Number> | 変換を行う配列 |
- Inherited From:
Returns:
bstrがヌルの場合は、ヌルを返します。
m_encodeが、ヌルの場合はnew String(bstr)を返します。
m_encodeが、ヌルでない場合はnew String(str,m_encode)を 返します。
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);
createobj(objtype) → {pmuobjformbutton|pmuobjformtext|pmuobjnotebox|pmuobjnotefreetext|pmuobjnotehighlight|pmuobjnotepolygon|pmuobjimage|pmuobjiod|pmuobjlink|pmuobjpage|pmuobjtext|pmuobjtrans|pmuobjwatermark}
オブジェクトクラスを作成します。
Parameters:
Name | Type | Description |
---|---|---|
objtype |
String | 以下のオブジェクトの種類を指定します。 "FORMBUTTON":BUTTONフォームオブジェクト "FORMTEXT":TEXTフォームオブジェクト "NOTEBOX":BOX型注釈オブジェクト "NOTEFREETEXT":FREETEXT型注釈オブジェクト "NOTEHIGHLIGHT":HIGHLIGHT型注釈オブジェクト "NOTEPOLYGON":POLYGON型注釈オブジェクト "IMAGE":イメージ "IOD":IODファイル "LINK":ハイパーリンク "PAGE":旧バージョン互換用ページ番号 "PAGENUMBER":ページ番号 "TEXT":テキスト枠 "TRANS":透過オブジェクト "WATERMARK":ウォーターマーク |
Returns:
オブジェクトクラス
引数objtypeに応じて、以下のクラスを返します。
"FORMBUTTON":pmuobjformbutton
"FORMTEXT":pmuobjformtext
"NOTEBOX":pmuobjnotebox
"NOTEFREETEXT":pmuobjnotefreetext
"NOTEHIGHLIGHT":pmuobjnotehighlight
"NOTEPOLYGON":pmuobjnotepolygon
"IMAGE":pmuobjimage
"IOD":pmuobjiod
"LINK":pmuobjlink
"PAGE":pmuobjpage
"PAGENUMBER":pmuobjpage
"TEXT":pmuobjtext
"TRANS":pmuobjtrans
"WATERMARK":pmuobjwatermark
引数objtypeに応じて、以下のクラスを返します。
"FORMBUTTON":pmuobjformbutton
"FORMTEXT":pmuobjformtext
"NOTEBOX":pmuobjnotebox
"NOTEFREETEXT":pmuobjnotefreetext
"NOTEHIGHLIGHT":pmuobjnotehighlight
"NOTEPOLYGON":pmuobjnotepolygon
"IMAGE":pmuobjimage
"IOD":pmuobjiod
"LINK":pmuobjlink
"PAGE":pmuobjpage
"PAGENUMBER":pmuobjpage
"TEXT":pmuobjtext
"TRANS":pmuobjtrans
"WATERMARK":pmuobjwatermark
- Type
- pmuobjformbutton | pmuobjformtext | pmuobjnotebox | pmuobjnotefreetext | pmuobjnotehighlight | pmuobjnotepolygon | pmuobjimage | pmuobjiod | pmuobjlink | pmuobjpage | pmuobjtext | pmuobjtrans | pmuobjwatermark
Example
// オブジェクトクラスを作成します。
// @param {String} objtype オブジェクトの種類を指定します。 ⇒ "TEXT":テキスト枠
var pobj = objtrans.createobj("TEXT");
createobjimage() → {pmuobjimage}
イメージオブジェクトクラスを作成します。
Returns:
イメージオブジェクトクラス
- Type
- pmuobjimage
createobjiod() → {pmuobjiod}
IODオブジェクトクラスを作成します。
Returns:
IODオブジェクトクラス
- Type
- pmuobjiod
createobjpagenumber() → {pmuobjpage}
ページ番号オブジェクトクラスを作成します。
Returns:
ページ番号オブジェクトクラス
- Type
- pmuobjpage
createobjtext() → {pmuobjtext}
テキスト枠オブジェクトクラスを作成します。
Returns:
テキスト枠オブジェクトクラス
- Type
- pmuobjtext
createobjwatermark() → {pmuobjwatermark}
ウォーターマークオブジェクトクラスを作成します。
Returns:
ウォーターマークオブジェクトクラス
- Type
- pmuobjwatermark
geterror() → {String}
最後のエラーの要因メッセージを返します。
- Inherited From:
Returns:
エラーの要因メッセージ
- Type
- String
geterrorno() → {Number}
最後のエラー要因(数値)を返します。
- Inherited From:
Returns:
エラー要因(数値)
- Type
- Number
getversion() → {String}
バージョン(文字列)を返します。
- Inherited From:
Returns:
バージョン(文字列)
- Type
- String
getversionno() → {Number}
バージョン(数値)を返します。
- Inherited From:
Returns:
バージョン(数値)
- Type
- Number
movepos(x, y) → {Number}
オブジェクトの調整位置を移動します。(現在の位置に加算されます)
Parameters:
Name | Type | Description |
---|---|---|
x |
Number | 水平方向の調整量 |
y |
Number | 垂直方向の調整量 |
- Inherited From:
Returns:
- Type
- Number
release()
一度追加した、追記オブジェクトを削除します。
- Inherited From:
setbasepos(postype) → {Number}
オブジェクトの基本位置を指定します。
Parameters:
Name | Type | Description |
---|---|---|
postype |
String | 以下の追記オブジェクトの基本位置を指定します。 "XY":XYを使用 "LT":左上 "LM":左中段 "LB":左下 "CT":中央上 "CM":中央中段 "CB":中央下 "RT":右上 "RM":右中段 "RB":右下 |
- Inherited From:
Returns:
- Type
- Number
Example
// オブジェクトの基本位置を指定します。
// @param {String} postype 追記オブジェクトの基本位置を指定します。 ⇒ "LT":左上
obj.setbasepos("LT");
setbrushcolor(r, g, b) → {Number}
追記オブジェクトが使用するブラシの色を設定します。
Parameters:
Name | Type | Description |
---|---|---|
r |
Number | 赤値 |
g |
Number | 緑値 |
b |
Number | 青値 |
- Inherited From:
Returns:
- Type
- Number
Example
// 追記オブジェクトが使用するブラシの色を設定します。
// @param {Number} r 赤値
// @param {Number} g 緑値
// @param {Number} b 青値
// 青色を指定
obj.setbrushcolor(0, 0, 255);
setbrushtype(brushtype) → {Number}
追記オブジェクトが使用するブラシの種類を設定します。
pmuobjnotehighlightクラスが対象の場合、"NULL"を指定して呼び出すことは出来ません。
pmuobjnotehighlightクラスが対象の場合、"NULL"を指定して呼び出すことは出来ません。
Parameters:
Name | Type | Description |
---|---|---|
brushtype |
String | 以下のブラシの種類を設定します。 "NULL":ブラシの種類を設定しない "COLOR":色付き |
- Inherited From:
- See:
Returns:
- Type
- Number
Example
// 追記オブジェクトが使用するブラシの種類を設定します。
// ハイライト注釈オブジェクトが対象の場合、"NULL"を指定して呼び出すことは出来ません。
// @param {String} brushtype ブラシの種類を設定します。 ⇒ "COLOR":色付き
obj.setbrushtype("COLOR");
setfont(font) → {Number}
追記オブジェクトが使用するフォントを設定します。
Parameters:
Name | Type | Description |
---|---|---|
font |
String | フォント名 |
- Inherited From:
Returns:
- Type
- Number
Example
// 追記オブジェクトが使用するフォントを設定します。
// @param {String} font フォント名 ⇒ MS 明朝を指定
obj.setfont("MS 明朝");
setfontbold(bbold) → {Number}
追記オブジェクトが使用するフォントを強調に設定します。
Parameters:
Name | Type | Description |
---|---|---|
bbold |
boolean | 強調のON/OFF |
- Inherited From:
Returns:
- Type
- Number
setfontcolor(r, g, b) → {Number}
追記オブジェクトが使用するフォントの色をRGBで設定します。
Parameters:
Name | Type | Description |
---|---|---|
r |
Number | 赤値 |
g |
Number | 緑値 |
b |
Number | 青値 |
- Inherited From:
Returns:
- Type
- Number
Example
// 追記オブジェクトが使用するフォントの色をRGBで設定します。
// @param {Number} r 赤値
// @param {Number} g 緑値
// @param {Number} b 青値
// 赤色を指定
obj.setfontcolor(255, 0, 0);
setfontitalic(bitalic) → {Number}
追記オブジェクトが使用するフォントを斜体に設定します。
Parameters:
Name | Type | Description |
---|---|---|
bitalic |
boolean | 斜体のON/OFF |
- Inherited From:
Returns:
- Type
- Number
setfontrotate(rotate) → {Number}
追記オブジェクトが使用するフォントの回転角度を設定します。
Parameters:
Name | Type | Description |
---|---|---|
rotate |
Number | 角度(通常は0) |
- Inherited From:
Returns:
- Type
- Number
setfontscale(scale) → {Number}
追記オブジェクトが使用するフォントの幅をパーセントで設定します。
Parameters:
Name | Type | Description |
---|---|---|
scale |
Number | 幅(通常は100%) |
- Inherited From:
Returns:
- Type
- Number
setfontsize(fontsize) → {Number}
追記オブジェクトが使用するフォントのサイズを設定します。
Parameters:
Name | Type | Description |
---|---|---|
fontsize |
Number | フォントのサイズ |
- Inherited From:
Returns:
- Type
- Number
setfonttransparent(btransparent) → {Number}
追記オブジェクトが使用するフォントを透明に設定します。
Parameters:
Name | Type | Description |
---|---|---|
btransparent |
boolean | trueであれば透明に設定 |
- Inherited From:
Returns:
- Type
- Number
setlayer(layertype) → {Number}
追記オブジェクトをオリジナルPDFの上または下のどちらに追記するかを設定します。
Parameters:
Name | Type | Description |
---|---|---|
layertype |
String | 以下の追記位置を設定します。 "FRONT":追記オブジェクトをオリジナルの上(前面)に配置 "BACK":追記オブジェクトをオリジナルの下(背面)に配置 |
- Inherited From:
Returns:
- Type
- Number
Example
// 追記オブジェクトをオリジナルPDFの上または下のどちらに追記するかを設定します。
// @param {String} layertype 追記位置を設定します。 ⇒ "FRONT":追記オブジェクトをオリジナルの上(前面)に配置
obj.setlayer("FRONT");
setmode(transmode) → {Number}
透過モードを設定します。
Parameters:
Name | Type | Description |
---|---|---|
transmode |
String | 以下の透過のモードを指定します。 "SRC":描画色をそのまま透過描画色として使用します。 "MULTIPLY":描画色と背景色とを乗算した値を透過描画色として使用します。 描画色と背景色のどちらかが黒の場合は透過描画色も必ず黒になります。 |
Returns:
- Type
- Number
Example
// 透過モードを設定します。
// @param {String} transmode 透過のモードを指定します。 ⇒ "SRC":描画色をそのまま透過描画色として使用します。
objtrans.setmode("SRC");
setoptionvalue(optiontype, optionvalue) → {Number}
各種オプションを設定します。
Parameters:
Name | Type | Description |
---|---|---|
optiontype |
String | オプションの種類を表す文字列 "PORTFOLIOERROR":ポートフォリオファイルをエラーにする "XFAFORMERROR":XFA Formファイルをエラーにする "PAGETREEVALIDATE":ページツリーの整合性をチェックする |
optionvalue |
Number |
- Inherited From:
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:
Returns:
- Type
- Number
setpencolor(r, g, b) → {Number}
追記オブジェクトが使用するペンの色を設定します。
Parameters:
Name | Type | Description |
---|---|---|
r |
Number | 赤値 |
g |
Number | 緑値 |
b |
Number | 青値 |
- Inherited From:
Returns:
- Type
- Number
Example
// 追記オブジェクトが使用するペンの色を設定します。
// @param {Number} r 赤値
// @param {Number} g 緑値
// @param {Number} b 青値
// 緑色を指定
obj.setpencolor(0, 255, 0);
setpentype(brushtype) → {Number}
追記オブジェクトが使用するペンの種類を設定します。
Parameters:
Name | Type | Description |
---|---|---|
brushtype |
String | 以下のペンの種類を設定します。 "NULL":ブラシの種類を設定しない "DASH":鎖線 "DASHDOT":一点鎖線 "DASHDOTDOT":二点鎖線 "DOT":破線 "SOLID":実線 |
- Inherited From:
Returns:
- Type
- Number
Example
// 追記オブジェクトが使用するペンの種類を設定します。
// @param {String} brushtype ペンの種類を設定します。 ⇒ "DASHDOT":一点鎖線
obj.setpentype("DASHDOT");
setpenwidth(penwidth) → {Number}
追記オブジェクトが使用するペンの線幅を設定します。
Parameters:
Name | Type | Description |
---|---|---|
penwidth |
Number | ペンの線幅 |
- Inherited From:
Returns:
- Type
- Number
setpos(x, y) → {Number}
オブジェクトの調整位置を設定します。
Parameters:
Name | Type | Description |
---|---|---|
x |
Number | 水平方向の調整量 |
y |
Number | 垂直方向の調整量 |
- Inherited From:
Returns:
- Type
- Number
settargetpage(pagetype, pageno1, pageno2) → {Number}
追記オブジェクトをどのページに追記するかを設定します。
ページ番号を指定する際は、1ページ目を「1」として指定してください。
ページ番号を指定する際は、1ページ目を「1」として指定してください。
Parameters:
Name | Type | Description |
---|---|---|
pagetype |
String | 以下のページ指定の種類を指定します。 "ALL":全てのページ "FROM":指定ページ以降 "FROMTO":範囲指定 "PAGE":特定のページ "TO":指定ページまで |
pageno1 |
Number | ページ番号1 |
pageno2 |
Number | ページ番号2(FROMTOの場合のみ使用) |
- Inherited From:
Returns:
- Type
- Number
Examples
// 追記オブジェクトをどのページに追記するかを設定します。
// @param {String} pagetype ページ指定の種類を指定します。 ⇒ "FROMTO":範囲指定
// @param {Number} pageno1 ページ番号1 ⇒ "FROMTO":1ページから
// @param {Number} pageno2 ページ番号2(FROMTOの場合のみ使用) ⇒ "FROMTO":3ページまで
obj.settargetpage("FROMTO", 1, 3);
// 追記オブジェクトをどのページに追記するかを設定します。
// @param {String} pagetype ページ指定の種類を指定します。 ⇒ "PAGE":特定のページ
// @param {Number} pageno1 ページ番号1 ⇒ "PAGE":5ページ
// @param {Number} pageno2 ページ番号2(FROMTOの場合のみ使用) ⇒ "FROMTO"ではないため、0を指定
obj.settargetpage("FROMTO", 5, 0);
settransparency(transparency) → {Number}
透過オブジェクトの透明度を設定します。
Parameters:
Name | Type | Description |
---|---|---|
transparency |
Number | 透過度(0:透明~100:非透過) |
Returns:
- Type
- Number
strtobyte(bstr) → {Array.<Number>}
StringをバイナリとしてNumber[]に変換して返します。
アプリケーション側で何らかの事情で エンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
アプリケーション側で何らかの事情で エンコードを変更したい場合にオーバーライドできます。
使用する際はフィールド"m_encode"へエンコード文字列を設定してください。
Parameters:
Name | Type | Description |
---|---|---|
bstr |
String | 変換を行う文字列 |
- Inherited From:
Returns:
strがヌルの場合は、ヌルを返します。
m_encodeが、ヌルの場合はstr.getBytes()を返します。
m_encodeが、ヌルでない場合はstr.getBytes(m_encode)を 返します。
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");