PackageTop Level
Classpublic class XULWindow
InheritanceXULWindow Inheritance Object

Represents a XUL panel in JSFL. The object can be set up and then used to invoke a XUL panel without writing an actual XUL file. The XML can be generated purely in JSFL and passed in, or you can use convenience methods to add various controls without having to writing XML strings in JSFL.

For full-on XUL reference, the Mozilla document is here: https://developer.mozilla.org/en/XUL_Reference. Note that Flash supports a very small subset of this.



Public Methods
 MethodDefined By
  
addCheckbox(label:String, id:String, checked:Boolean):void
Creates a check box control with a label.
XULWindow
  
addLabel(label:String, control:String = null):void
Adds a basic text label.
XULWindow
  
addListBox(id:String, items:Array, width:Number, rows:Number):void
Creates a List Box.
XULWindow
  
addRadioGroup(id:String, items:Array):void
Creates a vertically-oriented group of radio buttons.
XULWindow
  
addTextBox(id:String, value:String):void
Adds a text box in which the user can type.
XULWindow
  
closeHBox():void
Closes a previously open <hbox>, enclosing all intermediate controls within an hbox node.
XULWindow
  
closeVBox():void
Closes a previously open <vbox>, enclosing all intermediate controls within an vbox node.
XULWindow
  
create(xul:String):Object
Creates a XUL window panel.
XULWindow
  
openHBox():void
Opens an <hbox> nodes so that all controls added after this method call are contained within the hbox.
XULWindow
  
openVBox():void
Opens an <vbox> nodes so that all controls added after this method call are contained within the vbox.
XULWindow
Public Constants
 ConstantDefined By
  ACCEPT : String = accept
[static] Static constant alias for the name of the "accept" button.
XULWindow
  CANCEL : String = cancel
[static] Static constant alias for the name of the "cancel" button.
XULWindow
Method Detail
addCheckbox()method
public function addCheckbox(label:String, id:String, checked:Boolean):void

Creates a check box control with a label.

Parameters

label:String — String for the label next to the check box.
 
id:String — String for the id of the checkbox. This is the name of the property on the returned object with data in it
 
checked:Boolean — Whether initially checked or not.

addLabel()method 
public function addLabel(label:String, control:String = null):void

Adds a basic text label.

Parameters

label:String — The text to display in the label.
 
control:String (default = null) — The id of the associated control. If the user clicks on the label, focus is moved to the control. (Supposedly)

addListBox()method 
public function addListBox(id:String, items:Array, width:Number, rows:Number):void

Creates a List Box.

Parameters

id:String — The name of the property on the returned object with data in it.
 
items:Array — Array of Objects specifying the items to display. The Objects should take on the following form: {label:"Text to display", value:"valueOfThisItem", selected:true} label is required. If value is omitted, the label is returned as the selected value.
 
width:Number — The width in pixels. Defaults to 200.
 
rows:Number — The number of rows to display in the viewable area. If the rows is less than the number of items in the list, scrollbars will appear. If this parameter is omitted, the length of the Array passed in to items is used.

addRadioGroup()method 
public function addRadioGroup(id:String, items:Array):void

Creates a vertically-oriented group of radio buttons.

Parameters

id:String — The name of the property on the returned object with data in it.
 
items:Array — Array of Objects specifying the buttons to display. The Objects should take on the following form: {label:"Text to display", value:"valueOfThisButton", selected:true} label is required. If value is omitted, the label is returned as the selected value.

addTextBox()method 
public function addTextBox(id:String, value:String):void

Adds a text box in which the user can type.

Parameters

id:String — The name of the property on the returned data object.
 
value:String — The default value contained within the text box.

closeHBox()method 
public function closeHBox():void

Closes a previously open <hbox>, enclosing all intermediate controls within an hbox node.

See also

closeVBox()method 
public function closeVBox():void

Closes a previously open <vbox>, enclosing all intermediate controls within an vbox node.

See also

create()method 
public function create(xul:String):Object

Creates a XUL window panel. It is attached to the current document

Parameters

xul:String — A String of raw XUL to create. If null, the window will be created according to the various control creation methods. If not null, any other method calls would be ignored and the passed-in XUL is used.

Returns
Object — An object containing information about the user input. The object will have a property called dismiss that contains the name of the button that was clicked (either XULWindow.ACCEPT or XULWindow.CANCEL). It will also have other properties, named after the various controls' id values. The value contained by these properties will be the value associated with the input of the control.
openHBox()method 
public function openHBox():void

Opens an <hbox> nodes so that all controls added after this method call are contained within the hbox. Should be ultimately terminated with closeHBox

See also

openVBox()method 
public function openVBox():void

Opens an <vbox> nodes so that all controls added after this method call are contained within the vbox. Should be ultimately terminated with closeVBox

See also

Constant Detail
ACCEPTConstant
public static const ACCEPT:String = accept

Static constant alias for the name of the "accept" button.

CANCELConstant 
public static const CANCEL:String = cancel

Static constant alias for the name of the "cancel" button.