File Duplex/UISpinner.lua

Functions

UISpinner:__init (display) Initialize the UISpinner class
UISpinner:_determine_index_by_pos (column, row) Determine index by position
UISpinner:_invoke_handler () Trigger the external handler method
UISpinner:add_listeners () Add event listeners (press, change)
UISpinner:do_change (msg) A value was changed (fader, dial)
UISpinner:do_press (msg) A button was pressed
UISpinner:draw () Overridden draw() method
UISpinner:get_orientation () Get the orientation
UISpinner:remove_listeners () Remove previously attached event listeners
UISpinner:set_index (idx, skip_event_handler) Set index to specified value
UISpinner:set_orientation (value) Set the slider orientation (only relevant when assigned to buttons)
UISpinner:set_range (minimum, maximum) Set a new value range, clipping the current index when needed (you can set just one value, since we skip nil values)
UISpinner:set_size (size) (Override UIComponent with this method)


Functions

UISpinner:__init (display)
Initialize the UISpinner class

Parameters:

  • display: (Duplex.Display)
UISpinner:_determine_index_by_pos (column, row)
Determine index by position

Parameters:

  • column: (Number)
  • row: (Number)

Return value:

    (Number)
UISpinner:_invoke_handler ()
Trigger the external handler method
UISpinner:add_listeners ()
Add event listeners (press, change)
UISpinner:do_change (msg)
A value was changed (fader, dial)

Parameters:

  • msg: (Duplex.Message)

Return value:

    boolean, true when message was handled
UISpinner:do_press (msg)
A button was pressed

Parameters:

  • msg: (Duplex.Message)

Return value:

    boolean, true when message was handled
UISpinner:draw ()
Overridden draw() method
UISpinner:get_orientation ()
Get the orientation

Return value:

    (Enum) either VERTICAL or HORIZONTAL
UISpinner:remove_listeners ()
Remove previously attached event listeners

See also:

UISpinner:set_index (idx, skip_event_handler)
Set index to specified value

Parameters:

  • idx: (Number)
  • skip_event_handler: (Boolean) skip event handler
UISpinner:set_orientation (value)
Set the slider orientation (only relevant when assigned to buttons)

Parameters:

  • value: (Enum) either VERTICAL or HORIZONTAL
UISpinner:set_range (minimum, maximum)
Set a new value range, clipping the current index when needed (you can set just one value, since we skip nil values)

Parameters:

  • minimum: (Number)
  • maximum: (Number)
UISpinner:set_size (size)
(Override UIComponent with this method)

Parameters:

  • size: (Number) the size in units

Valid XHTML 1.0!