abstract
JsInputBase<T>
Base class for JS value editors
Extends
InputBase
<T
>
Type parameters
Type parameter | Value |
---|---|
T | any |
Constructors
new JsInputBase()
new JsInputBase<
T
>():JsInputBase
<T
>
Returns
JsInputBase
<T
>
Overrides
Source
Properties
Property | Type | Inherited from |
---|---|---|
dart | any | InputBase .dart |
Accessors
caption
get
caption():string
set
caption(s
):void
Parameters
Parameter | Type |
---|---|
s | string |
Returns
string
Source
captionLabel
get
captionLabel():HTMLElement
Returns
HTMLElement
Source
classList
get
classList():DOMTokenList
Returns
DOMTokenList
Source
dataType
get
abstract
dataType():string
Data type this input can edit. See Type.
Returns
string
Source
enabled
get
enabled():boolean
Whether the input is enabled
set
enabled(v
):void
Parameters
Parameter | Type |
---|---|
v | boolean |
Returns
boolean
Source
format
get
format():string
Value format.
set
format(s
):void
Parameters
Parameter | Type |
---|---|
s | string |
Returns
string
Source
input
get
input():HTMLElement
Returns the actual input
Returns
HTMLElement
Source
inputType
get
abstract
inputType():string
Input type identifier (such as "Slider" for the slider input). See InputType.
Returns
string
Source
notify
get
notify():boolean
Whether events are thrown on value set
set
notify(v
):void
Parameters
Parameter | Type |
---|---|
v | boolean |
Returns
boolean
Source
nullable
get
nullable():boolean
Whether empty values are allowed
set
nullable(v
):void
Parameters
Parameter | Type |
---|---|
v | boolean |
Returns
boolean
Source
onChanged
get
onChanged():Observable
<T
>
Occurs when [value] is changed, either by user or programmatically.
Returns
Observable
<T
>
Source
onInput
get
onInput():Observable
<Event
>
Occurs when [value] is changed by user.
Returns
Observable
<Event
>
Source
property
get
property():any
Property if associated with
set
property(p
):void
Parameters
Parameter | Type |
---|---|
p | Property |
Returns
any
Source
readOnly
get
readOnly():boolean
Whether the input is readonly
set
readOnly(v
):void
Parameters
Parameter | Type |
---|---|
v | boolean |
Returns
boolean
Source
root
get
root():HTMLElement
Visual root (typically a div element that contains caption and input)
Returns
HTMLElement
Source
stringValue
get
stringValue():string
String representation of the value
set
stringValue(value
):void
Parameters
Parameter | Type |
---|---|
value | string |
Returns
string
Source
value
get
value():T
Input value
set
value(value
):void
Parameters
Parameter | Type |
---|---|
value | T |
Returns
T
Source
Methods
addCaption()
addCaption(
caption
):InputBase
<T
>
Adds the specified caption
Parameters
Parameter | Type |
---|---|
caption | string |
Returns
InputBase
<T
>
Inherited from
Source
addOptions()
addOptions(
options
):InputBase
<T
>
Adds the specified options
Parameters
Parameter | Type |
---|---|
options | HTMLElement |
Returns
InputBase
<T
>
Inherited from
Source
addPatternMenu()
addPatternMenu(
pattern
):void
Adds a usage example to the input's hamburger menu
Parameters
Parameter | Type |
---|---|
pattern | any |
Returns
void
Inherited from
Source
addPostfix()
addPostfix(
postfix
):InputBase
<T
>
Adds the specified postfix
Parameters
Parameter | Type |
---|---|
postfix | string |
Returns
InputBase
<T
>
Inherited from
Source
addValidator()
addValidator(
validator
):void
Adds a validator that accepts a string representation of the edited value and returns null if valid, or error message if invalid
Parameters
Parameter | Type |
---|---|
validator | (value ) => null | string |
Returns
void
Inherited from
Source
fireChanged()
fireChanged():
any
Fires the 'changed' event (value has changed). See also fireInput
Returns
any
Inherited from
Source
fireInput()
fireInput():
any
Fires the 'input' event (user input). See also fireChanged
Returns
any
Inherited from
Source
getInput()
abstract
getInput():HTMLElement
Returns
HTMLElement
Source
getStringValue()
abstract
getStringValue():string
Returns
string
Source
getValue()
abstract
getValue():T
Returns
T
Source
init()
init():
any
Returns
any
Inherited from
Source
load()
load(
s
):any
Loads the value. Used in dialog history. See also load
Parameters
Parameter | Type |
---|---|
s | any |
Returns
any
Inherited from
Source
save()
save():
any
Saves the value. Used in dialog history. See also load
Returns
any
Inherited from
Source
setStringValue()
abstract
setStringValue(value
):void
Parameters
Parameter | Type |
---|---|
value | string |
Returns
void
Source
setTooltip()
setTooltip(
msg
,tooltipCheck
):InputBase
<T
>
Sets the tooltip
Parameters
Parameter | Type | Default value |
---|---|---|
msg | string | undefined |
tooltipCheck | null | () => boolean | null |
Returns
InputBase
<T
>
Inherited from
Source
setValue()
abstract
setValue(value
):void
Parameters
Parameter | Type |
---|---|
value | T |
Returns
void
Source
forColumn()
static
forColumn<T
>(column
):InputBase
<null
|T
>
Creates input for the specified column
Type parameters
Type parameter | Value |
---|---|
T | any |
Parameters
Parameter | Type |
---|---|
column | Column <T > |
Returns
InputBase
<null
| T
>
Inherited from
Source
forInputType()
static
forInputType(inputType
):InputBase
<any
>
Creates input for the specified input type
Parameters
Parameter | Type |
---|---|
inputType | string | InputType |
Returns
InputBase
<any
>
Inherited from
Source
forProperty()
static
forProperty(property
,source
):InputBase
<any
>
Creates input for the specified property, and optionally binds it to the specified object
Parameters
Parameter | Type | Default value |
---|---|---|
property | Property | undefined |
source | any | null |
Returns
InputBase
<any
>