Difference between revisions of "UserImage"

From HSYCO
Jump to navigation Jump to search
m (Hsyco moved page Userimage to UserImage)
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Category:UI Objects]]
+
{{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
 +
*'''parameter''': 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 "enabled", the command will be repeat every second
 +
 
 +
== Syntax ==
 +
(userimage[!<id>] <image's filename>; <position>; <width>; <height>; <name>; <parameter>; <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)}}
 +
{{UI Object Attributes (Label)}}
 +
{{UI Object Attributes (Image)}}
 +
=== UserImage attributes ===
 +
{| class="wikitable"
 +
!Name
 +
!Value
 +
!Description
 +
|-
 +
|name
 +
|<string>
 +
|Set the user object's name value
 +
|-
 +
 
 +
|rowspan="2"|parameter
 +
|<string>
 +
|Set the user object's parameter value
 +
|-
 +
|coordinates
 +
|Set the object to send the X,Y coordinates of the point where the user clicks (or drags). E.g. for x=107,y=52 the server will receive ''107,52''
 +
|-
 +
 
 +
|rowspan="2"|repeat
 +
|true
 +
|Set repeat mode to enabled
 +
|-
 +
|false
 +
|Set repeat mode to disabled
 +
|-
 +
 
 +
|interval
 +
|<number>
 +
|Set the time in milliseconds between repeats (default is 1000)
 +
|}

Latest revision as of 18:34, 3 October 2016

Note  For a description and a complete list of UI Objects, see UI Objects.

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
  • parameter: 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 "enabled", the command will be repeat every second

Syntax

(userimage[!<id>] <image's filename>; <position>; <width>; <height>; <name>; <parameter>; <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
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

Image attributes

img <full url (http://...)> | <path relative to /img/> Changes the image source. Set to "" (empty string) to load the empty picture.
draw <draw instructions> Draws the image. See the Draw API

e.g.: line(0,100,20,50,blue);line(50,50,70,70,'255,10,150');

UserImage attributes

Name Value Description
name <string> Set the user object's name value
parameter <string> Set the user object's parameter value
coordinates Set the object to send the X,Y coordinates of the point where the user clicks (or drags). E.g. for x=107,y=52 the server will receive 107,52
repeat true Set repeat mode to enabled
false Set repeat mode to disabled
interval <number> Set the time in milliseconds between repeats (default is 1000)
Retrieved from "http://wiki.hsyco.com/3.5.1/index.php?title=UserImage&oldid=6407"