$CLASSNAME$
	UIForm
$SUMMARY$
	Class UIForm
$LANG_RU$
	 UIForm
$ABOUT$
	Class for manipulate form in XFL format. This format is described is section <link linkend="classxflforms">XFL forms</link>.
$LANG_RU$
	      XFL.      <link linkend="classxflforms"> XFL</link>.
$SYNTAX$
	UIForm(<fileName>,<parent>)	--> UIForm object
$LANG_RU$
	UIForm(<fileName>,<parent>)	-->  UIForm
$ATTRIBUTES$
	<className>	- Class name. Value should be "UIForm".
	<parent>	- Window object. Parent window.
	<fileName>	- String. Form file name.
	<root>		- <link linkend="classxmltag">XMLTag</link> object. Root element of form.
	<widgets>	- Associated array. Array of named widgets.
	<names>		- Array. Array of widget names.
	<actions>	- Array. Array of form actions.
	<src>		- Object. Object of class htmlParser.
	<locale>	- Associated array. Array of localization strings.
$LANG_RU$
	<className>	-  . : "UIForm".
	<parent>	-  .  .
	<fileName>	- .   .
	<root>		-  <link linkend="classxmltag">XMLTag</link>.   .
	<widgets>	-  .   .
	<names>		- .  ͣ .
	<actions>	- .   .
	<src>		- .   htmlParser.
	<locale>	-  .    .

$METHODNAME$
	UIForm()
$SUMMARY$
	Constructor. Init form object.
$LANG_RU$
	.   .
$SYNTAX$
	UIForm(<fileName>,<parent>)	--> UIForm object
$ARGUMENTS$
	<fileName>	- String. Name of form file.
	<parent>	- Window object. Parent window.
$LANG_RU$
	<fileName>	- .   .
	<parent>	-  .  .
$ENDMETHOD$

$METHODNAME$
	parseFile()
$SUMMARY$
	Parse form from file.
$LANG_RU$
	  .
$SYNTAX$
	parseFile()	--> <oWin>
$RETURNS$
	Returns created object as window object filled by widgets.
$LANG_RU$
	         .
$ENDMETHOD$

$METHODNAME$
	parseString()
$SUMMARY$
	Parse form from string.
$LANG_RU$
	 ,   .
$SYNTAX$
	parseString(<str>)	--> <oWin>
$ARGUMENTS$
	<str>		- String. String contained form in XFL format.
$LANG_RU$
	<str>		- . ,     XFL.
$RETURNS$
	Returns created object as window object filled by widgets.
$LANG_RU$
	         .
$ENDMETHOD$

$METHODNAME$
	parse()
$SUMMARY$
	Parse htmlParser object. This method is internal and called from methods parseFile() or parseString().
$LANG_RU$
	  htmlParser.        parseFile()  parseString().
$SYNTAX$
	parse()	--> <oWin>
$RETURNS$
	Returns created object as window object filled by widgets.
$LANG_RU$
	         .
$ENDMETHOD$

$METHODNAME$
	createWidget()
$SUMMARY$
	Create widget from the tag.
$LANG_RU$
	 ,   .
$SYNTAX$
	createWidget(<tag>,[<parent>])	--> <oWidget>
$ARGUMENTS$
	<tag>		- Object <link linkend="classxmltag">XMLTag</link>. Tag described widget.
	<parent>	- Object. Widget, which contains this widget (parent widget).
$LANG_RU$
	<tag>		-  <link linkend="classxmltag">XMLTag</link>. ,  .
	<parent>	- . -,   .
$RETURNS$
	Object of created widget.
$LANG_RU$
	  .
$ENDMETHOD$

$METHODNAME$
	setProperty()
$SUMMARY$
	Set widget property described in given tag.
$LANG_RU$
	  ,   .
$SYNTAX$
	setProperty(<tag>,[<obj>],[<value>])
$ARGUMENTS$
	<tag>		- Object <link linkend="classxmltag">XMLTag</link>. Property tag.
	<obj>		- Object. By default object is defined by its name given in the tag .
	<value>		- Any type. Property value. By default value is taken from the tag.
$LANG_RU$
	<tag>		-  <link linkend="classxmltag">XMLTag</link>. ,  .
	<obj>		- .     ,   .
	<value>		-  .  .     .
$ENDMETHOD$

$METHODNAME$
	getPropertyValue()
$SUMMARY$
	Get the property from the widget.
$LANG_RU$
	   .
$SYNTAX$
	getPropertyValue(<tagObj>)	--> <oVal>
$ARGUMENTS$
	<tagObj>	- Object <link linkend="classxmltag">XMLTag</link>. Tag &lt;property&gt; contained widget name and property name.
$LANG_RU$
	<tagObj>	-  <link linkend="classxmltag">XMLTag</link>.  &lt;property&gt;,      .
$RETURNS$
	Property value.
$LANG_RU$
	 .
$ENDMETHOD$

$METHODNAME$
	setAction()
$SUMMARY$
	Set action described in tag &lt;rule&gt;.
$LANG_RU$
	 ,    &lt;rule&gt;.
$SYNTAX$
	setAction(<tag>,[<lObj>])
$ARGUMENTS$
	<tag>		- Object <link linkend="classxmltag">XMLTag</link>. Tag described action (&lt;rule&gt;).
	<lObj>		- Widget object. Widget received signal.
$LANG_RU$
	<tag>		-  <link linkend="classxmltag">XMLTag</link>. ,   (&lt;rule&gt;).
	<lObj>		-  . ,  .
$ENDMETHOD$

$METHODNAME$
	setPreAction()
$SUMMARY$
	Set pre-action described in form header and run it.
$LANG_RU$
	  ,       .
$SYNTAX$
	setPreAction(<tag>,[<lObj>])
$ARGUMENTS$
	<tag>		- Object <link linkend="classxmltag">XMLTag</link>. Header tag (&lt;head&gt;).
	<lObj>		- Widget object. Widget received signal.
$LANG_RU$
	<tag>		-  <link linkend="classxmltag">XMLTag</link>.    (&lt;head&gt;).
	<lObj>		-  . ,  .
$ENDMETHOD$

$METHODNAME$
	actionHandler()
$SUMMARY$
	Run actions rule.
$LANG_RU$
	 .
$SYNTAX$
	actionHandler(<id>,[<addVal>])
$ARGUMENTS$
	<id>		- Number or object <link linkend="classxmltag">XMLTag</link>. Index of rule in <actions> array or rule tag contained several actions.
	<addVal>	- Any type. Returned value.
$LANG_RU$
	<id>		-    <link linkend="classxmltag">XMLTag</link>.     <actions>   ,    .
	<addVal>	-  .  .
$ENDMETHOD$

$METHODNAME$
	subActionHandler()
$SUMMARY$
	Run one action.
$LANG_RU$
	  
$SYNTAX$
	subActionHandler(<tag>,[<addVal>])
$ARGUMENTS$
	<tag>		- <link linkend="classxmltag">XMLTag</link> object. Tag described one action.
	<addVal>	- Any type. Returned value.
$LANG_RU$
	<tag>		-  <link linkend="classxmltag">XMLTag</link>. ,  .
	<addVal>	-  .  .
$ENDMETHOD$

$METHODNAME$
	i18n()
$SUMMARY$
	Returns localized string.
$LANG_RU$
	  .
$SYNTAX$
	i18n(<str>)	--> <sLocalString>
$ARGUMENTS$
	<str>		- String. Original form string.
$LANG_RU$
	<str>		- .   .
$RETURNS$
	Localized string.
$LANG_RU$
	 .
$ENDMETHOD$

$EXAMPLES$
	form := UIForm( fileName )
	win  := form:parseFile()
	if win == NIL
		CANCEL
	endif
	win:show()

$PLATFORMS$
	No dependies of platform.
$LANG_RU$
	   .
$SEEALSO$
$AUTHOR$
	Andrey Cherepanov <skull@eas.lrn.ru>
$LANG_RU$
	  <skull@eas.lrn.ru>
$LASTDATE$
