UJML Tags

UJML provides XML tags that provide the structural and declarative elements of the language.

The UJML language consists of a mix of XML tags and a procedural scripting language. See Layout of UJML Files. Some of these XML tags provide the structural elements of the language. See Types of UJML Files. Others allow you to define the declarative aspects of the language, such as variables, state variables, state transitions, visual/audio elements, and events. See Variables, State Variables, State Transitions, Visual Elements, Audio Elements, Handling Events.

Procedural scripting in UJML is provided using either XML scripting tags or the script block scripting language. See Scripting.

UJML tag syntax

The syntax of each UJML tag is described using a simple notation. See Syntax Notes.

UML tags are hierarchical

The UJML tags exist in a well-defined hierarchical structure where some tags may contain certain other tags. At the top level is the ujml tag itself. See ujml. This is the root of a UJML file, and which tags it contains and which tags its child tags contain define the structure and type of UJML file it is. See Types of UJML Files.

This documentation describes, for each UJML tag, which tags may contain it and which tags it may contain. If appropriate, the default values for a contained tag are documented and/or whether the contained tag is required.

Topics

Topic	Description
<add>	The add element yields the sum of the child elements.
<accelerators>	The accelerators element contains the key elements which specify the accelerators of an event element.
<and>	The and element yields true if all the child elements evaluate to true, otherwise it is false.
<application>	This element contains the UJML code for an application file.
<bg>	The bg element specifies the background color of a visual element.
<box>	The box element draws a rectangle on the device screen.
<call>	The call element calls a function and yields the result.
<caption>	The caption element specifies the caption of an edit or multi-edit box in full-screen mode. This tag is deprecated.
<clear-state>	The clear-state element causes a state variable to transition out without changing its value.
<comment>	Provides a text description of the containing element.
<component>	This element contains a UJML component.
<condition>	The condition element yields a boolean value for a conditional statement.
<delay>	The delay element specifies a delay time in a transition element.
<discard>	The discard element removes a resource from device memory.
<display>	This element contains visual elements which display when the containing element is active.
<display-instance>	This element draws a self-painting component on the device screen.
<div>	The div element yields the quotient of the child elements.
<edit>	The edit element allows the user to edit a string variable containing a single line of text.
<else>	The else element contains scripting statements to execute when an 'if' statement is false.
<eq>	The eq element yields true if the first child element is equal to the second, otherwise it yields false.
<eval>	The eval element evaluates a scripting expression.
<event>	The event element defines an event handler or declares an event of an component.
<events>	The events element contains multiple event elements scoped to the containing element.
<execute>	The execute element contains XML scripting elements.
<expand>	This element expands a visual element template on to the device screen.
<face>	The face element specifies the font face of a visual element that displays a string.
<fg>	The fg element specifies the foreground color of a visual element.
<fn>	The fn element defines a function key with a label and an event.
<function>	This element defines a function.
<functions>	This element contains function definitions scoped to the containing element.
<gt>	The gt element yields true if the first child element is greater than the second, otherwise it yields false.
<gte>	The gte element yields true if the first child element is greater than or equal to the second, otherwise it yields false.
<height>	The height element specifies the height of a visual element.
<if>	The if element is a conditional 'if' statement.
<image>	The image element draws a picture on the device screen.
<image-url>	The image-url element yields the the string value of the passed image file reference with the extension of the device's preferred file format appended.
<include>	This element includes a state machine or an interface into a UJML file.
<index>	The index element specifies an array index of a variable or state variable.
<instance>	This element specifies a component reference value for the containing element.
<interface>	This element declares or indicates usage of an interface to a UJML component.
<interfaces>	This element contains interface elements that declare interfaces for UJML Components.
<is-null>	This element yields a boolean value indicating if a component reference is null.
<key>	The key element specifies a key to use for the accelerators of an event element.
<label>	The label element draws text with an optional background on the device screen.
<line>	The line element draws a line on the device screen.
<lt>	The lt element yields true if the first child element is less than the second, otherwise it yields false.
<lte>	The lte element yields true if the first child element is less than or equal to the second, otherwise it yields false.
<max>	The max element yields the greater of two or more int values.
<min>	The min element yields the lesser of two or more int values.
<mod>	The mod element yields the modulus of the child elements.
<mult>	The mult element yields the product of the child elements.
<multi-edit>	The multi-edit element allows the user to edit a string variable containing multiple lines of text.
<multi-label>	The multi-label element draws multi-line text with an optional background on the device screen.
<multi-text-height>	The multi-text-height element yields an int height value, in pixels, for the passed text given the passed width, font size, font style, and font face.
<name>	This element specifies a component name.
<ne>	The ne element yields true if the first child element is not equal to the second, otherwise it yields false.
<not>	The not element yields true if the child element evaluates to false, otherwise it yields false.
<or>	The or element yields true if any of the child elements evaluate to true, otherwise it yields false.
<oval>	The oval element draws an ellipse on the device screen. This element has been deprecated in favor of x-oval.
<parameters>	The parameters element contains the the arguments for the containing function or event element.
<partition>	This element contains the UJML code for a partition file.
<play>	The play element declares one or more sounds.
<polygon>	The polygon element draws an arbitrary polygon on the device screen.
<polyline>	This element draws a multi-segmented line on the device screen.
<prefetch>	The prefetch element fetches a resource across the network, but does not load it into device memory.
<ref>	The ref element yields the value of a variable.
<resource>	The resource element declares a resource to load into the device's memory.
<resources>	This element declares one or more resources to load into the device's memory.
<return>	This element yields the return value of a function.
<round-box>	The round-box element draws a rectangle with rounded corners on the device screen.
<script>	Contains a script block.
<set>	The set element assigns a value to a variable.
<set-state>	Assigns a value to a state variable.
<size>	The size element specifies the font size of a Visual Element that displays a string.
<sound>	The sound element specifies a sound file to play. This has been deprecated in favor of x-sound element.
<sound-url>	The sound-url element yields the the string value of the passed audio file reference with the extension of the device's preferred file format appended.
<src-x>	The src-x element specifies the horizontal position (in pixels) of a source region in an image element.
<src-y>	The src-y element specifies the vertical position (in pixels) of a source region in an image element.
<state>	The state element contains transition elements specifying state transitions for a single state variable.
<states>	The states element contains state elements specifying state transitions for state variables.
<state-index>	The state-index element yields the int value of the current index for the requested dimension of an array state variable.
<state-machine>	A state-machine element contains the code for a UJML state machine.
<state-machines>	A state-machines element contains one or more state-machine elements, each defining one state machine.
<state-var>	The state-var element a state variable.
<state-variables>	The state-variables element contains state variables scoped to the containing element.
<strcat>	The strcat element yields a string containing all the arguments, concatenated.
<streq>	The streq element yields true if both of the arguments have the same value, otherwise it yields false.
<strlen>	The strlen element yields an int value giving the count of characters in the contained string.
<string-to-int>	The string-to-int element yields an int value of the contained string or 0 if the string contains non-numeric characters.
<style>	The style element specifies the font style of a visual element that displays a string.
<sub>	The sub element yields the difference of the child elements.
<substring>	The substring element yields a sub-part of a string.
<template>	This element declares a visual element template.
<templates>	This element contains template elements declaring visual element templates.
<text>	The text element specifies the text of a visual element that displays a string.
<text-height>	The text-height element yields an int height, in pixels, for the passed font size, font style, and font face.
<text-width>	The text-width element yields an int width, in pixels, for the passed text given the passed font size, font style, and font face.
<then>	The then element contains scripting statements to execute when an 'if' statement is true.
<trace>	The trace element sends a message to the trace pane of the UJML debugger.
<transition>	The transition element specifies a single state transition for a state variable.
<ujml>	This element contains the actual code of a UJML file.
<url>	The url element specifies a file reference for an external resource.
<val>	The val element yields a literal value.
<var>	The var element declares a variable or a parameter.
<variables>	The variables element contains variables scoped to the containing element.
<while>	The while element is a conditional looping statement which repeats contained scripting statements while a value is true.
<width>	The width element specifies the width of a visual element.
<x>	The x element specifies the horizontal position of a visual element.
<x1>	The x1 element specifies the horizontal position of the beginning point of a line.
<x2>	The x2 element specifies the horizontal position of the ending point of a line.
<x-alpha>	The x-alpha element specifies the alpha opacity of an image element.
<x-arc-height>	Specifies the height of the ellipse used to draw the rounded corners of a round-box.
<x-arc-width>	Specifies the width of the ellipse used to draw the rounded corners of a round-box.
<x-bg>	The x-bg element specifies the background color of a visual element where background color support varies from device to device.
<x-caption>	The x-caption element specifies the caption of an edit or multi-edit box in full-screen mode.
<x-clip>	The x-clip element specifies if child visual elements are clipped to the region of the parent element.
<x-oval>	The x-oval element draws an ellipse on the device screen.
<x-sound>	The x-sound element specifies a sound file to play.
<x-src-height>	The x-src-height element specifies the height (in pixels) of a source region in an image element.
<x-src-width>	The x-src-width element specifies the width (in pixels) of a source region in an image element.
<y>	The y element specifies the vertical position of a visual element.
<y1>	The y1 element specifies the vertical position of the beginning point of a line.
<y2>	The y2 element specifies the vertical position of the ending point of a line.