Difference between revisions of "UI Objects"

From HSYCO
Jump to navigation Jump to search
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
The index.hsm file is based on graphic objects having the following standard format:
+
[[Category:User Interface]]
−
(object_name <parameter1>; <parameterN>)
+
Interfaces are built using objects. Most objects allow interaction with the system, while some have an aesthetic purpose.
−
{{note|Errors in the index.hsm file are reported in the log file with the message:
 
−
Page Parser: Syntax Error, line: nnn
 
−
}}
 
  
−
When errors are detected, the page is not served to the Web browser.
+
Each object has a series of '''parameters''' to set its position, size, address and so on.
−
File parsing stops at the first error, so only the first line with errors is reported in the log file.
+
While these parameters are set by modifying the project (through the [[Project Editor]] or by modifying the index.hsm), some objects have attributes that can be modified without reloading the project. These are called '''UI Attributes''' and are accessible through UISet calls (from the events environment or Java).  
−
Each type of graphic object could require one or more parameters, separated by the “;” character. Empty lines or blank spaces are ignored.
+
Objects with UI Attributes are identified with an '''id'''.
−
{{note|Changes to index.hsm cause an automatic page reload on the connected Web browsers.}}
 
  
−
You can insert comment lines, which are ignored. A comment line starts with the “#” character at the beginning of the line.
+
== Syntax ==
−
{{note|Names in index.hsm are case sensitive, small and capital letters are significant; all objects defined in the standard skin have names with lower-case letters.}}
+
Objects are declared in the '''index.hsm''' file with the following format:
 +
(object_name <parameter1>; ... <parameterN>)
 +
and for objects with an id:
 +
(object_name!<id> <parameter1>; ... <parameterN>)
  
−
{{note|Some objects support a variant called '''identified version''' to allow the '''!id''' dynamic modification of the text, visibility, color several other attributes with the uiSet() Java method or the UISET action.}}
+
== Redirect Variables ==
 +
Redirect variables allow UI Objects to be linked dynamically to a source.
 +
For more information see [[Redirect variables]].
  
−
The identified objects should be defined with an id string that is unique in the index.hsm file. The presence of more objects with the same id can cause undesired effects.
+
== List of UI Objects ==
−
To identify an object, append a ! character and the id at the end of the object type, for example:
+
<table style="width:100%; max-width:800px">
−
(text!mytextid r1c1; This is my identified text object)
+
<tr>
 +
<td style="vertical-align:top; width:33%">
 +
<DynamicPageList>
 +
category = UI Objects
 +
count=30
 +
ordermethod = sortkey
 +
order = ascending
 +
</DynamicPageList>
 +
</td>
  
−
List of UI Objects
+
<td style="vertical-align:top; width:33%">
−
For a complete list of UI Objects, see [[Category:UI Objects|List of UI Objects]]
+
<DynamicPageList>
 +
category = UI Objects
 +
offset=30
 +
count=30
 +
ordermethod = sortkey
 +
order = ascending
 +
</DynamicPageList>
 +
</td>
 +
 
 +
<td style="vertical-align:top; width:33%">
 +
<DynamicPageList>
 +
category = UI Objects
 +
offset=60
 +
ordermethod = sortkey
 +
order = ascending
 +
</DynamicPageList>
 +
</td>
 +
</tr></table>

Latest revision as of 09:34, 20 June 2020

Interfaces are built using objects. Most objects allow interaction with the system, while some have an aesthetic purpose.

Each object has a series of parameters to set its position, size, address and so on. While these parameters are set by modifying the project (through the Project Editor or by modifying the index.hsm), some objects have attributes that can be modified without reloading the project. These are called UI Attributes and are accessible through UISet calls (from the events environment or Java). Objects with UI Attributes are identified with an id.

Syntax

Objects are declared in the index.hsm file with the following format: 

(object_name <parameter1>; ... <parameterN>)

and for objects with an id: 

(object_name!<id> <parameter1>; ... <parameterN>)

Redirect Variables

Redirect variables allow UI Objects to be linked dynamically to a source. For more information see Redirect variables.

List of UI Objects

Retrieved from "https://wiki.hsyco.com/3.8/index.php?title=UI_Objects&oldid=8821"