Package com.caplin.motif.fx.config.definitions.common

Class DisplayFieldArgument

  • @Generated("org.openapitools.codegen.languages.SpringCodegen")
public class DisplayFieldArgument
extends java.lang.Object
    DisplayFieldArgument

    • Constructor Detail

      • DisplayFieldArgument

        public DisplayFieldArgument()

      • DisplayFieldArgument

        public DisplayFieldArgument​(java.lang.String value,
                            DisplayFieldArgument.TypeEnum type)
        Constructor with only required parameters

    • Method Detail

      • getValue

        @NotNull
public @NotNull java.lang.String getValue()
        The value to be applied to the template.
        Returns:
        value

      • setValue

        public void setValue​(java.lang.String value)

      • getType

        @NotNull
public @NotNull DisplayFieldArgument.TypeEnum getType()
        Type of the value. Used by the frontend for formatting. * `TEXT` - Plaintext value that should be displayed unmodified. * `TOKEN` - Translation token. The token must be known to the frontend. * `NUMBER` - A number. The frontend applies number formatting as specified by the user's locale. Please set the value with the intended precision, as the frontends do not make any precision adjustments for NUMBER values. * `DATE` - An ISO date (`YYYY-MM-DD`). Will be formatted as per user's locale setting. * `TIME` - An ISO date-time (`YYYY-MM-DD[T]HH:mm:ss.SSS`) or time (`HH:mm:ss.SSS`) with or without milliseconds. Input must be in UTC. Milliseconds will be displayed only if the input format contained milliseconds. Frontend will convert to local time and display the time part only, formatted as per user's locale setting. * `DATETIME` - An ISO date-time (`YYYY-MM-DD[T]HH:mm:ss.SSS`) with or without milliseconds. Input must be in UTC. Milliseconds will be displayed only if the input format contained milliseconds. Frontend will convert to local time and display the date and time formatted as per user's locale setting. * `RATE` - A rate value that may be formatted with adapter-provided formatting attributes. * `POINTS` - A points value that may be formatted with adapter-provided formatting attributes. * `AMOUNT` - An amount value that may be formatted with adapter-provided formatting attributes. * `BUTTON` - A plaintext value to be displayed on a button, and an optional name of an action to be performed upon clicking the button.
        Returns:
        type

      • digitsBeforePips

        public DisplayFieldArgument digitsBeforePips​(java.lang.Integer digitsBeforePips)

      • getDigitsBeforePips

        public java.lang.Integer getDigitsBeforePips()
        Digits before pips for a points or rate value.
        Returns:
        digitsBeforePips

      • setDigitsBeforePips

        public void setDigitsBeforePips​(java.lang.Integer digitsBeforePips)

      • getNumberOfPips

        public java.lang.Integer getNumberOfPips()
        Number of pips for a points or rate value.
        Returns:
        numberOfPips

      • setNumberOfPips

        public void setNumberOfPips​(java.lang.Integer numberOfPips)

      • getDps

        public java.lang.Integer getDps()
        Number of decimal places for a points, rate or amount value.
        Returns:
        dps

      • setDps

        public void setDps​(java.lang.Integer dps)

      • getColor

        public java.lang.String getColor()
        The color of the argument value. Can be a design system token (e.g. neutral_base) or, alternatively, any valid HTML color code (e.g. #FFFFFF or red).
        Returns:
        color

      • setColor

        public void setColor​(java.lang.String color)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object