renderpanecommand文/関数(Ver9.55対応版)
目次−
レンダリング枠−
renderpanecommand文/関数
renderpanecommand文/関数は、レンダリング枠に対する何らかの操作・取得・設定を文字列で指定します。(V9.22以降)
例 |
renderpanecommand "focus";
|
- パラメータ1(文字列型またはオブジェクト)
-
URIの文字列、コマンドの文字列、JSONの文字列(またはJavaScriptのオブジェクト)のいずれかを指定します。
- 返り値(文字列型)
-
"get"による取得の場合、得られる値を返します。
renderpanecommandは、非同期の関数からでも呼ぶことができます。
コマンドの文字列の場合は以下の通りです。
"get_readyState" 未完了では"loading"、DOM操作まで完了では"interactive"、すべて完了では"complete"が返ります。
"get_DOMContentLoaded" 未完了では"0"、DOM操作まで完了では"1"が返ります。
"get_load" 未完了では"0"、すべて完了では"1"が返ります。
"left" 位置を左にします。
"right" 位置を右にします。
"top" 位置を上にします。
"bottom" 位置を下にします。
"clear" クリアします。
"refresh" 更新します。
"focus" ウィンドウのフォーカスをブラウザ枠に移動します。
//例
setrenderpanetarget "MYRENDER";
renderpanecommand "focus";
endmacro;
//例
js{
setrenderpanetarget( "_each" );
renderpanecommand( "focus" );
}
endmacro;
JSON/オブジェクトの場合のプロパティの意味は以下の通りです。
target: 対象となる枠の名前。英字から始まる任意の文字列を指定します。記述が無い場合は既定の枠が対象。
show: 1を指定すると表示します。0を指定すると、非表示にしてインスタンスが無くなります。(コンテンツが閉じます)
invisible: 見えないようにするかどうか。1で見えない。0で見える。非表示にしてもインスタンスは継続します。
uri: URI。"file:"から始まるローカルファイル、または"javascript:"から始まるスクリプト。(urlでも可)
place: 位置。"leftside" "rightside" "upside" "downside" "overlay"のいずれか。
get: 情報を取得します。target以外の他のプロパティは無視されます。(後述)
clear: 1を指定するとクリアします。
focus: 1を指定するとウィンドウのフォーカスをブラウザ枠に移動します。
size: 上下左右の枠の配置のときのピクセル単位のサイズの数値。
align: オーバーレイ時の水平配置。"left" "center" "right"のいずれか。
valign: オーバーレイ時の垂直配置。"top" "center" "middle" "bottom"のいずれか。
x: オーバーレイ時の左から(右から)のx位置。文字列で"300px"といったピクセル指定、または"50%"といったパーセント指定。
y: オーバーレイ時の上から(下から)のy位置。文字列で"300px"といったピクセル指定、または"50%"といったパーセント指定。
cx: オーバーレイ時の幅。文字列で"300px"といったピクセル指定、または"50%"といったパーセント指定。
cy: オーバーレイ時の高さ。文字列で"300px"といったピクセル指定、または"50%"といったパーセント指定。
initialize: "async"を指定すると初期化を待機せずにすぐに制御を戻します。
//例
renderpanecommand """
{
"target": "MYRENDER",
"show": 1,
}
""";
endmacro;
//例
js{
renderpanecommand({
target: "MYRENDER",
show: 1,
});
}
endmacro;
JSONの/オブジェクトのgetプロパティで関数として呼ばれたときに、取得したい情報を以下の値で指定します。
"readyState" 未完了では"loading"、DOM操作まで完了では"interactive"、すべて完了では"complete"が返ります。
"DOMContentLoaded" 未完了では"0"、DOM操作まで完了では"1"が返ります。
"load" 未完了では"0"、すべて完了では"1"が返ります。
"show" 表示されている場合"1"、非表示の場合インスタンスの有無に関わらず"0"が返ります。
"invisible" 見えない状態の場合"1"、見える状態の場合"0"が返ります。
"uri" URIが返ります。(urlでも可)
"size" 上下左右の枠の配置のときのピクセル単位のサイズが文字列として返ります。
"place" 位置を返します。"leftside" "rightside" "upside" "downside" "overlay"のいずれかです。
"initialized" 初期化が完了していれば"1"、そうでなければ"0"を返します。(initialize: "async"の場合だけに意味がある)
//例
$strUri = renderpanecommand( """
{
"target": "MYRENDER",
"get": "uri",
}
""" );
message $strUri;
endmacro;
//例
js{
strUri = renderpanecommand({
target: "MYRENDER",
get: "uri",
});
message( strUri );
}
endmacro;
サンプルマクロ
ブラウザ枠・個別ブラウザ枠
TypeScript的な定義
declare function renderpanecommand(p1:RENDERPANECOMMANDS|RenderPaneParam):string;//(グローバル展開時)
type RENDERPANECOMMANDS = "get_readyState"
| "get_DOMContentLoaded"
| "get_load"
| "left"
| "right"
| "top"
| "bottom"
| "clear"
| "refresh"
| "focus";
interface RenderPaneParam {
target?:string;
show?:number;
invisible?:number;
uri?:string;
place?:"leftside"|"rightside"|"upside"|"downside";
get?:RENDERPANEGETCOMMANDS;
clear?:number;
focus?:number;
size?:number;
align?:"left"|"center"|"right";
valign?:"top"|"center"|"middle"|"bottom";
x?:string;//"300px" "50%" etc
y?:string;//"300px" "50%" etc
cx?:string;//"300px" "50%" etc
cy?:string;//"300px" "50%" etc
initialize?:"async";
}
type RENDERPANEGETCOMMANDS = "readyState"
| "DOMContentLoaded"
| "load"
| "show"
| "invisible"
| "uri"
| "size"
| "place"
| "initialized";