UJML タグ

UJMLでは言語の構造と宣言を司るXMLタグを提供しています。

UJML言語はXMLタグと手続き型のスクリプティング言語から構成されています。関連項目： UJML ファイルのレイアウト。 XMLタグの一部は、言語の構造的な要素を提供しています。関連項目： UJMLファイルの種類。その他のXMLタグは変数、ステート変数、ステートトランジション、ビジュアル・オーディオ要素、そしてイベントといった、本言語における宣言の要素を提供しています。関連項目：変数、ステート変数、ステートトランジション、ビジュアル要素、オーディオ要素、イベントの処理。

UJMLにおける手続き型のスクリプティングはXMLスクリプティングタグと scriptブロックのスクリプティング言語の2種類の方式で提供されています。関連項目：スクリプティング。

UJMLタグのシンタックス

UJMLタグのシンタックスには簡単な表記を用います。関連項目：シンタックスに関するメモ。

UJMLタグは階層的

それぞれのUJMLタグには、特定のその他のタグを含むことができるという、階層構造の明確な定義が存在します。階層の一番上にはujmlタグが存在しています。関連項目： ujml。これはUJMLファイルのルート階層であり、このタグに含まれるタグ、そしてそれらのタグに含まれるタグによって、UJMLファイルの構造と種類が定義されています。関連項目： UJMLファイルの種類。

本文ではそれぞれのUJMLタグが、どのタグによって含まれ（親要素のタグ）、どのタグを含むことができるか（子要素のタグ）を解説しています。また必用に応じて、子要素のタグのデフォルトの値と子要素を記述する必要性の有無を記載しています。

項目

項目	説明
<add>	add 要素は子要素の和を求めます。
<accelerators>	accelerators 要素は、event 要素のアクセラレータを定義するkey要素の親要素です。
<and>	and 要素は全ての子要素がtrueと評価される場合、 trueを返します。それ以外の場合はfalseを返します。
<application>	アプリケーションファイルのUJMLコードを記述する要素です。
<bg>	bg 要素はvisual elementの背景色の指定に使用します。
<box>	box 要素はデバイス画面に長方形を描画します。
<call>	call 要素は関数を呼び出し、その結果を返します。
<caption>	caption 要素は edit または multi-edit ボックスの、フルスクリーンモードにおけるキャプションテキストを指定します。このタグの使用は非推奨となっています。
<clear-state>	clear-state 要素はstate variableの値を変更することなくトランジションを無効にします。
<condition>	condition 要素は条件文の boolean 値を返します。
<delay>	delay 要素は transition 要素内の遅延時間の指定に使用します。
<discard>	discard 要素はデバイスメモリからリソースを削除します。
<display>	discard 要素には、discard 要素の親要素が有効な場合に表示すべきビジュアル要素を記述します。
<display-handle>	デバイス画面に自己描画するextensionハンドルを描画します。
<div>	div 要素は子要素と子要素の商を求めます。
<edit>	edit 要素はユーザーによる1行のテキストを含むstring 変数の値の編集を可能にします。
<else>	else 要素には'if'文の評価が falseであった場合に実行すべきスクリプティング文を記述します。
<eq>	eq 要素は、１つ目の子要素と2つ目の子要素が等しい場合に true を返します。その他の場合は falseを返します。
<eval>	eval 要素はscripting expressionを評価します。
<event>	event 要素はイベントハンドラの宣言、またはエクステンションのイベントを宣言します。
<events>	events 要素には、events 要素の親要素と同一のスコープをもつevent 要素を記述します。
<execute>	execute 要素はにはXML スクリプティング要素を記述します。
<expand>	ビジュアル要素テンプレートをデバイス画面に展開します。
<extension>	UJMLextensionのリンク可能関数の宣言を記述します。
<extensions>	UJMLエクステンションを宣言するextension 要素を記述します。
<face>	face 要素はテキストを表示するvisual elementの字体を指定します。
<fg>	fg 要素はvisual elementの前景色を指定します。
<fn>	fn 要素はラベルとイベントをもつファンクションキーを定義します。
<function>	関数を定義します。
<functions>	親要素と同一スコープの関数の定義を記述します。
<gt>	gt 要素は1つ目の子要素の値が2つ目の子要素よりも大きい場合 true を返します。その他の場合は falseを返します。
<gte>	gte 要素は1つ目の子要素の値が2つ目の子要素よりも大きい、あるいは等しい場合 true を返します。その他の場合は falseを返します。
<handle>	親要素のextensionハンドル値を指定する。
<height>	height 要素はvisual elementの高さを指定します。
<if>	if 要素は 'if' 条件文です。
<image>	image 要素は画像をデバイス画面に描画します。
<image-url>	image-url 要素は引数として与えた画像ファイルの参照に、デバイスの推奨ファイル形式の拡張子を連結したstring 値を返します。
<include>	UJMLファイルにステートマシンをインクルードします。
<index>	index 要素は変数またはステート変数の配列インデックスの指定に使用します。
<is-null>	この要素は指定したエクステンションハンドルがヌルであるかを boolean 値で返します。
<key>	key要素はevent要素のアクセラレータの指定に使用します。
<label>	label 要素はデバイス画面にテキストを描画します。テキストには背景を任意で指定することが可能です。
<line>	lineはデバイス画面上に直線を描画する要素です。
<lt>	lt 要素は第一子要素が第二子要素よりも小さい場合trueを返します。それ以外の場合はfalseを返します。
<lte>	lte 要素は第一子要素が第二子要素よりも小さい場合、もしくは第一子要素と第二子要素が等しい場合、trueを返します。それ以外の場合はfalseを返します。
<max>	max 要素は、指定されたint型の値の中から、もっとも大きい値を返します。
<min>	min 要素は、指定されたint型の値の中から、もっとも小さい値を返します。
<mod>	mod 要素は子要素に対してモジュロ演算を行います。
<mult>	mult 要素は子要素の積を求めます。
<multi-edit>	multi-edit要素は、ユーザーによるstring変数の編集を可能にする複数行のテキスト入力ボックスです。
<multi-label>	multi-label 要素はデバイス画面に複数行のテキストを描画します。テキストには背景を任意で指定することが可能です。
<multi-text-height>	multi-text-height 要素は指定した横幅、フォントサイズ、フォントスタイルそして字体を使用してテキストを表示した場合の高さをint 値で返します。
<ne>	ne 要素は第一子要素が第二子要素が等しくない場合trueを返します。それ以外の場合はfalseを返します。
<not>	not要素は全ての子要素がfalseに評価される場合、 trueを返します。それ以外の場合はfalseを返します。
<or>	or 要素は全ての子要素がtrueに評価される場合、 trueを返します。それ以外の場合はfalseを返します。
<oval>	oval要素はデバイス画面に楕円を描画する要素です。この要素の使用は非推奨となっています。x-oval 要素を代わりに使用してください。
<parameters>	parameters 要素には親要素のfunction または event要素のパラメータを記述します。
<partition>	パーティションファイルのUJMLコードを記述する要素。
<play>	play要素は1つまたは複数の音声ファイルの宣言に使用します。
<polygon>	polygonはデバイス画面上に任意の多角形を描画する要素です。
<polyline>	polylineは互いに連結している線分をデバイス画面上に描画する要素です。
<prefetch>	prefetch 要素はネットワークからリソースを取得します。取得したリソースはデバイスメモリに読み込まれません。
<ref>	ref要素は変数の値を返します。
<resource>	resource要素はデバイスのメモリに読み込むリソースを宣言します。
<resources>	この要素は1つまたは複数のリソース（外部ファイル）の使用を宣言するリソース制御要素です。
<return>	関数の戻り値を出力する。
<round-box>	round-box要素はデバイス画面に四隅を丸めた長方形（丸角長方形）を描画する要素です。
<script>	スクリプトブロックの記述に使用する要素。
<set>	set要素は変数に値を代入します。
<set-state>	この要素は、ステート変数に値を代入する要素です。
<size>	size要素はテキストを表示するビジュアル要素のフォントサイズの指定に使用します。
<sound>	sound要素は再生を行う音声ファイルのURLの指定に使用します。この要素の使用は非推奨となっています。x-sound要素を代わりに使用してください。
<sound-url>	string値で指定したたオーディオファイルへの参照に、デバイスの推奨ファイルタイプの拡張子を付け加える要素です。
<src-x>	src-x要素は、image要素のソース領域のX軸方向の位置（単位：ピクセル）の指定に使用します。
<src-y>	src-y要素は、image要素のソース領域のY軸方向の位置（単位：ピクセル）の指定に使用します。
<state>	state要素には、特定のステート変数のステートトランジションを記述します。
<states>	states要素にはステート変数のステートトランジションを定義するstate要素を記述します。
<state-index>	state-index要素は、配列型ステート変数の指定した次元のインデックスの現在値をint値で返却します。
<state-machine>	state-machineにはUJMLステートマシンのコードを記述します。
<state-machines>	state-machines要素には1つまたは複数のstate-machine要素を記述します。それぞれのstate-machine要素は1つのステートマシンを定義します。
<state-var>	state-var 要素は state variableを宣言します。
<state-variables>	state-variables要素にはステート変数を記述します。ステート変数のスコープはstate-variablesの親要素と同一スコープになります。
<strcat>	strcat要素は、全ての引数を連結した文字列を返します。
<streq>	streq 要素は両方の引数の値が等しい場合trueを、それ他の場合はfalseを返します。
<strlen>	strlen 要素はstringの中の文字数をint値で返します。
<string-to-int>	string-to-int 要素は、指定した文字列を int型に変換した値を返します。
<style>	styleは文字列を表示するビジュアル要素のフォントスタイルを指定する要素です。
<sub>	sub要素は子要素の差を求める要素です。
<substring>	substring 要素はstring（文字列）の一部分を抜き出します。
<template>	visual element templateを宣言します。
<templates>	templates要素はビジュアル要素テンプレートを宣言するためのtemplate要素を含みます。
<text>	text要素はテキストを表示するビジュアル要素において文字列の指定に使用します。
<text-height>	text-height要素は指定したフォントサイズ、フォントスタイル、そしてフォントフェースを使用した場合の文字列の画面上の高さをint値（ピクセル）で返します。
<text-width>	text-width要素は指定したフォントサイズ、フォントスタイル、そしてフォントフェースを使用した場合の文字列の画面上の幅をint値（ピクセル）で返します。
<then>	thenは、'if'の条件がtrueと評価された場合に実行するスクリプティング文を記述する要素です。
<trace>	trace要素はUJMLデバッガーのトレースペーンにメッセージを送信します。
<transition>	transition要素はstate variableに対する state transitionを1つ定義します。
<ujml>	UJMLタグはUJMLファイルのコードを含むルート要素です。
<url>	url要素は外部のリソースを利用するためのファイル参照を指定します。
<use>	UJMLエクステンション宣言ファイルとエクステンション名を指定します。
<uses>	uses要素は、UJMLのエクステンション宣言ファイルとモジュールが使用するエクステンションを指定するuse要素の親要素として記述します。
<val>	val要素はリテラル値を返却します。
<var>	var要素は変数または引数を宣言します。
<variables>	variables要素は子要素としてvar要素を含みます。 varのスコープは、variablesを含む要素内となります。
<while>	while要素は与えられた値が真と評価される間、子要素に記述されている文の実行を繰り返す条件付きのループ文です。
<width>	widthはビジュアル要素の幅を指定する要素です。
<x>	x要素はビジュアル要素の横方向の描画位置の指定に使用します。
<x1>	x1要素は直線の始点のX軸位置の指定に使用します。
<x2>	x1要素は直線の終点のX軸位置の指定に使用します。
<x-alpha>	x-alpha要素はimage要素のアルファ透過性を指定する要素です。
<x-arc-height>	丸角長方形の曲線部分の描画に使用する楕円の高さを指定するための要素。
<x-arc-width>	丸角長方形の曲線部分の描画に使用する楕円の横幅を指定するための要素。
<x-bg>	x-bgはビジュアル要素の背景色を指定する要素です。背景色の利用の可否は、デバイスによって異なります。
<x-caption>	x-captionはedit、またはフルスクリーンモードにおけるmulti-editボックスにタイトルテキストを表示する要素です。
<x-clip>	x-clipは子要素のビジュアル要素の描画を行う際に、親要素の描画領域にクリッピング（はみ出した部分を表示しない）するか否かを指定する要素です。
<x-oval>	x-ovalはデバイスの画面に楕円を描画する要素です。
<x-sound>	x-soundは音声ファイルの指定に使用する要素です。
<x-src-height>	x-src-height要素は、 image要素内での画像のソース領域の高さ（単位：ピクセル）の指定に使用します。
<x-src-width>	x-src-height要素は、 image要素内での画像のソース領域の横幅（単位：ピクセル）の指定に使用します。
<y>	y要素はビジュアル要素のY軸方向の描画位置の指定に使用します。
<y1>	y1要素は直線の始点のY軸位置の指定に使用します。
<y2>	y2要素は直線の終点のY軸位置の指定に使用します。