NumberEdit
Type: NumberEdit
Extends ViewScript class of the Number Edit view.
Properties
| Property | Description |
|---|---|
| Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view. |
enabled
| Enables/disables the view. |
value
| Get/Set the value of the NumberEdit. |
View Properties
Properties defined by the view that are normally editable via properties editor.
| Property | Name | Description |
|---|---|---|
editor_type |
Editor Type | Editor type (Double / Integer / CAN ID etc). |
value |
Value | Sets the value. |
title |
Title | The title of the window. |
id |
Script ID | The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts. |
tooltip |
Tool Tip | Window tool tip. |
font_size |
Font Size | Size of the text. |
units_label |
Units Label | Optionally display units to the right of the editor. |
hex |
Hexadecimal | Use hexadecimal numeric base (integer editors only) |
hex_option |
Hex Option | Show toggleable hexadecimal option (unsigned integer editor) |
stretch |
Stretch | Stretch to fill view |
valign |
Vertical Align | Vertical alignment of the editor, if not using stretch mode |
text_align |
Text Align | Alignment of text in the editor |
Methods
| Method | Description |
|---|---|
callListener(eventName, [args])
| Calls all event listeners for the given event name, useful for testing. |
getParent()
| Get the parent window/view (if any) of this view. |
getViewProperties()
| Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view. |
getViewProperty(id)
| Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view. |
on(eventName, callback)
| Adds an event listener for the given event name. e.g. view.on("click", function() { ... }); |
pxFromDimension(dimension)
| Convert a dimension string (e.g. "10em", "50dp", "100px") into pixel units, relative to the view object. Returns the size in pixels. |
removeAllListeners([eventName])
| Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed. |
removeListener(eventName, callback)
| Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback); |
setViewProperty(id, value)
| Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view. |
Events
| Event | Description |
|---|---|
onSetValue(value)
| Called in when the NumberEdit value has changed. External scripts can bind to the 'change' event to be notified when the value changes. view.on("change", function(value) { ... }); |