Difference between revisions of "Select"

From HSYCO
Jump to navigation Jump to search
Line 1: Line 1:
 
{{UI Object Header}}
 
{{UI Object Header}}
−
Input field that allows the user to input a text.
+
Select field that allows the user to select a value from a list. Clicking on the field will open a popup with a [[SelectPanel|select panel]].
 
Can be used with a [[submit]] button.
 
Can be used with a [[submit]] button.
  
Line 7: Line 7:
 
For a tutorial on using this object, see [[Working with Forms]]
 
For a tutorial on using this object, see [[Working with Forms]]
  
−
[[File:UI Object input.png]]
+
[[File:UI Object select.png]]
  
 
== Parameters ==
 
== Parameters ==
 
*'''id''': the object's ID, used by UISets
 
*'''id''': the object's ID, used by UISets
 
*'''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
 +
*'''values''': comma-separated list of values. When selecting an item from the list, the corresponding value from this list is sent
 +
*'''labels''': comma-separated list of labels corresponding to the values. If missing, values will be shown instead
 
*'''css''': optional. Defines the CSS style for the input field
 
*'''css''': optional. Defines the CSS style for the input field
−
*'''type''': optional. Defines the input type, see [[#Input attributes|inputtype UI attribute]]
 
  
 
== Syntax ==
 
== Syntax ==
−
  (input!id <position>; [<css>]; [<type>])
+
  (select!<id> <position>; <values>; <labels>; <css>)
 
E.g.
 
E.g.
−
  (input!myinput r1c1; color:blue; password)
+
  (select!myselect r1c1; 1,2,3; one,two,three;)
  
 
== UI Attributes ==
 
== UI Attributes ==
Line 30: Line 31:
 
|-
 
|-
  
−
|rowspan="3"|inputtype
+
|value
−
|input
+
|string
−
|Default behaviour
+
|Select value
−
|-
 
−
|multiline
 
−
|for input fields with more than a line. Use the height attribute on the css parameter to set the size
 
−
|-
 
−
|password
 
−
|hides typed characters
 
 
|-
 
|-
  
−
|value
+
|values
−
|string
+
|comma-separated list of strings
−
|Input value
+
|Select values
 
|-
 
|-
  
−
|maxlenght
+
|labels
−
|number
+
|comma-separated list of strings
−
|Specify the maximum length that can be typed
+
|Select labels
 
|-
 
|-
  
−
|rowspan="2"|eraseicon
+
|rowspan="2"|multi
 
|true
 
|true
−
|Show an erase icon that can be clicked to quickly erase the input's content
+
|Can select multiple values. The value sent to the server will be a comma-separated list of the selected values
 
|-
 
|-
 
|false
 
|false
−
|Default: no erase icon
+
|Default behaviour: only a single value can be selected
 
|-
 
|-
  
−
|style
+
|rowspan="2"|notnull
−
|CSS style
+
|true
−
|Set the field's CSS style
+
|Value can't be null
 
|-
 
|-
−
 
+
|false
−
|helptext
+
|Default. Value can be null
−
|string
 
−
|Text to show when the field is empty
 
−
|-
 
−
 
 
−
|changedelay
 
−
|number
 
−
|Sets the delay in milliseconds by which changes are detected. If the field is working in autosend mode, this value determines the delay between the last button press and the value being sent to the server
 
−
|-
 
−
 
 
−
|validatekey
 
−
|regular expression
 
−
|A regular expression to be validated on a keypress. E.g. "[a-z]" will allow only lowercase letters
 
−
|-
 
−
 
 
−
|validatevalue
 
−
|regular expression
 
−
|A regular expression to be validated before the value is sent to the server. If the expression doesn't match the value, the previous value will be restored and the input will flash in red
 
 
|-
 
|-
  
 
|}
 
|}

Revision as of 09:55, 29 January 2014

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

Select field that allows the user to select a value from a list. Clicking on the field will open a popup with a select panel. Can be used with a submit button.

Requires an ID.

For a tutorial on using this object, see Working with Forms

UI Object select.png

Parameters

  • id: the object's ID, used by UISets
  • position: the object's position. Use the pixels or rows and columns coordinates format
  • values: comma-separated list of values. When selecting an item from the list, the corresponding value from this list is sent
  • labels: comma-separated list of labels corresponding to the values. If missing, values will be shown instead
  • css: optional. Defines the CSS style for the input field

Syntax

(select!<id> <position>; <values>; <labels>; <css>)

E.g. 

(select!myselect r1c1; 1,2,3; one,two,three;)

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

Field attributes

Name Value Description
enabled true Field is enabled
false Field is disabled
autosend true Automatically sends the value on changes. It's the default behaviour when there are no submit objects on the page or in a parent container (if the field is inside a container).
false Won't send the value on changes. It's the default behaviour when there's a submit object on the page or in a parent container.
focus true Focus the field. Only a single object should have this attribute at "true".
false Reset focus
rollback true Restores the previously saved value.
rollbackenabled true Automatically restores the previous value on an error (if the value isn't valid or the remote request resolved in an error).
false Won't restore the value on errors.
error true Manually shows an error feedback on the field (won't modify the current field value).
false Hides the error visualization.

Input attributes

Name Value Description
value string Select value
values comma-separated list of strings Select values
labels comma-separated list of strings Select labels
multi true Can select multiple values. The value sent to the server will be a comma-separated list of the selected values
false Default behaviour: only a single value can be selected
notnull true Value can't be null
false Default. Value can be null
Retrieved from "http://wiki.hsyco.com/3.5.1/index.php?title=Select&oldid=1353"