Class InControl<TValue>`Abstract`

User input control.

Maintains input value and various aspects of the user input, such as input focus, validity, etc.

Type Parameters

TValue

Input value type.

Hierarchy

ValueTracker<TValue>
- InControl
  - InContainer
  - InElement

Index

Constructors

constructor

new InControl<TValue>(aspects?): InControl<TValue>
Constructs user input control.
Type Parameters
- TValue
Parameters
- aspects: {
  aspects?: Aspect<TValue, TValue> | readonly Aspect<TValue, TValue>[];
  } = {}
  
  Input aspects applied by default. These are aspect converters to constructed control from the same-valued one.
  - Optional Readonly aspects?: Aspect<TValue, TValue> | readonly Aspect<TValue, TValue>[]
Returns InControl<TValue>
Overrides ValueTracker<TValue>.constructor
- Defined in frontmeans/input-aspects/src/control.ts:36

Properties

`Abstract` it

it: TValue

Input value.

`Readonly` `Abstract` on

on: OnEvent<[TValue, TValue]>

OnEvent sender of value changes.

The [OnEvent__symbol] property is an alias of this one.

Returns

Value changes sender.

`Readonly` read

read: AfterEvent<[TValue]>

AfterEvent keeper of current value.

The [AfterEvent__symbol] property is an alias of this one.

Returns

Current value keeper.

Accessors

`Abstract` supply

get supply(): Supply
This control's input supply.

Releases all control resources when cut off.

Each control has its own supply. An input supply of converted control depends on the input supply of control it is converted from.

After this supply cut off the control should no longer be used.

Returns Supply
Overrides ValueTracker.supply
- Defined in frontmeans/input-aspects/src/control.ts:71

Methods

[AfterEvent__symbol]

[AfterEvent__symbol](): AfterEvent<[TValue]>
Returns AfterEvent<[TValue]>
Inherited from ValueTracker.[AfterEvent__symbol]
- Defined in proc7ts/fun-events/dist/fun-events.d.ts:1609

[OnEvent__symbol]

[OnEvent__symbol](): OnEvent<[TValue, TValue]>
Returns OnEvent<[TValue, TValue]>
Inherited from ValueTracker.[OnEvent__symbol]
- Defined in proc7ts/fun-events/dist/fun-events.d.ts:1605

`Protected` _applyAspect

_applyAspect<TInstance, TKind>(aspect): undefined | InAspect.Application.Result<TInstance, TValue, TKind>
Applies the given aspect to this control in a custom way.
Type Parameters
- TInstance
  
  Aspect instance type.
- TKind extends keyof InAspect.Application.Map<unknown, unknown>
  
  Aspect application kind.
Parameters
- aspect: InAspect<TInstance, TKind>
  
  An aspect to apply.
Returns undefined | InAspect.Application.Result<TInstance, TValue, TKind>
Either applied aspect instance or undefined to apply the aspect in standard way (i.e. using InAspect.applyTo() method).
- Defined in frontmeans/input-aspects/src/control.ts:180

aspect

aspect<TInstance, TKind>(aspectKey): ReturnType<InAspect.Application.Map<TInstance, TValue>[TKind]>
Retrieves an aspect instance applied to this control.

If the given aspect is not applied yet, then applies it first.
Type Parameters
- TInstance
  
  Aspect instance type.
- TKind extends keyof InAspect.Application.Map<unknown, unknown>
  
  Aspect application kind.
Parameters
- aspectKey: Key<TInstance, TKind>
  
  A key of aspect to apply to this control.
Returns ReturnType<InAspect.Application.Map<TInstance, TValue>[TKind]>
An applied aspect instance.
- Defined in frontmeans/input-aspects/src/control.ts:84

by

by(supplier): InControl<TValue>
Updates the tracked value by the given value supplier.

If the value is already updated by another supplier, then unbinds from the old one first.

Call the byNone method to unbind the tracked value from the source.

Note that explicitly updating the value would override the value received from the source.
Parameters
- supplier: EventSupplier<[TValue]>
  
  The source value sender or keeper.
Returns InControl<TValue>
this instance.
Inherited from ValueTracker.by
- Defined in proc7ts/fun-events/dist/fun-events.d.ts:1633
by<TSrcEvent>(supplier, extract): InControl<TValue>
Updates the tracked value by value suppliers extracted from events sent by the given supplier.

If the value is already updated by another value supplier, then unbinds from the old one first.

Call the byNone method to unbind the tracked value from the source.

Note that explicitly updating the value would override the value received from the source.
Type Parameters
- TSrcEvent extends any[]
  
  Source event type.
Parameters
- supplier: EventSupplier<TSrcEvent>
  
  The event supplier to extract value suppliers from.
- extract: ((this, ...event) => undefined | EventSupplier<[TValue]>)
  
  A function extracting value supplier from event received from supplier. May return undefined to suspend receiving values.
  - - (this, ...event): undefined | EventSupplier<[TValue]>
    - Parameters
      
      this: void
      
      Rest ...event: TSrcEvent
      
      Returns undefined | EventSupplier<[TValue]>
Returns InControl<TValue>
this instance.
Inherited from ValueTracker.by
- Defined in proc7ts/fun-events/dist/fun-events.d.ts:1652

byNone

byNone(reason?): InControl<TValue>
Unbinds the tracked value from any value supplier this tracker is updated by.

If the tracker is not bound then does nothing.
Parameters
- Optional reason: unknown
  
  Arbitrary reason of unbinding the value.
Returns InControl<TValue>
this instance.
Inherited from ValueTracker.byNone
- Defined in proc7ts/fun-events/dist/fun-events.d.ts:1664

convert

convert(...by): InControl<TValue>
Converts this control to another one without changing its value type.

The converted aspect may have another value and input aspects.
Parameters
- Rest ...by: Aspect<TValue, TValue>[]
  
  Input control aspect converters.
Returns InControl<TValue>
Converted control.
- Defined in frontmeans/input-aspects/src/control.ts:145
convert<TTo>(by, ...and): InControl<TTo>
Converts this control to another one.

The converted aspect may have another value and input aspects.
Type Parameters
- TTo
  
  Converted input value type.
Parameters
- by: InConverter<TValue, TTo>
  
  Input control converter.
- Rest ...and: Aspect<TValue, TTo>[]
  
  Additional input control aspect converters.
Returns InControl<TTo>
Converted control.
- Defined in frontmeans/input-aspects/src/control.ts:158

setup

setup(setup): InControl<TValue>
Performs additional setup of this control.
Parameters
- setup: ((this, control) => void)
  
  A function that accepts this control as its only parameter.
  - - (this, control): void
    - Parameters
      
      this: void
      
      control: InControl<TValue>
      
      Returns void
Returns InControl<TValue>
this control instance.
- Defined in frontmeans/input-aspects/src/control.ts:97
setup<TInstance, TKind>(aspectKey, setup): InControl<TValue>
Performs additional setup of this control's aspect.
Type Parameters
- TInstance
  
  Aspect instance type.
- TKind extends keyof InAspect.Application.Map<unknown, unknown>
  
  Aspect application kind.
Parameters
- aspectKey: Key<TInstance, TKind>
  
  A key of aspect to set up.
- setup: ((this, aspect, control) => void)
  
  A function that accepts an applied aspect instance and this control as parameters.
  - - (this, aspect, control): void
    - Parameters
      
      this: void
      
      aspect: ReturnType<InAspect.Application.Map<TInstance, TValue>[TKind]>
      
      control: InControl<TValue>
      
      Returns void
Returns InControl<TValue>
this control instance.
- Defined in frontmeans/input-aspects/src/control.ts:109

Class InControl<TValue>Abstract

Type Parameters

TValue

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TValue

Parameters

aspects: { aspects?: Aspect<TValue, TValue> | readonly Aspect<TValue, TValue>[]; } = {}

Optional Readonly aspects?: Aspect<TValue, TValue> | readonly Aspect<TValue, TValue>[]

Returns InControl<TValue>

Properties

Abstract it

Readonly Abstract on

Returns

Readonly read

Returns

Accessors

Abstract supply

Returns Supply

Methods

[AfterEvent__symbol]

Returns AfterEvent<[TValue]>

[OnEvent__symbol]

Returns OnEvent<[TValue, TValue]>

Protected _applyAspect

Type Parameters

TInstance

TKind extends keyof InAspect.Application.Map<unknown, unknown>

Parameters

aspect: InAspect<TInstance, TKind>

Returns undefined | InAspect.Application.Result<TInstance, TValue, TKind>

aspect

Type Parameters

TInstance

TKind extends keyof InAspect.Application.Map<unknown, unknown>

Parameters

aspectKey: Key<TInstance, TKind>

Returns ReturnType<InAspect.Application.Map<TInstance, TValue>[TKind]>

by

Parameters

supplier: EventSupplier<[TValue]>

Returns InControl<TValue>

Type Parameters

TSrcEvent extends any[]

Parameters

supplier: EventSupplier<TSrcEvent>

extract: ((this, ...event) => undefined | EventSupplier<[TValue]>)

Parameters

this: void

Rest ...event: TSrcEvent

Returns undefined | EventSupplier<[TValue]>

Returns InControl<TValue>

byNone

Parameters

Optional reason: unknown

Returns InControl<TValue>

convert

Parameters

Rest ...by: Aspect<TValue, TValue>[]

Returns InControl<TValue>

Type Parameters

TTo

Parameters

by: InConverter<TValue, TTo>

Rest ...and: Aspect<TValue, TTo>[]

Returns InControl<TTo>

setup

Parameters

setup: ((this, control) => void)

Parameters

this: void

control: InControl<TValue>

Returns void

Class InControl<TValue>`Abstract`

aspects: {
aspects?: Aspect<TValue, TValue> | readonly Aspect<TValue, TValue>[];
} = {}

`Optional` `Readonly` aspects?: Aspect<TValue, TValue> | readonly Aspect<TValue, TValue>[]

`Abstract` it

`Readonly` `Abstract` on

`Readonly` read

`Abstract` supply

`Protected` _applyAspect

`Rest` ...event: TSrcEvent

`Optional` reason: unknown

`Rest` ...by: Aspect<TValue, TValue>[]

`Rest` ...and: Aspect<TValue, TTo>[]