Luxor Network: Luxor - Luxilla - Petra - Installer DeLux - Luxor Contrib - Luxor Forum - The Memphis Sun
Luxor XUL Logo
Making Building Classic Desktop-Style UIs As Easy As Building Web Pages
Overview . Tag Reference . Cheat Sheet . CSS Reference . API Reference . FAQ . History . Upcoming . Gallery . Notes . Powered By Luxor . Contribute . Mailing Lists & Forums . Premium Support . Credits . Glossary . Site Search . The Memphis Sun . Download . Download Luxilla . Download Plugins . Download Contrib . Source . Javadoc . Team . Who's Who . Donate . Luxor @ Sourceforge

Luxor XUL Tag Reference

Alphabetical Tag List
Tag Groups

Box Tags

Tag Description
box Defines a box that lays out its children either from left to right or from top to bottom, depending if orient is set to horizontalor vertical. Horizontal is default.
hbox Defines a box that lays out its children horizontally, that is, from left to right.
vbox Defines a box that lays out its children vertically, that is, from top to bottom.
groupbox Defines a box that draws a border around its children. Use caption to add an optional title. Lays out its children from top to bottom, that is, vertically, by default.
caption Specifies the title for a groupbox.

Grid Tags

Tag Description
grid Holds rows and columns to display as a grid. A grid is an alternative to an HTML table.
columns Holds the grid's columns.
column Defines a column.
rows Holds the grid's rows.
row Defines a row.

HTML Table Tags

Tag Description
table Defines an HTML table.
tr Defines a table row that holds table data.
td Defines a table cell inside a table row.

Tab Box Tags

Tag Description
tabbox Defines a box that displays tabbed pages.
tabs Holds a row of tabs that let you switch between pages.
tab Defines a single tab.
tabpanels Holds a set of pages in a tabbox.
tabpanel Defines an individual page for a tabbox.

Main Widget Tags

Tag Description
button Defines a push button that can display text, icons, or both.
checkbox Defines a checkbox. A checkbox is a toogle button for choices that are not mutually exclusive. For mutually exclusive choices use radio style toggle buttons, see <choice> for details.
choice Defines a list of mutually exclusive choices, that is, you can pick only one item. You can render the list of choices using either radiobuttons or using a combobox. A combobox is a combination of a text input box and a drop-down list of choices. The user can type a selection or pick one from the drop-down list.
mchoice Defines a list of multiple choices. You can render the list of choices using either checkboxes or using a listbox.
label Defines a label that displays text, an icon, or both. A label doesn't respond to user input.
password Defines a password input box.
separator Defines a separator.
spacer Takes up space but doesn't display anything.
text Defines a single line plain text input box. For multi line text input boxes see <textarea> .
textarea Defines a multi line plain text input box. For single line text input boxes see <text> .
image Defines an image. Supports GIF and JPG graphic formats.
iframe Defines a browser window. Note, that Luxor currently uses Swing's JEditorPane which only supports HTML 3.2 plus some CSS 1.
componentref , gadget References user-created gooey compenents that are registered with Luxor to let you embed them in boxes and change their style, access key, tooltip and more. Note, that you can reference Java built panels as well.

Menu Tags

Tag Description
menubar Defines a menu bar that displays a set of pull-down menus.
menu Defines a pull-down menu or a submenu within another menu.
menuref References a menu registered with Luxor to let you build dynamic menus in Java and add them to your Xul menus.
menupopup Holds menu items and menus.
menuitem Describes a menu item.
menuseparator Defines a menu separator that divides menu items into sections.
popup Defines a right-click ad-hoc popup menu.
displayurl Defines a menu item that display a web page in the user's household browser such as Mozilla, Netscape or Opera. In case the user is offline, Luxor can serve up the bundled web page from inside the app's jar itself to the user's household browser.

Toolbar Tags

Tag Description
toolbar Defines a toolbar that holds buttons for fast single-click access.
toolbarbutton Defines a toolbar button.
toolbarseparator Defines a toolbar separator that divides toolbar buttons into sections.

Data Tags

Tag Description
list Defines a list of strings.
map Defines a list of key/value pairs.
entry Defines a list entry or a key/value pair for a map.

Portal Tags

Tag Description
portal Defines a web page using HTML snippets known as portlets. Note, that embedded HTML must conform to XHTML. Luxor automatically converts XHTML back to HTML (e.g. <hr/> becomes <hr>).
portlet References portlets registered with Luxor and created in Java. Portlets are similar to servlets. In contrast to servlets, however, portlets return HTML snippets instead of HTML pages. Portlets are also known as HTML controls or HTML paglets.

Keyboard Shortcuts Tags

Tag Description
keyset Holds a set of accelerator keys.
key Describes accelerator keys for menu items, buttons or commands.

Data Control Tags

Tag Description
datagrid Defines a datagrid. In contrast to table or grid, datagrid's only purpose is to display data in table format using Swing's JTable and you, therefore, cannot use it for page layout.
tree Defines a tree to display data in a hierachy using Swing's JTree.

Misc Tags

Tag Description
anim Defines an animation consisting of frames used as an activity indicator, for example.
icon Describes an icon. Supports GIF and JPG formats.
command References commands that are registered with Luxor to let you change their description, icon and more.
stylesheet Defines an XSL/T stylesheet inside a XUL document that creates a XUL fragment from XML data. Note, that you can embed XSL/T stylesheets anywhere in your XUL documents as long as the XSL/T stylesheet produced results fit in.
Quick Overview
Tag Description
anim Defines an animation consisting of frames used as an activity indicator, for example.
box Defines a box that lays out its children either from left to right or from top to bottom, depending if orient is set to horizontalor vertical. Horizontal is default.
button Defines a push button that can display text, icons, or both.
caption Specifies the title for a groupbox.
checkbox Defines a checkbox. A checkbox is a toogle button for choices that are not mutually exclusive. For mutually exclusive choices use radio style toggle buttons, see <choice> for details.
choice Defines a list of mutually exclusive choices, that is, you can pick only one item. You can render the list of choices using either radiobuttons or using a combobox. A combobox is a combination of a text input box and a drop-down list of choices. The user can type a selection or pick one from the drop-down list.
column Defines a column inside a grid.
columns Holds the grid's columns.
command References commands that are registered with Luxor to let you change their description, icon and more.
componentref References gooey compenents that are registered with Luxor panels to let you change their style, access key, tooltip and more. Note, that you can reference Java built panels as well.
datagrid Defines a datagrid. In contrast to table or grid, datagrid's only purpose is to display data in table format using Swing's JTable and you, therefore, cannot use it for page layout.
displayurl Defines a menu item that display a web page in the user's household browser such as Mozilla, Netscape or Opera. In case the user is offline, Luxor can serve up the bundled web page from inside the app's jar itself to the user's household browser.
entry Defines a list entry or a key/value pair for a map.
gadget Gadget is a synonym for componentref. See componentref for details.
grid Holds rows and columns to display as a grid. A grid is an alternative to an HTML table.
groupbox Defines a box that draws a border around its children. Use caption to add an optional title. Lays out its children from top to bottom, that is, vertically, by default.
hbox Defines a box that lays out its children horizontally, that is, from left to right.
icon Describes an icon. Supports GIF and JPG formats.
iframe Defines a browser window. Note, that Luxor currently uses Swing's JEditorPane which only supports HTML 3.2 plus some CSS 1.
image Defines an image. Supports GIF and JPG graphic formats.
key Describes accelerator keys for menu items, buttons or commands.
keyset Holds a set of accelerator keys.
label Defines a label that displays text, an icon, or both. A label doesn't respond to user input.
list Defines a list of strings.
map Defines a list of key/value pairs.
mchoice Defines a list of multiple choices. You can render the list of choices using either checkboxes or using a listbox.
menu Defines a pull-down menu or a submenu within another menu.
menubar Defines a menu bar that displays a set of pull-down menus.
menuitem Describes a menu item.
menupopup Holds menu items and menus.
menuref References a menu registered with Luxor to let you build dynamic menus in Java and add them to your Xul menus.
menuseparator Defines a menu separator that divides menu items into sections.
password Defines a password input box.
popup Defines a right-click ad-hoc popup menu.
portal Defines a web page using HTML snippets known as portlets. Note, that embedded HTML must conform to XHTML. Luxor automatically converts XHTML back to HTML (e.g. <hr/> becomes <hr>).
portlet References portlets registered with Luxor and created in Java. Portlets are similar to servlets. In contrast to servlets, however, portlets return HTML snippets instead of HTML pages. Portlets are also known as HTML controls or HTML paglets.
row Defines a row inside a grid.
rows Holds the grid's rows.
separator Defines a separator. Note, for separators inside menus use <menuseparator> .
spacer Takes up space but doesn't display anything.
stylesheet Defines an XSL/T stylesheet inside a XUL document that creates a XUL fragment from XML data. Note, that you can embed XSL/T stylesheets anywhere in your XUL documents as long as the XSL/T stylesheet produced results fit in.
tab Defines a single tab for a tabbox.
tabs Defines a row of tabs for a tabbox to let you switch between pages.
tabbox Defines a box that displays tabbed pages.
table Defines an HTML table.
tabpanel Defines an individual page for a tabbox.
tabpanels Holds a set of pages in a tabbox.
td Defines a table cell inside a table row.
text Defines a single line plain text input box. For multi line text input boxes see <textarea> .
textarea Defines a multi line plain text input box. For single line text input boxes see <text> .
tr Defines a table row that holds table data.
tree Defines a tree to display data in a hierachy using Swing's JTree.
toolbar Defines a toolbar that holds buttons for fast single-click access.
toolbarbutton Defines a toolbar button.
toolbarseparator Defines a toolbar separator that divides toolbar buttons into sections.
vbox Defines a box that lays out its children vertically, that is, from top to bottom.
xul Luxor's one and only root tag.
Conventions Used In This Reference

I use the DTD operators below to formally describe the tag's contents.

? optional 0 or 1
* optional and repeatable 0 or more
+ required and repeatable 1 or more

I mark stand alone/empty tags with <separator/> in contrast to container tags <box>..</box>. Stand alone/empty tags cannot contain any text or tags. Container tags with an end tag can contain text or tags or both.

Request for Comments

This Luxor XUL tag reference is a living, growing body of knowledge, not just a publish-and-forget-it static dead-tree document, help to improve it. Send your comments, suggestions, or corrections to comments@vamphq.com. Your contributions are welcome.

As an alternative you can post your insights at Luxor's discussion forum which I check regularily.

Luxor Core Attributes

The attributes below are core attributes and, therefore, available for all XUL tags. Note, that the core attributes are not listed individually for every tag.

Attributes

id=id , optional
Uniquely identifies a XUL tag. Note, that you can use dot ( .), underscore (_) or dash (-) in your identifier (e.g. world.icon, world-icon, WORLD_ICON are all legal ids). If no id is specified, the tag's id defaults to anonymous.
class=class , optional
Defines the CSS style class.
style=style , optional
Defines inline CSS style properties.
Here We Go

<anim>

<anim>..</anim>

Defines an animation consisting of frames used as an activity indicator, for example.

Contents

icon +

Appears In

xul

Examples

<anim id="LOGO">
   <icon ref="images/20x20/circle_0.gif" />
   <icon ref="images/20x20/circle_1.gif" />
   <icon ref="images/20x20/circle_2.gif" />
   <icon ref="images/20x20/circle_3.gif" />
   <icon ref="images/20x20/circle_4.gif" />
   <icon ref="images/20x20/circle_5.gif" />
   <icon ref="images/20x20/circle_6.gif" />
   <icon ref="images/20x20/circle_7.gif" />
   <icon ref="images/20x20/circle_8.gif" />
   <icon ref="images/20x20/circle_9.gif" />
</anim>

<box>

<box>..</box>

Defines a box that lays out its children either from left to right or from top to bottom, depending if orient is set to horizontal or vertical. Horizontal is default.

Attributes

orient=horizontal|vertical, optional
Defines the orientation of the box. Horizontal is default.

Contents

(widgets | boxes)+

Appears In

xul , boxes

Examples

<box>
   <button label="Yes" />
   <button label="No" />
   <button label="Who cares?" />
</box>

<button>

<button/>

Defines a push button that can display text, icons, or both.

Attributes

label=string , optional
The button's text.
command=id , optional
The command to execute if the user's clicks on the button.
icon=id , optional
The button's icon.
tooltip=string , optional
The button's tool tip.
accesskey=char , optional
The button's access key.

Appears In

boxes

Examples

<button id="SELECT_BUTTON" label="..." command="selectInformationIcon" />

<button command="test" label="Test"  icon="TEST_ICON"
        tooltip="Test Jnlp Package" accesskey="T" />

<caption>

<caption/>

Defines the title for a groupbox.

Attributes

label=string , required
The title of the groupbox.

Appears In

groupbox

Examples

<caption label="Valuation" />

<checkbox>

<checkbox/>

Defines a checkbox. A checkbox is a toogle button for choices that are not mutually exclusive. For mutually exclusive choices use radio style toggle buttons, see <choice> for details.

Attributes

label=string , optional
The checkbox caption.
checked=true|false, optional
Specifies wether or not the checkbox is initially selected. By default the checkbox is unselected.

Appears In

boxes

Examples

<checkbox id="ANONYMOUS_INPUT" label="Anonymous" />
<checkbox id="WEBARCHIVE_INPUT" 
    label="Upload as Web Archive (.war)?" checked="true" />

<choice>

<choice/>

Defines a list of mutually exclusive choices, that is, you can pick only one item. You can render the list of choices using either radiobuttons or using a combobox. A combobox is a combination of a text input box and a drop-down list of choices. The user can type a selection or pick one from the drop-down list.

Attributes

map=id , optional
The data source to fill up your combobox or to create a list of radio buttons. Note, that your user will see the map entry value, but your code will get the map entry key. Note, that you can either specify map or list, but not both at the same time.
list=id , optional
The data source to fill up your combobox or to create a list of radio buttons.
type=radio, optional
Use a list of radio buttons instead of the default combobox.

Appears In

boxes

Examples

<choice id="STORETYPE_INPUT" map="STORETYPE" />

<choice id="KIND_INPUT" list="ICON_KIND" type="radio"/>

<column>

<column/>

Defines a column inside a grid. Note that, for now you cannot add any content to column only to row. See row for details.

Appears In

columns

Examples

<column/>

<columns>

<columns>..</columns>

Holds the grid's columns.

Contents

column +

Appears In

grid

Examples

<columns>
  <column/>
  <column/>
</columns>

<command>

<command/>

References commands that are registered with Luxor to let you change their description, icon and more.

Appears In

xul

Examples



<componentref>

<componentref/>

References gooey components that are registered with Luxor XulForms so that you can embed them inside boxes. You can also change their style, access key, tooltip and more. Note, that you are not limited to classic components such as listboxes, labels, etc. you can reference hard-wired Java panels as well.

Note, that gadget is synomym for componentref in case you prefer a shorter and fancier name.

Appears In

boxes

Examples

<componentref id="MANIFEST_TABLE" />

<datagrid>

<datagrid/>

Defines a datagrid. In contrast to table or grid, datagrid's only purpose is to display data in table format using Swing's JTable and you, therefore, cannot use it for page layout.

Attributes

datasource=path , required
Path to XML data to display in table format.

Appears In

boxes

Examples

<datagrid datasource="data/orders.xml" />

<displayurl>

<displayurl/>

Defines a menu item that display a web page in the user's household browser such as Mozilla, Netscape or Opera. In case the user is offline, Luxor can serve up the bundled web page from inside the app's jar itself to the user's household browser.

Attributes

label=string , optional
The menu item's text.
url=url , optional
The location of the document to display in the user's household browser.
offline=url , optional
Specifies the internal jar path of the document to display in the user's household browser if she is offline. Note, that you need to bundle your offline documents with your app's jars to make it work.
icon=id , optional
The menu item's icon.

Appears In

menupopup , popup

Examples

<displayurl label="Venus Application Publisher Headquaters"
   url="http://www.vamphq.com"
   offline="vamphq/index.html"
   icon="BLANK_ICON" />

<entry>

<entry/>

Defines a list entry or a key/value pair for a map.

Attributes

key=string , required
The entry's key. Note, the entry's key is only required if used inside a map.
value=string , required
The entry's value.

Appears In

map , list

Examples

<map id="JWS_SERVLET_LOGLEVEL">
  <entry key="NONE" value="None"/>
  <entry key="FATAL" value="Fatal"/>
  <entry key="WARNING" value="Warning"/>
  <entry key="INFORMATIONAL" value="Informational"/>
  <entry key="DEBUG" value="Debug"/>
</map>

<list id="DOWNLOAD">
  <entry value="eager"/>
  <entry value="lazy"/>
</list>

<gadget>

<gadget/>

Gadget is a synonym for componentref. See componentref for details.


<grid>

<grid>..</grid>

Holds rows and columns to display as a grid. A grid is an alternative to an HTML table.

Contents

columns rows

Appears In

xul , boxes

Examples

<grid>
  <columns>
    <column/>
    <column/>
  </columns>
 
  <rows>
     <row>
          <label value="Document Title:" />
          <text id="doctitle" />
     </row>
     <row>
          <label value="Path:" />
          <box>
              <text id="docpath" />
              <button label="Browse..." />
          </box>
     </row>
   </rows>
</grid>   

<groupbox>

<groupbox>..</groupbox>

Defines a box that draws a border around its children. Use caption to add an optional title. Lays out its children from top to bottom, that is, vertically, by default.

Contents

caption ? (widgets | boxes)+

Appears In

xul , boxes

Examples

<groupbox>
  <caption label="Assorted" />
  <box>
    <label value="Proof of Purchase" />            
    <text id="purchaseProof" />
    <label value="Warranty Expires" />
    <text id="warrantyExpires" />
  </box>
</groupbox>

<hbox>

<hbox>..</hbox>

Defines a box that lays out its children horizontally, that is, from left to right.

Contents

(widgets | boxes)+

Appears In

xul , boxes

Examples

<hbox>
  <label value="Cost" />
  <text id="cost" />
  <label value="Place of Purchase" />
  <text id="purchasePlace" />
</hbox>

<icon>

<icon/>

Describes an icon. Supports GIF and JPG graphic formats.

Attributes

ref=path , required
The icon's internal jar path.

Appears In

xul

Examples

<icon id="ALICE_ICON"  ref="images/20x20/world2.gif" />
<icon id="GO_ICON"     ref="images/20x20/open.gif" />
<icon id="BLANK_ICON"  ref="images/20x20/blank.gif" />
<icon id="EXIT_ICON"   ref="images/20x20/exit.gif" />
<icon id="ABOUT_ICON"  ref="images/20x20/about.gif" />

<iframe>

<iframe/>

Defines a browser window. Note, that Luxor currently uses Swing's JEditorPane which only supports HTML 3.2 plus some CSS 1.

Attributes

src=path , required
The path to the HTML page to display.

Appears In

boxes

Examples

<iframe src="html/about.html" />

<image>

<image/>

Defines an image. Supports GIF and JPG graphic formats.

Attributes

src=path , required
The internal jar path to the image.

Appears In

boxes

Examples

<image src="images/jess-completed.jpg" />
<image src="images/vanessa.jpg" />

<key>

<key/>

Describes accelerator keys for menu items, buttons or commands.

Attributes

modifiers=control, optional
The accelerator key's modifier such as alt, shift, ctrl, meta, or a combination.
key=char , required
The accelerator key's char code.

Appears In

keyset

Examples

<key id="go"     modifiers="control" key="G" />
<key id="goHome" modifiers="control" key="H" />
<key id="run"    modifiers="control" key="R" />

<keyset>

<keyset>..</keyset>

Holds a set of accelerator keys.

Contents

key +

Appears In

xul

Examples

<keyset>
  <key id="go"     modifiers="control" key="G" />
  <key id="goHome" modifiers="control" key="H" />
  <key id="run"    modifiers="control" key="R" />
</keyset>

<label>

<label/>

Defines a label that displays text, an icon, or both. A label doesn't respond to user input.

Attributes

value=string , optional
The label's text.

Appears In

boxes

Examples

<label id="KEYSTORE_LABEL" value="Keystore:" />
<label id="STORETYPE_LABEL" value="Keystore Type:" />

<label>
  <h1>Heading 1</h1>
  <h2>Heading 2</h2>
  <p>Add <code>XHTML</code> <em>content</em>
       to format the label's <b>text</b><p>
</label>

<list>

<list>..</list>

Defines a list of strings

Attributes

sort=true|false, optional
Specifies wheter or not you want the list sorted. By default the list is unsorted.

Contents

entry +

Appears In

xul

Examples

<list id="DOWNLOAD">
  <entry value="eager"/>
  <entry value="lazy"/>
</list>

<map>

<map>..</map>

Defines a list of key/value pairs.

Attributes

sort=true|false, optional
Specifies wheter or not you want the list sorted. By default the list is unsorted.

Contents

entry +

Appears In

xul

Examples

<map id="STORETYPE">
  <entry key="JKS" value="JKS - Java Key Store"/>
  <entry key="JCEKS" value="JCEKS - Java Cryptography Extension Key Store"/>
</map>

<mchoice>

<mchoice/>

Defines a list of multiple choices. You can render the list of choices using either checkboxes or using a listbox.

Attributes

map=id , optional
The data source holding the choices to display. Note, that your user will see the map entry value, but your code will get the map entry key. Note, that you can either specify map or list, but not both at the same time.
list=id , optional
The data source holding the choices to display.
type=list, optional
Use a listbox instead of a series of checkboxes to display multiple choices.
orient=horz | vert , optional
Arrange checkboxes vertically (that is, from top-to-bottom) or horizontally (that is, from left-to-right). Horizontal is default.

Appears In

boxes

Examples

<mchoice list="activity" />

<mchoice list="activity" type="list" />

<menu>

<menu>..</menu>

Defines a pull-down menu or a submenu within another menu.

Attributes

label=string , optional
The menu's text.
accesskey=char , optional
The menu's access key.

Contents

menupopup

Appears In

menubar , menupopup , popup

Examples

<menu id="action" label="Action" accesskey="T"><menupopup>
  <menuitem command="test" label="Test" 
            accesskey="T" key="test"
            icon="TEST_ICON"  />
  <menuitem command="createCdInstaller" label="Create CD Installer..."
            accesskey="I" icon="CREATE_CD_INSTALLER_ICON" />
  <menuitem command="createWar" label="Create Web Archive..."
            accesskey="W" key="create-war"
            icon="CREATE_WAR_ICON" />
  <menuitem command="createCar" label="Create Client Archive..."
            accesskey="C" icon="CREATE_CAR_ICON" />
</menupopup></menu>

<menubar>

<menubar>..</menubar>

Defines a menu bar that displays a set of pull-down menus.

Contents

menu +

Appears In

xul

Examples

<menubar id="ALICE_MENUBAR">

  <menu id="file" label="File" accesskey="F"><menupopup>
    <menuitem command="go" label="Go"
              accesskey="G" key="go"
              icon="GO_ICON" />
    ...
    <menuseparator/>
    <menuitem command="exit" label="Exit"
        accesskey="X" icon="EXIT_ICON" />
  </menupopup></menu>

  <menu id="help" label="Help" accesskey="H"><menupopup>
    <displayurl label="Venus Application Publisher Headquaters"
                url="http://www.vamphq.com"
                icon="WORLD_ICON" />
    <displayurl label="Venus Application Publisher Discussion Forum"
                url="http://groups.yahoo.com/group/vamp-feedback"
                icon="WORLD_ICON" />
    ...
  </menupopup></menu>

</menubar>

<menuitem>

<menuitem/>

Describes a menu item.

Attributes

command=id , optional
The command to execute if the user selects this menu item.
label=text , optional
The menu item's text.
accesskey=char , optional
The menu item's access key.
key=id , optional
The menu item's accellerator key (aka shortcut key).
icon=id , optional
The menu item's icon.

Appears In

menupopup , popup

Examples

<menuitem command="go" label="Go" accesskey="G" key="go" icon="GO_ICON" />
<menuitem command="exit" label="Exit" accesskey="X" icon="EXIT_ICON" />

<menupopup>

<menupopup>..</menupopup>

Holds menu items and menus.

Contents

( menu | menuitem | displayurl )+

Appears In

menu

Examples

See <menu>


<menuref>

<menuref/>

References a menu registered with Luxor to let you build dynamic menus in Java and add them to your Xul menus.

Attributes

label=text , optional
The menu's text.
icon=id , optional
The menu's icon.

Appears In

menupopup

Examples

<menuref id="MY_TEMPLATES" label="New From My Template" icon="BLANK_ICON" />
<menuref id="MY_JNLPS"     label="Open My File"         icon="BLANK_ICON" />
<menuref id="RECENT_URLS"  label="Open Recent URL"      icon="BLANK_ICON" />

<menuseparator>

<menuseparator/>

Defines a menu separator that divides menu items into sections.

Appears In

menupopup

Examples

<menuseparator/>

<password>

<password/>

Defines a password input box.

Appears In

boxes

Examples

<password id="STOREPASS_INPUT" />
<password id="KEYPASS_INPUT" />

<popup>

<popup>..</popup>

Defines a right-click ad-hoc popup menu.

Contents

( menu | menuitem | displayurl )+

Appears In

xul

Examples



<portal>

<portal>..</portal>

Defines a web page using HTML snippets known as portlets. Note, that embedded HTML must conform to XHTML. Luxor automatically converts XHTML back to HTML (e.g. <hr/> becomes <hr>).

Contents

(xhtml | portlet )+

Appears In

xul

Examples

<portal id="system-info">
  <portlet id="head"/>
  <div align="center">
   <table border="0" width="90%" cellspacing="0" cellpadding="0">
    <tr>
     <td>             
      <portlet id="user-banner" />
      <portlet id="title"/>
      <portlet id="system-info" />
      <portlet id="system-properties" />
     </td>
    </tr>
   </table>
  </div>
</portal>

<portlet>

<portlet/>

References portlets registered with Luxor and created in Java. Portlets are similar to servlets. In contrast to servlets, however, portlets return HTML snippets instead of HTML pages. Portlets are also known as HTML controls or HTML paglets.

Appears In

portal

Examples

<portlet id="user-banner" />
<portlet id="title"/>
<portlet id="system-info" />
<portlet id="system-properties" />

<row>

<row>..</row>

Defines a row inside a grid. Note, you can put more than one widget into a column by wrapping them into a box. Note, that in contrast to an HTML table row, a grid row uses only as many columns as you defined using columns.

Contents

(widgets | boxes)+

Appears In

rows

Examples

<row>
  <label value="XML Schema File:" />   <!-- first column -->
  <text id="schema-file-input" />      <!-- second column -->
</row>      

<row>
  <label value="Path:" />              <!-- first column -- >
  <box>                                <!-- begin second column -->
    <text id="docpath" />
    <button label="Browse..." />
  </box>                               <!-- end second column -->
</row>

<rows>

<rows>..</rows>

Holds all rows of a grid.

Contents

row +

Appears In

grid

Examples

<rows>
  <row>
    <label value="Document Title:" />
    <text id="doctitle" />
  </row>
  <row>
    <label value="Path:" />
    <box>
      <text id="docpath" />
      <button label="Browse..." />
    </box>
  </row>
</rows>

<separator>

<separator/>

Defines a separator. Note, for separators inside menus use <menuseparator> ; for separators inside toolbars use <toolbarseparator> .

Appears In

boxes

Examples

<separator/>

<spacer>

<spacer/>

Takes up space but doesn't display anything.

Appears In

boxes

Examples

<spacer/>

<stylesheet>

<stylesheet>..</stylesheet>

Defines an XSL/T stylesheet inside a XUL document that creates a XUL fragment from XML data. Note, that you can embed XSL/T stylesheets anywhere in your XUL documents as long as the XSL/T stylesheet produced results fit in.

Attributes

datasource=path , required
Path to XML data used to create XUL fragment.

Contents

XSL/T

Examples

<menu id="bookmarks" label="Bookmarks">

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" 
   version="1.0"
   datasource="data/bookmarks.xml">

<xsl:template match="bookmarks">
   <menupopup>
     <xsl:apply-templates/>
   </menupopup>
 </xsl:template>

 <xsl:template match="folder">
  <menu label="{@title}">
   <menupopup>
     <xsl:apply-templates/>
   </menupopup>
  </menu>
 </xsl:template>

 <xsl:template match="bookmark">
  <displayurl label="{@title}" url="{@href}" />
 </xsl:template>

</xsl:stylesheet>

</menu>

<tab>

<tab/>

Defines a tab for a tabbox. A tab lets you switch between pages.

Attributes

label=string , required
The tab's text.

Appears In

tabs

Examples

<tab label="Assets" />

<tabs>

<tabs>..</tabs>

Defines a row of tabs for a tabbox.

Contents

tab +

Appears In

tabbox

Examples

<tabs>
  <tab label="Browser" />
  <tab label="Editor" />
  <tab label="Xml" />
  <tab label="Files" />
  <tab label="Summary" />  
</tabs>

<tabbox>

<tabbox>..</tabbox>

Defines a box that displays tabbed pages.

Contents

tabs + tabpanels +

Appears In

xul , boxes

Examples

<tabbox>
  <tabs>
    <tab label="Mail" />
    <tab label="News" />
  </tabs>

  <tabpanels>
    <tabpanel id="mailtab">
      <button label="Check For Mail" />          
    </tabpanel>

    <tabpanel id="newstab">
      <button label="Clear News Buffer" />
    </tabpanel>

  </tabpanels>
</tabbox>

<table>

<table>..</table>

Defines a box that lays out its children like a HTML table.

Contents

tr +

Appears In

xul , boxes

Examples

<table>
  <tr>
    <td><label value="Keystore:" /></td>
    <td horz="MAX"><text id="KEYSTORE_INPUT" /></td>
  </tr>
  <tr>
    <td><label value="Keystore Type:" /></td>
    <td horz="MAX"><choice id="STORETYPE_INPUT" map="STORETYPE" /></td>
  </tr>
  <tr>
     <td><label value="Keystore Password:" /></td>
     <td horz="MAX"><password id="STOREPASS_INPUT" /></td>
  </tr>
  <tr>
     <td><label value="Signer Key Alias:" /></td>
     <td horz="MAX"><text id="ALIAS_INPUT" /></td>
  </tr>
  <tr>
     <td><label value="Signer Key Password:" /></td>
     <td horz="MAX"><password id="KEYPASS_INPUT" /></td>
  </tr>
</table>     

<tabpanel>

<tabpanel>..</tabpanel>

Defines an individual page for a tabbox.

Contents

(widgets | boxes)+

Appears In

tabpanels

Examples

<tabpanel>
  <groupbox>
     <hbox>
        <label value="Use your own schemas." />
     </hbox>
     <hbox>
         <label value="DTD Schema File:" /> 
         <text id="DTD_FILE_INPUT" /> 
     </hbox>
     <hbox>  
         <label value="XML Schema File:" />
         <text id="SCHEMA_FILE_INPUT" />
     </hbox>
  </groupbox>
</tabpanel>

<tabpanels>

<tabpanels>..</tabpanels>

Holds a set of pages in a tabbox.

Contents

tabpanel +

Appears In

tabbox

Examples

<tabpanels>

  <tabpanel id="mailtab">
    <button label="Check For Mail" />          
  </tabpanel>

  <tabpanel id="newstab">
    <button label="Clear News Buffer" />
  </tabpanel>

</tabpanels>

<td>

<td>..</td>

Defines a table cell inside a table row.

Attributes

horz=max | left | right, optional
Specifies the table cell's alignment. Default is left.

Contents

(widgets | boxes)+

Appears In

tr

Examples

<td><label value="Host:" /></td>

<td horz="MAX"><text id="HOST_INPUT" /></td>

<text>

<text/>

Defines a single line plain text input box. For multi line text input boxes see <textarea> .

Attributes

history=id , optional
Optional history to keep track of user input and to turn on auto-completion.

Appears In

boxes

Examples

<text id="HOST_INPUT" history="tomcat-upload.host" />
<text id="USER_INPUT" history="tomcat-upload.user" />

<textarea>

<textarea/>

Defines a multi line plain text input box. For single line text input boxes see <text> .

Appears In

boxes

Examples

<textarea id="SHORT_DESCR_INPUT" />
<textarea id="DEFAULT_DESCR_INPUT" />

<tr>

<tr>..</tr>

Defines a table row inside a HTML table that holds table data

Contents

td +

Appears In

table

Examples

<tr>
  <td><label value="User:" /></td>
  <td horz="MAX"><text id="USER_INPUT" /></td>
</tr>
<tr>
  <td><label value="Password:" /></td>
  <td horz="MAX"><password id="PASSWORD_INPUT" /></td>
</tr>

<tree>

<tree/>

Defines a tree to display data in a hierachy using Swing's JTree.

Attributes

datasource=path , required
Path to XML data to display in tree format.

Appears In

boxes

Examples

<tree datasource="data/menu.xml" />

<toolbar>

<toolbar>..</toolbar>

Defines a toolbar that holds buttons for fast single-click access.

Contents

( toolbarbutton | toolbarseparator )+

Appears In

xul

Examples

<toolbar id="PAM_TOOLBAR">

 <toolbarbutton command="install" label="Install"
                icon="INSTALL_ICON" accesskey="I"
                tooltip="Install Package To Web Start Cache" />

 <toolbarbutton command="refresh" label="Refresh"
                icon="REFRESH_ICON" accesskey="R"
                tooltip="Refresh Packages From Disk" />
</toolbar>

<toolbarbutton>

<toolbarbutton/>

Defines a push button inside a toolbar that can display text, icons, or both.

Attributes

label=string , optional
The button's text.
command=id , optional
The command to execute if the user's clicks on the button.
icon=id , optional
The button's icon.
tooltip=string , optional
The button's tool tip.
accesskey=char , optional
The button's access key.

Appears In

toolbar

Examples

<toolbarbutton command="install" label="Install"
               icon="INSTALL_ICON" accesskey="I"
               tooltip="Install Package To Web Start Cache" />

<toolbarbutton command="refresh" label="Refresh"
               icon="REFRESH_ICON" accesskey="R"
               tooltip="Refresh Packages From Disk" />

<toolbarseparator>

<toolbarseparator/>

Defines a toolbar separator that divides toolbar buttons into sections.

Appears In

toolbar

Examples

<toolbarseparator/>

<vbox>

<vbox>..</vbox>

Defines a box that lays out its children vertically, that is, from top to bottom.

Contents

(widgets | boxes)+

Appears In

xul , boxes

Examples

<vbox>
  <button label="Yes" />
  <button label="No" />
  <button label="Who cares?" />
</vbox>

<xul>

<xul>..</xul>

Luxor's one and only root tag. Note, you don't need to squeeze everything into one file. You can use as many documents as you like. Just start every document with <xul>.

Contents

( anim | command | icon | keyset | list | map | menubar | popup | portal | toolbar | boxes )+
More Quick Links: Batik SVG · Velocity · Python · Jython · Groovy · JDOM · dom4j · Jaxen · XDoclet · Eclipse SWT · wx4j · Java Gnome · KDE/Qt Java · Kaffe · gcj · SableVM · IKVM · Mono · DotGNU · Gtk# · Qt# · Parrot · Mozilla · Relax NG
Hosted by SourceForge SourceForge Logo For questions related to the use of Luxor, please consult our web pages. If that fails, the luxor-xul-user mailinglist might help.
Please send comments on our web pages and the development of Luxor to our public luxor-xul-develop mailinglist.
Maintained by Luxor Team
Copyright © 2001, 2002, 2003, 2004, 2005 Luxor Foundation