Class: TypeConverter

• Inheritance
• Description
• Class protocol
  • instance creation
  • queries
• Instance protocol
  • accessing
  • input testing
  • standard converters-date & time
  • standard converters-misc
  • standard converters-numbers
• Examples

Inheritance:

   Object
   |
   +--Model
      |
      +--ValueModel
         |
         +--PluggableAdaptor
            |
            +--TypeConverter

Package:

stx:libview2

Category:

Interface-Support-Models

Version:

rev: 1.81 date: 2018/09/14 15:06:30

user: stefan

file: TypeConverter.st directory: libview2

module: stx stc-classLibrary: libview2

Author:

Claus Gittinger

Description:

a typeConverter can be used as an editFields model
(remember, that an editField expects a string in its model),
to convert the fields string value to some object and vice versa.
Its main use is when building interfaces with inputFields,
where the datum to be entered is a non-string and you
want to have the entered value be converted automatically.
(and vice versa, to convert the datum to a string).

No real new functionality is added here - all is inherited
from PluggableAdapter; however, some specialized instance creation
methods are added here.

Notice: 
    this class was implemented using protocol information
    from alpha testers - it may not be complete or compatible to
    the corresponding ST-80 class. 
    If you encounter any incompatibilities, please forward a note 
    describing the incompatibility verbal (i.e. no code) to the ST/X team.

Class protocol:

 onDateValue: aValueHolder

create and return a typeConverter, which retrieves
a date via #value, and converts
a date-string to a date via #value:.
Useful as an editFields model, which operates on some
date value (or aspectAdaptor, which adapts to a numeric slot)

 onNumberValue: aValueHolder

create and return a typeConverter, which retrieves
a value's string representation via #value, and converts
a number-string to a value via #value:.
Useful as an editFields model, which operates on some
numeric value (or aspectAdaptor, which adapts to a numeric slot)

 onNumberValue: aValueHolder format: formatString

create and return a typeConverter, which retrieves
a values string representation via #value, and converts
a number-string to a value via #value:.
Useful as an editFields model, which operates on some
numeric value (or aspectAdaptor, which adapts to a numeric slot)

 onNumberValue: aValueHolder leftPaddedTo: aSize with: aCharacter

create and return a typeConverter, which retrieves
a values string representation via #value, and converts
a number-string to a value via #value:.
Useful as an editFields model, which operates on some
numeric value (or aspectAdaptor, which adapts to a numeric slot)

 onNumberValue: aValueHolder minValue: min maxValue: max

create and return a typeConverter, which retrieves
a values string representation via #value, and converts
a number-string to a value via #value:.
Useful as an editFields model, which operates on some
numeric value (or aspectAdaptor, which adapts to a numeric slot)

 onNumberValue: aValueHolder postDecimalDigits: numPostDecimalDigits

create and return a typeConverter, which retrieves
a values string representation via #value, and converts
a number-string to a value via #value:.
Useful as an editFields model, which operates on some
numeric value (or aspectAdaptor, which adapts to a numeric slot)

 onSymbolValue: aValueHolder

create and return a typeConverter, which retrieves
a symbol-values string representation via #value, and converts
a string to a symbol via #value:.
Useful as an editFields model, which operates on some
numeric value (or aspectAdaptor, which adapts to a numeric slot)

 onTimeValue: aValueHolder

create and return a typeConverter, which retrieves
a time via #value, and converts
a time-string to a time via #value:.
Useful as an editFields model, which operates on some
date value (or aspectAdaptor, which adapts to a numeric slot)

 possiblePrintConverterTypes

presented in the typeConverter UI-builder menu

Instance protocol:

 subject

return the subject to be converted

 value: newValue

convert and change

 setNumberValue: value inModel: model fromInput: string

for invalid numbers, the model is set to nil.
By this, the dependents are forced to update their contents
(that is: a bad input string will lead to a cleared input field here).

 convertOldVWDateFormatSpecifierToNewSTXFormat: oldFormatSpec

private helper to convert an old (VW) format-Array
of the form:
'mm/dd/yyyy' (VW-backward compatibility)
into:
'%m %d %y' (new ST/X format)

 date

setup the converter to convert from a string to a date
and vice versa. Nil is converted to todays date-string,
likewise, an empty string is converted back to todays date.

 dateDDMMYYYY

setup the converter to convert from a string to a date formatted by printFormat
DD-MM-YYYY; see also Date>>printFormat:
This is a backward compatibility method for very old code to print european-style dates.
Please use dateWithFormat: which is much more flexible.

 dateMMDDYYYY

setup the converter to convert from a string to a date formatted by printFormat
MM/DD/YYYY; see also Date>>printFormat:
This is a backward compatibility method for very old code to print us-style dates.
Please use dateWithFormat: which is much more flexible.

 dateOrNil

setup the converter to convert from a string to a date
and vice versa. Invalid dates are converted to nil; likewise,
a nil date is converted to an empty string.

 dateOrNilWithFormat: aFormatString

setup the converter to convert from a string to a date
and vice versa. Invalid dates are converted to nil; likewise,
a nil date is converted to an empty string.
The format string must have one of the forms:
'mm/dd/yyyy' (for VW-backward compatibility)
or:
'%m %d %y'

 dateToText

setup the converter to convert from a string to a date
and vice versa. Nil is converted to todays date-string,
likewise, an empty string is converted back to todays date.

 dateToTextFormattedBy: printFormat

setup the converter to convert from a string to a date formatted by printFormat
and vice versa. Nil is converted to todays date-string,
likewise, an empty string is converted back to todays date.
Uses the old, obsolete ST80 printFormat (see Date printFormat:)

 dateWithFormat: aFormatString

setup the converter to convert from a string to a date
and vice versa. Invalid dates are converted to nil; likewise,
a nil date is converted to an empty string.
The format string must have one of the forms:
'mm/dd/yyyy' (for VW-backward compatibility)
or:
'%m %d %y'

see Date addPrintBindingsTo:language: for a format description.

 dateWithFormat: aFormatString orDefault: defaultValue

setup the converter to convert from a string to a date and vice versa.
Invalid dates are converted to nil;
likewise, a nil date is converted to an empty string.
The format string must have one of the forms:
'mm/dd/yyyy' (for VW-backward compatibility)
or:
'%m %d %y'

see Date addPrintBindingsTo:language: for a format description.

 dateWithFormat: aFormatString orDefault: defaultValue language: lang

setup the converter to convert from a string to a date and vice versa.
Invalid dates are converted to nil;
likewise, a nil date is converted to an empty string.
The format string must have one of the forms:
'mm/dd/yyyy' (for VW-backward compatibility)
or:
'%m %d %y'

see Date addPrintBindingsTo:language: for a format description.

 monthAndYear

setup the converter to convert from a string to a date
and vice versa. Invalid dates are converted to nil; likewise,
a nil date is converted to an empty string.
see Date addPrintBindingsTo:language: for a format description.

 time

 time12H

setup the converter to convert from a string to a time formatted by 12 hours
and vice versa.

 time24H

setup the converter to convert from a string to a time formatted by 24 hours
and vice versa.

 timeDuration

setup the converter to convert from a string to a timeduration and vice versa.

 timeDurationOrNil

setup the converter to convert from a string to a timeDuration and vice versa.

 timeOfClass: timeClass withFormat: aFormatString orDefault: defaultValue

setup the converter to convert from a string to a time and vice versa.
TimeClass is the class that should be used (e.g. Time or Timestamp).
Invalid times are converted to defaultValue; likewise,
a nil time is converted to an empty string.

 timeOfClass: timeClass withFormat: aFormatString orDefault: defaultValue language: langOrNil

setup the converter to convert from a string to a time
and vice versa. TimeClass is the class that should be used (e.g. Time or Timestamp).
Invalid times are converted to defaultValue; likewise,
a nil time is converted to an empty string.

 timeOrNil

setup the converter to convert from a string to a time and vice versa.

 timeStampOrNil

setup the converter to convert from a string to a timeStamp and vice versa.

** This is an obsolete interface - do not use it (it may vanish in future versions) **

 timeToText

setup the converter to convert from a string to a time
and vice versa.

 timeToTextFormattedBy: format

setup the converter to convert from a string to a time formatted by format
and vice versa.

 timestamp

setup the converter to convert from a string to a timestamp and vice versa.

 timestampOrNil

setup the converter to convert from a string to a timestamp and vice versa.

 year

setup the converter to convert from a string to a date
and vice versa. Invalid dates are converted to nil; likewise,
a nil date is converted to an empty string.
see Date addPrintBindingsTo:language: for a format description.

 arrayLiteralOrStringOrSymbolOrNil

setup the converter to convert from a string to either a literal
Array, a String or a symbol and vice versa.
Invalid strings (i.e. empty) are converted to nil;
nil values are converted to an empty string.
This is a very special converter (for the GUI builder)
- probably not belonging to here

 arrayLiteralOrSymbolOrNil

setup the converter to convert from a string to either a literal
Array or a symbol and vice versa.
Invalid strings (i.e. empty) are converted to nil;
nil values are converted to an empty string.
This is a very special converter (for the GUI builder)
- probably not belonging to here

 fileSize

setup the converter to convert from a fileSize string to a number
and vice versa.
A fileSize can have a scale of 1000 (k or kB), 1024 (ki or kiB),
1000*1000 (m or mB), 1024*1024 (mi or miB), 1000*1000*1000 (g or gB), 1024*1024*1024 (gi or giB).

 frequency

setup the converter to convert from a frequency string to a number
and vice versa.
A frequency can have a scale of 1000 (k or kHz),
1000*1000 (m or MHz), 1000*1000*1000 (g or GHz).

 literal

setup the converter to convert from a string to a literal
and vice versa. Invalid symbols (i.e. empty) are converted to nil;
nil values are converted to an empty string.
true, false, Numbers are parsed

 objectOrNilOfType: timeOrDateClass

common code for timeOrNil, dateOrNil and timeStampOrNil

 smalltalkObject

setup the converter to convert from a string to any smalltalk object
and vice versa. The string used is the objects storeString.
Invalid strings (i.e. empty) are converted to nil.
This is a very special converter (for the GUI builder)
- probably not belonging to here

 smalltalkObjectOrNil

setup the converter to convert from a string to any smalltalk object
and vice versa. The string used is the objects storeString.
Invalid strings (i.e. empty) are converted to nil.
This is a very special converter (for the GUI builder)
- probably not belonging to here

 smalltalkObjectOrNilWithClass: classOfObject

setup the converter to convert from a string to a smalltalk object
and vice versa. The string used is the objects storeString.
Invalid strings (i.e. empty) are converted to nil.
This is a very special converter (for the GUI builder)
- probably not belonging to here

 smalltalkObjectWithClass: classOfObject

setup the converter to convert from a string to a smalltalk object
and vice versa. The string used is the objects storeString.
Invalid strings (i.e. empty) are converted to nil.
This is a very special converter (for the GUI builder)
- probably not belonging to here

 smalltalkPoint

setup the converter to convert from a string to a point object
and vice versa. The string used is the points storeString.
Invalid strings (i.e. empty) are converted to nil.
This is a very special converter (for the GUI builder)
- probably not belonging to here

 symbolOrBooleanOrNil

setup the converter to convert from a string to a symbol or boolean
and vice versa. Invalid symbols (i.e. empty) are converted to nil;
nil values are converted to an empty string.
In addition, the strings true/false convert to/from booleans.

 symbolOrNil

setup the converter to convert from a string to a symbol
and vice versa. Invalid symbols (i.e. empty) are converted to nil;
nil values are converted to an empty string.

 symbolOrNumberOrNil

setup the converter to convert from a string to a symbol or number
and vice versa. Invalid symbols (i.e. empty) are converted to nil;
nil values are converted to an empty string.

 hexadecimal

setup the converter to convert from a hexadecimal string to a number
and vice versa.

 integer

setup the converter to convert from a string to an integer
and vice versa. Invalid integers are converted to nil.

 integerCStyle

setup the converter to convert from a string to an integer
and vice versa. Supports CStyle 0x/0b and 0 prefixes
Invalid integers are converted to nil.

 integerOrNil

setup the converter to convert from a string to an integer
and vice versa. Invalid numbers are converted to nil.

 integerToHexTextMinValue: minVal maxValue: maxVal format: formatStringOrNil

setup the converter to convert from a string to a number
and vice versa, but clamping the number into the range.

 integerToText

setup the converter to convert from a string to a integer
and vice versa.

 integerToTextCStyle

setup the converter to convert from a string to a integer
and vice versa. SUpports C-style integers in the form 0x, 0b 0
and also Smalltalk radix integers

 integerToTextMinValue: minVal maxValue: maxVal format: formatStringOrNil

setup the converter to convert from a string to a number
and vice versa, but clamping the number into the range.

 integerToTextMinValue: minVal maxValue: maxVal radix: radix format: formatStringOrNil

setup the converter to convert from a string to a number
and vice versa, but clamping the number into the range.

 integerWithThousandsSeparator

 integerWithThousandsSeparator: sep

setup the converter to convert from a string to a number with thousands separator
and vice versa.

 number

setup the converter to convert from a string to a number
and vice versa. Invalid numbers are converted to nil.

 numberOrNil

setup the converter to convert from a string to a number
and vice versa. Invalid numbers are converted to nil.

 numberOrNilToTextMinValue: minVal maxValue: maxVal

setup the converter to convert from a string to a number or nil
and vice versa, but clamping the number into the range.

 numberOrNilToTextMinValue: minVal maxValue: maxVal format: formatStringOrNil

setup the converter to convert from a string to a number or nil
and vice versa, but clamping the number into the range.

 numberOrPointOrNil

setup the converter to convert from a string to a number or point
and vice versa. Invalid numbers/points are converted to nil.

 numberOrStringOrSymbolOrNil

setup the converter to convert from a string to either a numeric literal
or a symbol and vice versa.
Invalid strings (i.e. empty) are converted to nil;
nil values are converted to an empty string.
This is a very special converter (for the GUI builder)
- probably not belonging to here

 numberOrSymbolOrNil

setup the converter to convert from a string to either a numeric literal
or a symbol and vice versa.
Invalid strings (i.e. empty) are converted to nil;
nil values are converted to an empty string.
This is a very special converter (for the GUI builder)
- probably not belonging to here

 numberToText

setup the converter to convert from a string to a number
and vice versa.

 numberToText: numberOfPostDecimals

setup the converter to convert from a string to a number
and vice versa.

 numberToTextFormattedBy: formatString

setup the converter to convert from a string to a number
and vice versa, using formatString.
The formatString is currently ignored when numbers are converted
from a string.

 numberToTextLeftPaddedTo: aSize with: aCharacter

setup the converter to convert from a string to a number
and vice versa, using formatString.
The formatString is currently ignored when numbers are converted
from a string.

 numberToTextMinValue: minVal maxValue: maxVal

setup the converter to convert from a string to a number
and vice versa, but clamping the number into the range.

 numberToTextMinValue: minVal maxValue: maxVal format: formatStringOrNil

setup the converter to convert from a string to a number
and vice versa, but clamping the number into the range.

 numberWithOptionalScale

setup the converter to convert from a string to a number
and vice versa. Invalid numbers are converted to nil.
The number may be followed by one of m (for million) or
k (for thousand). E.g.: '1m2k55'

 numberWithOptionalScales: scaleDict

setup the converter to convert from a string to a number or nil
and vice versa; allow for scale characters (such as k for thousand).

E.g. '1m2k55'

 numberWithOptionalScales: scaleDict andThousandsSeparator: sep

setup the converter to convert from a string to a number with thousands separator
and vice versa. Allow for scale characters (such as k for thousand)

 numberWithThousandsSeparator

^ self numberWithThousandsSeparator:$'

 numberWithThousandsSeparator: sep

setup the converter to convert from a string to a number with thousands separator
and vice versa.

Examples:

    |v t i|

    v := 1 asValue.

    t := HorizontalPanelView new.
    t extent:200@50.
    t horizontalLayout:#fitSpace.

    i := EditField in:t.
    i model:(TypeConverter onNumberValue:v).
    t open.

    (Delay forSeconds:3) wait.
    v value:2.

    |v t i|

    v := 1 asValue.

    t := HorizontalPanelView new.
    t extent:200@50.
    t horizontalLayout:#fitSpace.

    i := EditField in:t.
    i model:(TypeConverter onNumberValue:v minValue:0 maxValue:100).
    t open.

    (Delay forSeconds:3) wait.
    v value:2.

    |d v|

    v := nil asValue.

    d := DialogBox new.
    d addInputFieldOn:(TypeConverter onDateValue:v).
    d addOkButton.
    d open.
    d accepted ifTrue:[
        Transcript showCR:v value
    ]

    |d v|

    v := 1234567 asValue.

    d := DialogBox new.
    d addInputFieldOn:((TypeConverter on:v) integerWithThousandsSeparator:$').
    d addOkButton.
    d open.
    d accepted ifTrue:[
        Transcript showCR:v value
    ]

    |d v|

    v := 1234567 asValue.

    d := DialogBox new.
    d addInputFieldOn:((TypeConverter on:v) numberWithOptionalScale).
    d addOkButton.
    d open.
    d accepted ifTrue:[
        Transcript showCR:v value
    ]

    |d v scaleDict|

    scaleDict := Dictionary new.
    scaleDict at:$t put:1000.
    scaleDict at:$k put:1000.
    scaleDict at:$m put:1000000.

    v := 1234567 asValue.

    d := DialogBox new.
    d addInputFieldOn:((TypeConverter on:v) 
                        numberWithOptionalScales:scaleDict 
                        andThousandsSeparator:$').
    d addOkButton.
    d open.
    d accepted ifTrue:[
        Transcript showCR:v value
    ]