Difference between revisions of "User"
Jump to navigation
Jump to search
| Line 22: | Line 22: | ||
== Parameters == | == Parameters == | ||
*'''id''': the object's ID, used by UISets. Required | *'''id''': the object's ID, used by UISets. Required | ||
| + | *'''name''': name passed to the Java callback method and event in EVENTS | ||
| + | *'''param''': parameter passed to the Java callback method and event in EVENTS | ||
*'''position''': the object's position. Use the pixels or rows and columns coordinates format | *'''position''': the object's position. Use the pixels or rows and columns coordinates format | ||
*'''color''': the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass) | *'''color''': the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass) | ||
| − | |||
*'''label''': the text label on the button. It can contain HTML tags | *'''label''': the text label on the button. It can contain HTML tags | ||
| + | *'''repeat''': if true, the command will be repeat every second | ||
== Syntax == | == Syntax == | ||
| − | (user[!<id>] < | + | (user[!<id>] <name>; <param>; <position>; <color>; <text>) |
| − | (usermini[!<id>] < | + | (usermini[!<id>] <name>; <param>; <position>; <color>; <text>) |
| − | |||
| − | |||
| + | (usermicro[!<id>] <name>; <param>; <position>; <color>; <text>) | ||
| + | |||
E.g. | E.g. | ||
| − | (user! | + | (user!user1 name; param; r3c1; gr; label; enabled) |
| − | (usermini | + | (usermini!user1 name; param; r3c1; b; label;) |
| − | (usermicro | + | (usermicro!user1 name; param; x0y10; r; label;) |
== UI Attributes == | == UI Attributes == | ||
{{UI Object Attributes (Common)}} | {{UI Object Attributes (Common)}} | ||
{{UI Object Attributes (Button)}} | {{UI Object Attributes (Button)}} | ||
Revision as of 12:32, 27 January 2014
For a description and a complete list of UI Objects, see A button used to execute customized Java code or generate events for the EVENTS interpreter. Pressing this button, HSYCO calls the method:
- userCommand(String name, String param)
in the user.class class. HSYCO also executes all actions associated to the event:
- USER name=param
defined in EVENTS. For a tutorial on how to use this object see Working with User objects.
It has several colors (depending on the skin) and three different sizes:
- user (standard size)
- usermini (medium size)
- usermicro (small size)
For a custom image version, see UserImage.
For an object with a list of user commands, see UserList.
Parameters
- id: the object's ID, used by UISets. Required
- name: name passed to the Java callback method and event in EVENTS
- param: parameter passed to the Java callback method and event in EVENTS
- position: the object's position. Use the pixels or rows and columns coordinates format
- color: the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass)
- label: the text label on the button. It can contain HTML tags
- repeat: if true, the command will be repeat every second
Syntax
(user[!<id>] <name>; <param>; <position>; <color>; <text>) (usermini[!<id>] <name>; <param>; <position>; <color>; <text>) (usermicro[!<id>] <name>; <param>; <position>; <color>; <text>)
E.g.
(user!user1 name; param; r3c1; gr; label; enabled) (usermini!user1 name; param; r3c1; b; label;) (usermicro!user1 name; param; x0y10; r; label;)
UI Attributes
Common attributes
| Name | Value | Description |
|---|---|---|
| pos | x<x>y<y> | Position specified as x/y coordinates. E.g. x-5y10 |
| r<r>c<c> | Position specified as row/column. E.g. r1c2 | |
| visible | true | Default. Show the object |
| false | Hide the object | |
| blink | true | slow | Blink the object at a slow speed |
| fast | Blink the object at a fast speed | |
| false | Stop the blinking | |
| opacity | 0.0 ... 1.0 | Object opacity from 0 (not visible) to 1 (fully visible) |
Button attributes
| Name | Value | Description |
|---|---|---|
| color | r,g,b... | Set the button's color. Colors vary depending on the selected skin |
| enabled | true | Default. Enable the button |
| false | Disable the button |
