Difference between revisions of "UserList"

From HSYCO
Jump to navigation Jump to search
Line 10: Line 10:
 
For a tutorial on how to use this object see [[Working with User objects]].
 
For a tutorial on how to use this object see [[Working with User objects]].
  
[[File:UI Object selectpanel.png]]
+
[[File:UI Object userlist.png]]
  
 
== Parameters ==
 
== Parameters ==
Line 23: Line 23:
  
 
== Syntax ==
 
== Syntax ==
  (selectpanel!<id> <name>; <parameters>; <position>; <width>; <height>; <css>)
+
  (userlist!<id> <name>; <parameters>; <position>; <width>; <height>; <css>)
 
E.g.
 
E.g.
 
  (userlist!myuserlist name; p1,p2,p3; user one, user two, user three; r1c1; 220; 224)
 
  (userlist!myuserlist name; p1,p2,p3; user one, user two, user three; r1c1; 220; 224)

Revision as of 10:51, 6 February 2014

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

A panel with a list of user buttons, used to execute customized Java code or generate events for the EVENTS interpreter. Pressing an item of the list, 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. If the repeat parameter is "true", a long press will repeat the request every second.

For a tutorial on how to use this object see Working with User objects.

UI Object userlist.png

Parameters

  • id: the object's ID, used by UISets
  • name: name passed to the Java callback method and event in EVENTS
  • parameters: comma-separated list of the parameters passed to the Java callback method and event in EVENTS
  • labels: comma-separated list of labels corresponding to the parameters. If missing, parameters will be shown instead
  • position: the object's position. Use the pixels or rows and columns coordinates format
  • size: the panel's width and height
  • css: optional. Defines the CSS style for the input field
  • repeat: if true, the command will be repeat every second

Syntax

(userlist!<id> <name>; <parameters>; <position>; <width>; <height>; <css>)

E.g.

(userlist!myuserlist name; p1,p2,p3; user one, user two, user three; r1c1; 220; 224)

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

UserList attributes

Name Value Description
enabled true Panel is enabled
false Panel is disabled
focus true Focus the panel. Only a single object should have this attribute at "true".
false Reset focus
error true Manually shows an error feedback on the panel.
false Hides the error visualization.
name string UserList name
params comma-separated list of strings Parameters
labels comma-separated list of strings UserList labels
width number of pixels Set the panel's width
height number of pixels Set the panel's height