Class ParameterString

Provides access to a string value of a Subject. See Parameter for more information.

See Internationalization for information about localized and language-independent strings.

Implements

Constructors

constructor

Properties

choices_ maxLength_ suggestedLength_ values_

Methods

getAsString getChoices getMaxLength getName getSubject getSuggestedLength getValue getValues isComputed nameEquals setChoices setComputed setFromString setInputFunction setMaxLength setSuggestedLength setValue toString toStringShort

Constructors

constructor

  • new ParameterString(subject, name, localName, getter, setter, opt_choices?, opt_values?): ParameterString

  • Parameters

    • subject: Subject

      the Subject whose value this ParameterString represents

    • name: string

      the language-independent name of this Parameter; the English name can be passed in here because it will be run thru Util.toName.

    • localName: string

      the localized name of this Parameter

    • getter: (() => string)

      A function with no arguments that returns the value of this Parameter

        • (): string

        • Returns string

    • setter: ((n) => void)

      A function with one argument that sets the value of this Parameter

        • (n): void

        • Parameters

          • n: string

          Returns void

    • Optional opt_choices: string[]

      the translated localized strings corresponding to the values (optional)

    • Optional opt_values: string[]

      the language-independent strings that the parameter can be set to (optional) When specified, only these values are allowed.

    Returns ParameterString

Properties

Private choices_

choices_: string[] = []

the translated localized strings corresponding to the values

Private maxLength_

maxLength_: number = Number.POSITIVE_INFINITY

maximum length of string

Private suggestedLength_

suggestedLength_: number = 20

suggested length of string for making a control

Private values_

values_: string[] = []

the language-independent strings that the parameter can be set to

Methods

getAsString

getChoices

getMaxLength

  • getMaxLength(): number

  • Returns the maximum length of the string. setValue will throw an Error if trying to set a string longer than this.

    Returns number

    the maximum length of the string

getName

  • getName(opt_localized?): string

  • Name of this SubjectEvent, either the language-independent name for scripting purposes or the localized name for display to user.

    The language-independent name should be the same as the English version but capitalized and with spaces and dashes replaced by underscore, see Util.toName and nameEquals.

    Parameters

    • Optional opt_localized: boolean

      true means return the localized version of the name; default is false which means return the language independent name.

    Returns string

    name of this object

getSubject

getSuggestedLength

  • getSuggestedLength(): number

  • Returns the suggested length of string when making a user interface control.

    Returns number

    the suggested length of string when making a control

getValue

getValues

  • getValues(): string[]

  • Returns the set of values corresponding to getChoices that this Parameter can be set to.

    Returns string[]

    set of values that this Parameter can be set to, in string form.

isComputed

  • isComputed(): boolean

  • Returns whether the value is being automatically computed; setting the value of this Parameter has no effect.

    Examples of automatically computed Parameters: the variables that give the current energy of a simulation. Another example is when the size of a graph's SimView is under control of an AutoScale.

    Returns boolean

    whether the value is being automatically computed

nameEquals

  • nameEquals(name): boolean

  • Whether this SubjectEvent has the given name, adjusting for the transformation to a language-independent form of the name, as is done by Util.toName.

    Parameters

    • name: string

      the English or language-independent version of the name

    Returns boolean

    whether this SubjectEvent has the given name (adjusted to language-independent form)

setChoices

  • setChoices(choices, values, opt_broadcast?): void

  • Sets the choices and values associated with this Parameter. See Internationalization.

    Parameters

    • choices: string[]

      localized strings giving name of each choice

    • values: string[]

      the values corresponding to each choice

    • Optional opt_broadcast: boolean

      whether to broadcast this change to the Subject's Observers, default is true

    Returns void

    Throws

    if values is of different length than choices

setComputed

setFromString

  • setFromString(value): void

  • Sets the value of this Parameter after converting the given string to the appropriate type (boolean, number or string).

    Parameters

    • value: string

      the value to set this Parameter to, in string form

    Returns void

    Throws

    if the string cannot be converted to the needed type

setInputFunction

  • setInputFunction(fn): ParameterString

  • Sets a function which transforms the input string passed to setValue. For example, a function to transform strings to uppercase.

    Parameters

    • fn: null | ((s) => string)

      function to be used to transform input passed to setValue or null for no transformation

    Returns ParameterString

    this ParameterString for chaining setters

setMaxLength

  • setMaxLength(len): ParameterString

  • Sets the maximum length of the string. setValue will throw an Error if trying to set a string longer than this.

    Parameters

    • len: number

      the maximum length of the string

    Returns ParameterString

    this ParameterString for chaining setters

    Throws

    if the max length is less than length of current value of this Parameter.

setSuggestedLength

setValue

  • setValue(value): void

  • Sets the value of this ParameterString.

    Parameters

    • value: string

      the value to set this ParameterString to

    Returns void

toString

toStringShort

  • toStringShort(): string

  • Returns a minimal string representation of this object, usually giving just identity information like the class name and name of the object.

    For an object whose main purpose is to represent another Printable object, it is recommended to include the result of calling toStringShort on that other object. For example, calling toStringShort() on a DisplayShape might return something like this:

    DisplayShape{polygon:Polygon{'chain3'}}

    Returns string

    a minimal string representation of this object.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc