Difference between revisions of "UserImage"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
| − | {{UI Object Header}}[[ | + | {{UI Object Header}} |
| + | A clickable image similar to the [[user|user object]] 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]]. | ||
| + | A long press will repeat the request every second. | ||
| + | |||
| + | For an object with a list of user commands, see [[UserList]]. | ||
| + | |||
| + | == Parameters == | ||
| + | {{UI Object Parameter (ID)}} | ||
| + | {{UI Object Parameter (image)}} | ||
| + | {{UI Object Parameter (position)}} | ||
| + | *'''size''':the image's width and height | ||
| + | *'''name''': name passed to the Java callback method and event in EVENTS | ||
| + | *'''param''': parameter passed to the Java callback method and event in EVENTS | ||
| + | *'''label''': the text label next to the image. It can contain HTML tags | ||
| + | *'''css''':the label's css attributes | ||
| + | *'''repeat''': if true, the command will be repeat every second | ||
| + | |||
| + | == Syntax == | ||
| + | (userimage[!<id>] <image's filename>; <position>; <width>; <height>; <name>; <param>; <label>; <css>; <repeat>) | ||
| + | E.g. | ||
| + | (userimage!user1 myimage.png; r8c7; 100; 100; name; param; Label; (font-style:italic; top:-15px)) | ||
| + | == UI Attributes == | ||
| + | {{UI Object Attributes (Common)}} | ||
| + | {{UI Object Attributes (Button)}} | ||
Revision as of 15:20, 28 January 2014
For a description and a complete list of UI Objects, see A clickable image similar to the user object 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. A long press will repeat the request every second.
For an object with a list of user commands, see UserList.
Parameters
- id: the object's ID, used by UISets
- image: image filename
- position: the object's position. Use the pixels or rows and columns coordinates format
- size:the image's width and height
- name: name passed to the Java callback method and event in EVENTS
- param: parameter passed to the Java callback method and event in EVENTS
- label: the text label next to the image. It can contain HTML tags
- css:the label's css attributes
- repeat: if true, the command will be repeat every second
Syntax
(userimage[!<id>] <image's filename>; <position>; <width>; <height>; <name>; <param>; <label>; <css>; <repeat>)
E.g.
(userimage!user1 myimage.png; r8c7; 100; 100; name; param; Label; (font-style:italic; top:-15px))
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 |
