Serial Number Input State Variable Reference

Related documents

• State Variables Overview
• StateVar Reference
• Built-in State Variables
• Input SV Type Reference
• Text Input State Variable Reference

Table of contents

• Introduction
• Constructor
• Instance methods
  • Inherited methods
  • fmtVal()
• Instance properties
  • Inherited properties
  • isFixedWidth (read only)
• Component attributes
  • Inherited attributes
• DOM element properties

Introduction

Serial Number Input state variables represent an aircraft serial number entered by the user. The state variable is defined by the aircraft application (source/app/common/aero/serialNumSv.js), not by the base MVCS. It depends on the aircraft type data in acData, and the rendered input monitors sv.ac_data so it updates when the selected aircraft model changes.

The value is a string of digits. The number of digits is set by acData.serialWidth. Whether the value is displayed with leading zeros depends on acData.serialFixedWidth:

• If acData.serialFixedWidth is set, the serial number is fixed width. The displayed value and the value entered by the user are padded with leading zeros to acData.serialWidth digits (or truncated to that width if longer).
• Otherwise, the displayed value has any leading zeros removed (a single 0 is retained).

Constructor

• Type string: 'serialNumInput', class: SerialNumInputSv

Syntax

ctl.createPage({
	...,
	stateVarInfo:[
		{type:'serialNumInput', ...},
	],
})

Parameters

• info
  An object containing the state variable properties. The info object can contain the following properties, but subclasses of StateVar may have additional properties:
  • StateVar info properties.
  • Model SV type info properties.
  • Input SV type info properties.
  • dflt (optional)
    The default value, a string of digits. Default: '0' padded with leading zeros to acData.serialWidth digits, evaluated when the state variable is created.

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods
• InputSv methods

Note: The component() method returns a component that renders an <input type="text"> (see Component attributes).

fmtVal()

Syntax

fmtVal()

Returns the displayed form of the value. If the value is an Error, returns the Error text. If isFixedWidth is true, returns the value padded (or truncated) to acData.serialWidth digits. Otherwise returns the value with leading zeros removed.

Return value

A String.

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties
• InputSv properties

isFixedWidth (read only)

True if the current aircraft model's serial numbers are fixed width (acData.serialFixedWidth is set).

Value

A Boolean.

Component attributes

Inherited attributes

• Component attributes

The component behaves as follows:

• If the valueOnly attribute is set, the component renders as a Text Output component.
• Characters other than the digits 0 through 9 are removed as the user types.
• When the input changes (or loses focus, or Enter is pressed), a fixed-width serial number is padded to acData.serialWidth digits before the state variable is updated through onUserChange.
• The component re-synchronizes the displayed value when either the state variable or sv.ac_data changes.

DOM element properties

• Standard DOM element properties
• The component renders an <input type="text"> with the size and maxLength attributes set to acData.serialWidth.
• The <input> element's value is synchronized with fmtVal().
• The <input> element will have a className that contains 'svIo_serialNumInput'.