第 8 章 JSVRAX のリファレンス
8.3 Environment HTC
本HTCは、JSVRAXの動作環境を構築/管理する、ビューのないHTCです。
8.3.1 機能と GUI
本HTCの機能は「JSVRAXの動作環境構築」です。
◆JSVRAX の動作環境構築
本HTCは、JSVRAXの動作環境を構築します。
具体的には、ターゲットWebページのwindow/documentに対し、以下の処理を行います。
・ document.parentWindowに対し、JSVRAXのライブラリをロードする。ライブラリの接頭辞は「JSVRAX」である。
・ JSVRAXのスタイルシートやDOMエレメント、イベントハンドラを割り当てる。
注意
・ JSVRAXのあらゆる機能に先んじて、ターゲットWebページに対し1回だけ、本HTCを追加する必要があります。
・ 本HTCが準備する上記リソースに対し、不正アクセスしてはいけません。
8.3.2 API
本HTCはエレメントビヘイビアであり、一般的なエレメントビヘイビアの機能に本HTCの独自実装を加えたものが、本HTCの全機能 となります。ここでは、本HTCの独自実装についてのみ説明します。
参考
「エレメントビヘイビア」とは、HTCをHTMLのカスタムエレメントとして扱えるInternet Explorerの技術で、idプロパティやsetAttribute() メソッドなど、DOMエレメントの基本的なインタフェースを持っています。
利用可能/不可能なインタフェースなどについて詳細は「8.11 エレメントビヘイビアのインタフェースについて」を参照してください。
注意
・ 本HTCの拡張プロパティを途中で変更しないでください。
・ 本HTCを動的に削除しないでください。
8.3.2.1 実装モジュールの URL
/%JSVRAX_PATH%/Environment.htc
8.3.2.2 HTC 情報
◆namespace
JSVRAX
注意
・ タグおよびJSVRAXが拡張実装するプロパティ/イベントに付加してください。
・ 変更してはいけません。
◆name
jsvrax_environment
注意
通常は不要です。使い方については、Internet ExplorerのHTCに関するドキュメントを参照してください。
◆urn
http://jsvr.fujitsu.com/client/jsvrax/environment
注意
通常は不要です。使い方については、Internet ExplorerのHTCに関するドキュメントを参照してください。
◆tagName
environment
◆コンテンツ
なし8.3.2.3 拡張プロパティ
◆rootURL
JSVRAXのルートURLを設定/返却します。
シンタックス
HTMLの場合
<ELEMENT JSVRAX:rootURL="_url"... >
Scriptの場合
element.setAttribute("JSVRAX:rootURL", _url) 上記のような一般的なDOMアクセス
パラメータ _url
型 string型
正常値 利用者のWebページから見たJSVRAXのWebアプリケーションのURL デフォルト /JSVRAX/
判定/補正 実行時/なし
◆WSRootURL
JSVR-CSVサービスのルートURLを設定/返却します。
シンタックス
HTMLの場合
<ELEMENT JSVRAX:WSRootURL="_url"... >
Scriptの場合
element.setAttribute("JSVRAX:WSRootURL", _url) 上記のような一般的なDOMアクセス
パラメータ _url
型 string型
正常値 利用者のWebページから見たJSVR-CSVサービスのURL デフォルト /jsvr_csv/csv/
判定/補正 実行時/なし
8.3.2.4 拡張メソッド
なし。
8.3.2.5 拡張イベント
◆onbeforenotify
JSVRAXの各通知処理の前に発生します。
シンタックス
HTMLの場合
<ELEMENT JSVRAX:onbeforenotify="handler"...>
Scriptの場合
element.setAttribute("JSVRAX:onbeforenotify", handler) 上記のような一般的なDOMアクセス
event情報
キャンセラブル Yes
デフォルト処理 JSVRAXのデフォルトの通知を行う。種別によって通知方法は異なる。
詳細は「8.12 通知情報」を参照のこと。
event属性 srcUrn
説明 一般属性。本HTCのURN。 returnValue
説明 一般属性
型 boolean型
jsvrax_targetElement
説明 独自属性
型 エレメントオブジェクト型
正常値 情報通知時にターゲットとなっていた入力部品エレメント。特定できない場合はnull。
jsvrax_id
説明 独自属性
型 string型
正常値 ID。詳細は「8.12 通知情報」を参照のこと。
jsvrax_type
説明 独自属性
型 string型
正常値 情報の場合は"INF"、警告の場合は"WRN"、エラーの場合は"ERR"。 jsvrax_message
説明 独自属性
型 string型
正常値 エラーの説明メッセージ。詳細は「8.12 通知情報」を参照のこと。
注意
プログラム等で通知を特定する場合は、jsvrax_idを使用し、jsvrax_messageは使用しないでください。
8.3.2.6 拡張スタイル
なし。
8.3.2.7 使用例
<HTML xmlns:JSVRAX> 1.
<HEAD>
<?IMPORT namespace="JSVRAX" implementation="/JSVRAX/Environment.htc" > 2.
<JSVRAX:environment /> 3.
...
1. 「JSVRAX」というnamespaceを宣言。
2. 宣言したnamespaceに実装モジュールをインポート。
3. namespace付きで本HTCをWebページに追加。