xBase and Clipper language compatible compiler
PrevNext

Class UIFORM

Name

UIFORM  --  Class for manipulate form in XFL format. This format is described is section XFL forms.

Synopsis

 UIForm(<fileName>,<parent>)	--> UIForm object

Description

Class UIForm

Attributes

<className> - Class name. Value should be "UIForm".
<parent> - Window object. Parent window.
<fileName> - String. Form file name.
<root> - XMLTag 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.

Methods

ACTIONHANDLER Run actions rule.
CREATEWIDGET Create widget from the tag.
GETPROPERTYVALUE Get the property from the widget.
I18N Returns localized string.
PARSE Parse htmlParser object. This method is internal and called from methods parseFile() or parseString().
PARSEFILE Parse form from file.
PARSESTRING Parse form from string.
SETACTION Set action described in tag &lt;rule&gt;.
SETPREACTION Set pre-action described in form header and run it.
SETPROPERTY Set widget property described in given tag.
SUBACTIONHANDLER Run one action.
UIFORM Constructor. Init form object.

Method UIFORM:ACTIONHANDLER()

 actionHandler(<id>,[<addVal>])

<id>

- Number or object XMLTag. Index of rule in <actions> array or rule tag contained several actions.

<addVal>

- Any type. Returned value.

Returns :NIL

Method UIFORM:CREATEWIDGET()

 createWidget(<tag>,[<parent>])	--> <oWidget>

<tag>

- Object XMLTag. Tag described widget.

<parent>

- Object. Widget, which contains this widget (parent widget).

Returns :

Object of created widget.

Method UIFORM:GETPROPERTYVALUE()

 getPropertyValue(<tagObj>)	--> <oVal>

<tagObj>

- Object XMLTag. Tag &lt;property&gt; contained widget name and property name.

Returns :

Property value.

Method UIFORM:I18N()

 i18n(<str>)	--> <sLocalString>

<str>

- String. Original form string.

Returns :

Localized string.

Method UIFORM:PARSE()

 parse()	--> <oWin>

Returns :

Returns created object as window object filled by widgets.

Method UIFORM:PARSEFILE()

 parseFile()	--> <oWin>

Returns :

Returns created object as window object filled by widgets.

Method UIFORM:PARSESTRING()

 parseString(<str>)	--> <oWin>

<str>

- String. String contained form in XFL format.

Returns :

Returns created object as window object filled by widgets.

Method UIFORM:SETACTION()

 setAction(<tag>,[<lObj>])

<tag>

- Object XMLTag. Tag described action (&lt;rule&gt;).

<lObj>

- Widget object. Widget received signal.

Returns :NIL

Method UIFORM:SETPREACTION()

 setPreAction(<tag>,[<lObj>])

<tag>

- Object XMLTag. Header tag (&lt;head&gt;).

<lObj>

- Widget object. Widget received signal.

Returns :NIL

Method UIFORM:SETPROPERTY()

 setProperty(<tag>,[<obj>],[<value>])

<tag>

- Object XMLTag. 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.

Returns :NIL

Method UIFORM:SUBACTIONHANDLER()

 subActionHandler(<tag>,[<addVal>])

<tag>

- XMLTag object. Tag described one action.

<addVal>

- Any type. Returned value.

Returns :NIL

Method UIFORM:UIFORM()

 UIForm(<fileName>,<parent>)	--> UIForm object

<fileName>

- String. Name of form file.

<parent>

- Window object. Parent window.

Returns :NIL

Example:

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

Platforms

No dependies of platform.

PrevHomeNext
Class UIFONTUpClass UIFRAME