31.5 WsmgrWindowリファレンス

エミュレータ画面上にユーザが作成したHTMLページを表示するための設定を行うためのオブジェクトです。ユーザHTMLを表示するには、viewオブジェクトのloadメソッドに指定する必要があります。

注意

本オブジェクトは、エミュレータと同一ウィンドウで利用してください。

■WsmgrWindow

エミュレータ画面上にユーザHTMLを表示するための情報を設定します。

●オブジェクト生成方法

new WsmgrWindow(url)

●パラメータ

パラメータ	説明	省略時の初期値
Url	ユーザHTMLのURLを指定絶対パス指定以外の場合、サーバのuserconfigフォルダ配下を参照します。	省略できません

●リターン値

関数呼び出しに成功するとWsmgrWindowオブジェクトを返します。エラーの場合は、例外をスローします。

●JavaScriptを用いて記述した例

var userScreen = null;
try {
    userScreen = new WsmgrWindow("user.htm");
} catch(e) {
    // エラー発生時の処理
}

●メソッド一覧

メソッド名	機能
bind	イベント発生時に呼び出すコールバック関数を登録
getWindow	表示されているウィンドウのwindowオブジェクトを取得
setPosition	ユーザHTMLの表示設定
setSize	ユーザHTMLの表示サイズを指定
setStyle	ユーザHTMLの表示スタイルを指定
setTitle	ユーザHTMLのウィンドウタイトル設定

■bind

イベント発生時に呼び出すコールバック関数を登録

ウィンドウで指定したイベントが発生した際に呼び出されるコールバック関数を登録します。

●呼び出し形式

bind(type, func)

●パラメータ

パラメータ	説明	省略時の初期値
type	コールバック関数を登録するイベント名を示す文字列 'load':ユーザHTMLのロード完了時	省略できません
func	コールバック関数を指定 typeで指定したイベントに登録された関数を解除する場合はnullを指定	null

パラメータ

説明

省略時の初期値

type

コールバック関数を登録するイベント名を示す文字列

'load':ユーザHTMLのロード完了時

省略できません

func

コールバック関数を指定

typeで指定したイベントに登録された関数を解除する場合はnullを指定

null

●リターン値

関数呼び出しが成功するとtrueを返します。エラーの場合はfalseを返します。

●JavaScriptを用いて記述した例

var userScreen = new WsmgrWindow("user.htm");
userScreen.bind('load', onLoad);

■getWindow

表示されているウィンドウのwindowオブジェクトを取得

メソッド呼び出し時に表示されているユーザHTMLのwindowオブジェクトを取得します。
取得したwindowオブジェクトからdocumentオブジェクトを取得することでユーザHMTLのすべてのHTML要素へアクセスすることが可能となります。

●呼び出し形式

getWindow()

●パラメータ

ありません

●リターン値

関数呼び出しが成功するとユーザHTMLのwindowオブジェクトを返します。ユーザHTMLが表示されていない場合や、エラーが発生した場合はnullを返します。

●JavaScriptを用いて記述した例

var userScreen = new WsmgrWindow("user.htm");
userScreen.bind('load', function (e) {
  var userHtmlWindow = userScreen.getWindow();
};
dspemu.view.load(userScreen);

■setPosition

ユーザHTMLの表示位置設定

ユーザHTMLの表示位置を指定します。

●呼び出し形式

setPosition(top, left, width, height)

●パラメータ

パラメータ	説明	省略時の初期値
top	ウィンドウの左上位置のエミュレータの「行」を指定(1～24)	ウィンドウを中央に表示します
left	ウィンドウの左上位置のエミュレータの「桁」を指定(1～80)	ウィンドウを中央に表示します
width	ウィンドウの幅を「文字」単位で指定(1～)	ウィンドウの幅を変更しません
height	ウィンドウの高さを「文字」単位で指定(1～)	ウィンドウの高さを変更しません

参考

本設定はユーザHTMLの表示スタイルがfloatの場合のみ有効です。表示位置、幅を設定しなかった場合はウィンドウを中央に表示し、幅を自動調整します。

●リターン値

関数呼び出しが成功するとtrueを返します。エラーの場合はfalseを返します。

●JavaScriptを用いて記述した例

var userScreen = new WsmgrWindow("user.htm");
userScreen.setPosition(1, 1, 10, 10);

■setSize

ユーザHTMLの表示サイズを指定

ユーザHTMLの表示サイズを指定します。

●呼び出し形式

setSize(width, height)

●パラメータ

パラメータ	説明	省略時の初期値
width	ウィンドウの幅を「文字」単位で指定(1～)	省略できません
height	ウィンドウの高さを「文字」単位で指定(1～)	省略できません

参考

本設定はユーザHTMLの表示スタイルがfloatの場合のみ有効です。表示サイズの指定を行わなかった場合は自動調整されます。

●リターン値

関数呼び出しが成功するとtrueを返します。エラーの場合はfalseを返します。

●JavaScriptを用いて記述した例

var userScreen = new WsmgrWindow("user.htm");
userScreen.setWidth(10, 10);

■setStyle

ユーザHTMLの表示スタイル指定

ユーザHTMLの表示スタイルを指定します。

●呼び出し形式

setStyle(style[, option])

●パラメータ

パラメータ	説明		省略時の初期値
Style	ユーザHTMLの表示スタイルを文字列で指定		省略できません
	"screen"	エミュレータ画面を非表示にしユーザHTMLを最大化して表示
	"emulator"	エミュレータ画面のホスト画面表示部にユーザHTMLを表示
	"float"	エミュレータ画面上にユーザHTMLを重ねて表示
	"emulator"、"float"を指定する場合はエミュレータのホスト画面サイズに収まるようにユーザHTMLを作成してください
option	floatスタイル時の表示オプションをオブジェクトで指定指定可能なオプションは表示オプションを参照		初期値

●表示オプション一覧

オプション	設定値
title	タイトルバーの表示/非表示を設定 true:タイトルバー表示(初期値) false:タイトルバー非表示
close	クローズボタンの表示/非表示を設定 true:クローズボタン表示(初期値) false:クローズボタン非表示 ※タイトルバーが表示されている場合のみ有効
changeStyle	表示スタイルの切り替えボタンの表示/非表示を設定 true:切り替えボタン表示 false:切り替えボタン非表示(初期値) ※タイトルバーが表示されている場合のみ有効切り替えボタンはfloatスタイル、screenスタイルの切り替えが可能です

オプション

設定値

title

タイトルバーの表示/非表示を設定
true:タイトルバー表示(初期値)
false:タイトルバー非表示

クローズボタンの表示/非表示を設定
true:クローズボタン表示(初期値)
false:クローズボタン非表示

※タイトルバーが表示されている場合のみ有効

changeStyle

表示スタイルの切り替えボタンの表示/非表示を設定
true:切り替えボタン表示
false:切り替えボタン非表示(初期値)

※タイトルバーが表示されている場合のみ有効

切り替えボタンはfloatスタイル、screenスタイルの切り替えが可能です

●リターン値

関数呼び出しに成功するとtrueを返します。エラーの場合はfalseを返します。

●JavaScriptを用いて記述した例

var userScreen = new WsmgrWindow("user.htm");
var floatOption = {
  title: true,        // タイトルバーの表示
  changeStyle: true   // スタイル切替ボタンの表示
};
userScreen.setStyle('float', floatOption); 
dspemu.view.load(userScreen);

■setTitle

ユーザHTMLのウィンドウタイトル設定

ユーザHTMLのウィンドウタイトルを設定します。

●呼び出し形式

setTitle(titleName)

●パラメータ

パラメータ	説明	省略時の初期値
titleName	ウィンドウタイトルを文字列で指定	空文字("")

参考

本設定はユーザHTMLの表示スタイルがfloatの場合のみ有効です。

●リターン値

関数呼び出しが成功するとtrueを返します。エラーの場合はfalseを返します。

●JavaScriptを用いて記述した例

var userScreen = new WsmgrWindow("user.htm");
userScreen.setTitle("業務メニュー");