1.3.2 部品コントロールクラス

名称

EJ_Control

解説

本クラスは、JSVR文字入力部品をWebページ上で動作させるためのクラスです。本クラスのメンバを使い、部品の書き出しや、書き出し済の部品へのアクセスなどを行います。

メソッド

名称	機能
EJ_Control()	部品コントロールクラスを構築する (コンストラクタ)
writeEJInput()	部品を書き出す
writeEJInputWithParam()	部品を書き出す
copyDefaultPropertyStruct()	現在のWebページにおけるJSVR文字入力部品のデフォルトプロパティ構造体のコピーを取得する
copyPropertyStruct()	指定IDの部品が保持しているプロパティ構造体のコピーを取得する
copyPropertyStructByName()	指定サブミット名の部品が保持しているプロパティ構造体のコピーを取得する
setPropertyStruct()	指定IDの部品が保持しているプロパティ構造体を変更する
setPropertyStructByName()	指定サブミット名の部品が保持しているプロパティ構造体を変更する
getSubmitValue()	指定IDの部品が保持しているサブミット値を取得する
getSubmitValueByName()	指定サブミット名の部品が保持しているサブミット値を取得する
getTextLength()	指定IDの部品の表示文字列長を取得する
getTextLengthByName()	指定サブミット名の部品の表示文字列長を取得する
changeText()	指定IDの部品の表示文字列を変更する
changeTextByName()	指定サブミット名の部品の表示文字列を変更する
resetText()	指定IDの部品の表示文字列をリセットする
resetTextByName()	指定サブミット名の部品の表示文字列をリセットする
changeDspState()	指定IDの部品の表示状態を変更する
changeDspStateByName()	指定サブミット名の部品の表示状態を変更する
focusEJInput()	指定IDの部品をフォーカスする
focusEJInputByName()	指定サブミット名の部品をフォーカスする
syncSubmitValue	指定IDの部品の表示文字イメージとサブミット値を一致させる
syncSubmitValueByName	指定サブミット名の部品の表示文字イメージとサブミット値を一致させる

プロパティ

すべて非公開

1.3.2.1 EJ_Control()

解説

部品コントロールクラスのオブジェクトを構築します。

構文

EJ_Control(blnEditable, strCharsetName, strSubmitName, intTabindex, strDefaultText, strSearchId,
           intInputFontSize, intListFontSize, intListCount, intMaxTextLength, blnGrid,
           strDetailedStyle, strTextForeColor, strClassOnFocus, strClassOnBlur, strClassDisable,
           funcEventCallBack)

引数の解説

すべてのパラメータは、このWebページにおけるJSVR文字入力部品のデフォルト値を定義したプロパティ構造体に保存されます。各パラメータについて詳しくは、「1.3.3 プロパティ構造体」の各プロパティを参照してください。

なお、各パラメータのデフォルト値は次のとおりです。

パラメータ名	デフォルト値
blnEditable	true
strCharsetName	"EJ_SJIS"
strSubmitName	""
intTabindex	0
strDefaultText	""
strSearchId	"20"
intInputFontSize	24
intListFontSize	24
intListCount	20
intMaxTextLength	50
blnGrid	false
strDetailedStyle	""
strTextForeColor	""
strClassOnFocus	"" (内部定義クラスを使用)
strClassOnBlur	"" (内部定義クラスを使用)
strClassDisable	"" (内部定義クラスを使用)
funcEventCallBack	null

復帰値

構築された部品コントロールクラスのインスタンス

用例

var objEJC = new EJ_Control(true, "EJ_SJIS", "", 0, "", "20", 16, 24, 10, 15, false,
                            "", "", "", "", "", "", "");

1.3.2.2 writeEJInput()

解説

JSVR文字入力部品を書き出します。

書き出す部品の属性(文字のサイズや変換動作など)は、引数のプロパティ構造体によって決められます。

注意

プロパティ構造体は、ユーザが独自にクリエイトするのではなく、copyDefaultPropertyStruct()メソッドにて取得したものを使用してください。

構文

instance.writeEJInput(pstructProperty)

引数の解説

名称	型	解説
pstructProperty	EJ_PropertyStruct	部品の動作を定義したプロパティ構造体。各プロパティに関しては、「1.3.3 プロパティ構造体」を参照してください。

復帰値

型	解説
数値(整数)	書き出した部品のID

用例

var objEJC = new EJ_Control(true, "EJ_SJIS", "", 0, "", "20", 16, 24, 10, 15, false,
                            "", "", "", "", "", "", "");
// デフォルト構造体を取得
var struct = objEJC.copyDefaultPropertyStruct();
// フォントサイズ設定
struct.intInputFontSize = 36;
// 部品の書き出し
var intID = objEJC.writeEJInput(struct);

1.3.2.3 writeEJInputWithParam()

解説

JSVR文字入力部品を書き出します。

書き出す部品の属性(文字のサイズや変換動作など)は、引数によって決められます。

構文

instance.writeEJInputWithParam(blnEditable, strCharsetName, strSubmitName, intTabindex,
                               strDefaultText, strSearchId, intInputFontSize, intListFontSize,
                               intListCount, intMaxTextLength, blnGrid, strDetailedStyle,
                               strTextForeColor, strClassOnFocus, strClassOnBlur,
                               strClassDisable, funcEventCallBack)

引数の解説

各パラメータについて詳しくは、「1.3.3 プロパティ構造体」を参照してください。

復帰値

型	解説
数値(整数)	書き出した部品のID

用例

var objEJC = new EJ_Control(true, "EJ_SJIS", "", 0, "", "20", 16, 24, 10, 15, false,
                            "", "", "", "", "", "", "");
// 部品の書き出し
var intID = objEJC.writeEJInputWithParam(true, "EJ_SJIS", "adr1", 0, "住所", "20",16, 24, 10,
                                          15, false, "", "", "", "", "", "", "");

1.3.2.4 copyDefaultPropertyStruct()

解説

現在のWebページにおけるJSVR文字入力部品のデフォルト値を定義したプロパティ構造体のコピーを取得します。

本構造体は、本クラスのコンストラクタによって作られます。

構文

instance.copyDefaultPropertyStruct( )

引数の解説

なし

復帰値

型	解説
EJ_PropertyStruct	現在のWebページにおけるJSVR文字入力部品のデフォルトプロパティ構造体のコピー

用例

var objEJC = new EJ_Control(true, "EJ_SJIS", "", 0, "", "20", 16, 24, 10, 15, false,
                            "", "", "", "", "", "", "");
var struct = objEJC.copyDefaultPropertyStruct();

1.3.2.5 copyPropertyStruct()

解説

指定した部品が保持しているプロパティ構造体のコピーを取得します。

構文

instance.copyPropertyStruct(pintIndex)

引数の解説

名称	型	解説
pintIndex	数値(整数)	部品ID

復帰値

型	解説
EJ_PropertyStruct	指定した部品のプロパティ構造体のコピー

用例

var struct = objEJC.copyPropertyStruct(intID);

1.3.2.6 copyPropertyStructByName()

解説

指定した部品が保持しているプロパティ構造体のコピーを取得します。

構文

instance.copyPropertyStructByName(pstrName)

引数の解説

名称	型	解説
pstrName	文字列	部品のサブミット名

復帰値

型	解説
EJ_PropertyStruct	指定した部品のプロパティ構造体のコピー

用例

var struct = objEJC.copyPropertyStructByName(strName);

1.3.2.7 setPropertyStruct()

解説

指定した部品のプロパティ構造体を変更します。

注意

次のプロパティの値は変更しないでください。

構文

instance.setPropertyStruct(pintIndex, pstructProperty)

引数の解説

名称	型	解説
pintIndex	数値(整数)	部品ID
pstructProperty	EJ_PropertyStruct	置き換えるプロパティ構造体

復帰値

なし

用例

// 指定部品のプロパティ構造体を取得
var struct = objEJC.copyPropertyStruct(intID);
// フォントサイズの設定
struct.intInputFontSize = 36;
// 新しい構造体を指定した部品IDの部品に適用
objEJC.setPropertyStruct(intID, struct);

1.3.2.8 setPropertyStructByName()

解説

指定した部品のプロパティ構造体を変更します。

注意

次のプロパティの値は変更しないでください。

構文

instance.setPropertyStructByName(pstrName, pstructProperty)

引数の解説

名称	型	解説
pstrName	文字列	サブミット名
pstructProperty	EJ_PropertyStruct	置き換えるプロパティ構造体

復帰値

なし

用例

// 指定部品のプロパティ構造体を取得
var struct = objEJC.copyPropertyStructByName(strName);
// フォントサイズの設定
struct.intInputFontSize = 36;
// 新しい構造体を指定した部品IDの部品に適用
objEJC.setPropertyStructByName(strName,struct);

1.3.2.9 getSubmitValue()

解説

指定した部品が保持しているサブミット値を取得します。

構文

instance.getSubmitValue(pintIndex)

引数の解説

名称	型	解説
pintIndex	数値(整数)	部品ID

復帰値

型	解説
文字列	指定した部品のサブミット値

用例

var strValue = objEJC.getSubmitValue(intID);

1.3.2.10 getSubmitValueByName()

解説

指定した部品が保持しているサブミット値を取得します。

構文

instance.getSubmitValueByName(pstrName)

引数の解説

名称	型	解説
pstrName	文字列	部品のサブミット名

復帰値

型	解説
文字列	指定した部品のサブミット値

用例

var strValue = objEJC.getSubmitValueByName(strName);

1.3.2.11 getTextLength()

解説

指定した部品に表示されている文字列の長さを取得します。

構文

instance.getTextLength(pintIndex)

引数の解説

名称	型	解説
pintIndex	数値(整数)	部品ID

復帰値

型	解説
数値(整数)	指定した部品に表示されている文字列の長さ

用例

var intTextLength = objEJC.getTextLength(intID);

1.3.2.12 getTextLengthByName()

解説

指定した部品に表示されている文字列の長さを取得します。

構文

instance.getTextLengthByName(pstrName)

引数の解説

名称	型	解説
pstrName	文字列	部品のサブミット名

復帰値

型	解説
数値(整数)	指定した部品に表示されている文字列の長さ

用例

var intTextLength = objEJC.getTextLengthByName(strName);

1.3.2.13 changeText()

解説

指定した部品の表示文字列を変更します。

構文

instance.changeText(pintIndex, pstrText)

引数の解説

名称	型	解説
pintIndex	数値(整数)	部品ID
pstrText	文字列	変更後の表示文字列

復帰値

なし

用例

objEJC.changeText(intID, "あいうえお");

1.3.2.14 changeTextByName()

解説

指定した部品の表示文字列を変更します。

構文

instance.changeTextByName(pstrName, pstrText)

引数の解説

名称	型	解説
pstrName	文字列	部品のサブミット名
pstrText	文字列	変更後の表示文字列

復帰値

なし

用例

objEJC.changeTextByName(strName, "あいうえお");

1.3.2.15 resetText()

解説

指定した部品の表示文字列をリセットします。

構文

instance.resetText(pintIndex)

引数の解説

名称	型	解説
pintIndex	数値(整数)	部品ID

復帰値

なし

用例

objEJC.resetText(intID);

1.3.2.16 resetTextByName()

解説

指定した部品の表示文字列をリセットします。

構文

instance.resetTextByName(pstrName)

引数の解説

名称	型	解説
pstrName	文字列	部品のサブミット名

復帰値

なし

用例

objEJC.resetTextByName(strName);

1.3.2.17 changeDspState()

解説

指定した部品の表示状態を変更します。

構文

instance.changeDspState(pintIndex, pstrState)

引数の解説

名称

型

解説

pintIndex

数値(整数)

部品ID

pstrState

文字列

表示状態を、次のリテラルから指定する。

"DSP": style.display = "" & style.visibility = "visible" に準拠

"NONE": style.display = "none" & style.visibility = "visible" に準拠

"HIDDEN": style.display = "" & style.visibility = "hidden" に準拠

復帰値

なし

用例

objEJC.changeDspState(intID, "HIDDEN");

1.3.2.18 changeDspStateByName()

解説

指定した部品の表示状態を変更します。

構文

instance.changeDspStateByName(pstrName, pstrState)

引数の解説

名称

型

解説

pstrName

文字列

部品のサブミット名

pstrState

文字列

表示状態を、次のリテラルから指定する。

"DSP": style.display = "" & style.visibility = "visible" に準拠

"NONE": style.display = "none" & style.visibility = "visible" に準拠

"HIDDEN": style.display = "" & style.visibility = "hidden" に準拠

復帰値

なし

用例

objEJC.changeDspStateByName(strName, "HIDDEN");

1.3.2.19 focusEJInput()

解説

指定した部品をフォーカスします。

構文

instance.focusEJInput(pintIndex)

引数の解説

名称	型	解説
pintIndex	数値(整数)	部品ID

復帰値

なし

用例

objEJC.focusEJInput(intID);

1.3.2.20 focusEJInputByName()

解説

指定した部品をフォーカスします。

構文

instance.focusEJInputByName(pstrName)

引数の解説

名称	型	解説
pstrName	文字列	部品のサブミット名

復帰値

なし

用例

objEJC.focusEJInputByName(strName);

1.3.2.21 syncSubmitValue()

解説

指定した部品に表示中の文字イメージと、その部品が保持しているサブミット値を一致させます。

構文

instance.syncSubmitValue(pintIndex)

引数の解説

名称	型	解説
pintIndex	数値(整数)	部品ID

復帰値

なし

用例

objEJC.syncSubmitValue(intID);

参考

本APIには、部品IDを指定する必要があります。しかし、本APIを呼びたいタイミングでは、フォーカス中のJSVR部品がわからないこともあります。その場合は、JSVR部品のコールバック関数(funcEventCallBack)の中で本APIを呼ぶと便利です。

例)
[F6]キーでSubmitする場合、かつ、コールバック関数を部品コントロールクラスのコンストラクタでまとめて定義する場合

...
<script language="JavaScript">
<!--
function catchEvent(pstrEventType, pintIndex, pevent)
{
    if(("keydown"==pstrEventType) && (117==pevent.keyCode))
        objEJC.syncSubmitValue(pintIndex);
}
var objEJC = new EJ_Control(..., catchEvent);
//-->
</script>
...

1.3.2.22 syncSubmitValueByName()

解説

指定した部品に表示中の文字イメージと、その部品が保持しているサブミット値を一致させます。

構文

instance.syncSubmitValueByName(pstrName)

引数の解説

名称	型	解説
pstrName	文字列	部品のサブミット名

復帰値

なし

用例

objEJC.syncSubmitValueByName(strName);

参考

syncSubmitValue()の「参考」も参照してください。