Difference between revisions of "Download (UI Object)"
Jump to navigation
Jump to search
Line 1: | Line 1: | ||
{{UI Object Header}} | {{UI Object Header}} | ||
+ | This object is used to download files from the HSYCO Server to the local storage of the user's client device. | ||
+ | :[[File:UI Object download.png]] | ||
+ | |||
+ | |||
A button used to execute a download callback (a customized Java code or an event for the EVENTS interpreter). | A button used to execute a download callback (a customized Java code or an event for the EVENTS interpreter). | ||
Pressing this button, HSYCO calls the method: | Pressing this button, HSYCO calls the method: | ||
Line 7: | Line 11: | ||
defined in EVENTS. | defined in EVENTS. | ||
− | |||
− | |||
For a custom image version, see [[DownloadImage]]. | For a custom image version, see [[DownloadImage]]. |
Revision as of 22:42, 13 February 2017
This object is used to download files from the HSYCO Server to the local storage of the user's client device.
A button used to execute a download callback (a customized Java code or an event 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 custom image version, see DownloadImage.
For an object with a list of downloads, see DownloadList.
Contents
Parameters
- id: the object's ID, used by UISets. Required
- 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
- value: value passed to the Java callback method and event in EVENTS
Syntax
(download!<id> <position>; <color>; <label>; <value>)
E.g.
(download!user1 r3c1; gr; label; myfile)
UI Attributes
Common attributes
Name | Value | Description |
---|---|---|
pos | x<x>y<y> | Position specified as x/y coordinates. E.g. x-5y10 |
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) |
rotation | 0 ... 360 | Object rotation in degrees. Images are rotated around the center point, all other objects are rotated around the top left corner |
Button attributes
Name | Value | Description |
---|---|---|
style | red,green,blue... | Set the button's style (color). Styles vary depending on the selected skin |
enabled | true | Default. Enable the button |
false | Disable the button |
Label attributes
Name | Value | Description |
---|---|---|
label | <string> | Label's text. Can contain HTML tags |
fontfamily | <family name> | A prioritized list of font family names |
fontsize | <size> | Font size in pixels. E.g. 15px |
fontcolor | <CSS color> | Font color |
fontstyle | normal | Normal font style, default |
italic | Italic font style | |
oblique | Oblique font style | |
fontweight | normal | Normal characters, default |
bold | Thick characters | |
bolder | Thicker characters | |
lighter | Lighter characters | |
100 ... 900 | Defines from thin to thick characters. 400 is the same as normal, and 700 is the same as bold |
Download attributes
Name | Value | Description |
---|---|---|
value | <string> | Set the value to be sent when clicked |