"

 COPYRIGHT (c) 1997 eXept Software AG

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

"{ Package: 'stx:libview2' }"

PluggableAdaptor subclass:#TypeConverter

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	category:'Interface-Support-Models'

!

!TypeConverter class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1997 eXept Software AG

              All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    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.

    [author:]

        Claus Gittinger

"

!

examples 

"

    convert a number to a string:

                                                                        [exBegin]

        |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.

                                                                        [exEnd]

    convert a number to a string with range:

                                                                        [exBegin]

        |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.

                                                                        [exEnd]

    convert a date to a string:

                                                                        [exBegin]

        |d v|

        v := nil asValue.

        d := DialogBox new.

        d addInputFieldOn:(TypeConverter onDateValue:v).

        d addOkButton.

        d open.

        d accepted ifTrue:[

            Transcript showCR:v value

        ]

                                                                        [exEnd]

    convert with thousands:

                                                                        [exBegin]

        |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

        ]

                                                                        [exEnd]

    convert with scale character:

                                                                        [exBegin]

        |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

        ]

                                                                        [exEnd]

    convert with scale character and thousands separator:

                                                                        [exBegin]

        |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

        ]

                                                                        [exEnd]

"

! !

!TypeConverter class methodsFor:'instance creation'!

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)"

    ^ (self on:aValueHolder) dateToText

    "Modified: 21.2.1997 / 18:46:11 / cg"

    "Created: 4.3.1997 / 12:30:49 / cg"

!

onNumberValue:aValueHolder

    "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)"

    ^ (self on:aValueHolder) numberToText

    "Modified: 21.2.1997 / 18:46:11 / cg"

!

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)"

    ^ (self on:aValueHolder) numberToTextFormattedBy:formatString

    "Created: 4.3.1997 / 11:51:25 / cg"

    "Modified: 4.3.1997 / 11:51:41 / cg"

!

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)"

    ^ (self on:aValueHolder) numberToTextLeftPaddedTo:aSize with:aCharacter

"

  |m|

  m := 5 asValue.

  ((EditField model:(TypeConverter onNumberValue:m leftPaddedTo:2 with:$-)) width:100) openAt:(200@200).

  m inspect.

"

!

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)"

    ^ (self on:aValueHolder) numberToTextMinValue:min maxValue:max

    "Created: 4.3.1997 / 11:51:25 / cg"

    "Modified: 4.3.1997 / 11:51:41 / cg"

!

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)"

    ^ (self on:aValueHolder) numberToText:numPostDecimalDigits

    "Modified: / 21.2.1997 / 18:46:11 / cg"

    "Created: / 5.12.1997 / 02:55:18 / cg"

!

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)"

    ^ (self on:aValueHolder) symbolOrNil

    "Modified: 21.2.1997 / 18:46:11 / cg"

!

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)"

    ^ (self on:aValueHolder) timeToText

    "Modified: 21.2.1997 / 18:46:11 / cg"

    "Created: 4.3.1997 / 11:52:10 / cg"

! !

!TypeConverter class methodsFor:'queries'!

possiblePrintConverterTypes

    "presented in the typeConverter UI-builder menu"

    ^ #( 

        #string

        #password

        #number

        #numberInRange

        #numberOrNil

        #numberInRangeOrNil

        #numberOrPointOrNil

        #numberOrStringOrSymbolOrNil

        #numberOrSymbolOrNil

        #numberWithOptionalScale

        #integer

        #integerInRange

        #integerWithThousandsSeparator

        #fileSize

        #frequency

        #hexadecimal

        #hexIntegerInRange

        #symbolOrNil

        #symbolOrBooleanOrNil

        #symbolOrNumberOrNil

        #smalltalkObject

        #smalltalkPoint

        #literal

        #date

        #dateOrNil

        #dateDDMMYYYY

        #dateMMDDYYYY

        #time12H

        #time24H

        #time

        #timeOrNil

        #timestamp

        #timestampOrNil 

        #timeDuration

        #timeDurationOrNil 

    ).

    "Created: / 25-09-2010 / 11:27:58 / cg"

! !

!TypeConverter methodsFor:'accessing'!

subject

    "return the subject to be converted"

    ^ model

!

value:newValue

    "convert and change"

    self setValue:newValue

    "Created: 21.2.1997 / 18:45:39 / cg"

! !

!TypeConverter methodsFor:'input testing'!

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)."

    |lastInputChar needChange|

    string notEmpty ifTrue:[

        1 to: string size - 1 do: [:i| (string at: i) isLetter ifTrue: [needChange := true]].

        lastInputChar := string at: string size.

        (lastInputChar isDigit not and: [lastInputChar isPrintable and: [

        (string size > 1               or: [lastInputChar ~~ $-])  and: [

        (string occurrencesOf: $.) > 1 or: [lastInputChar ~~ $.]]]]) ifTrue: [needChange := true].

    ].

    needChange == true ifTrue:[

        value notNil ifTrue:[

            model setValue:nil

        ] ifFalse:[

            model value isNil ifTrue:[

                model changed:#value.

                ^ self

            ]

        ].

    ].

    model value:value

! !

!TypeConverter methodsFor:'standard converters-date & time'!

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)

    "

    |in out c nDigits|

    oldFormatSpec isArray ifTrue:[^ oldFormatSpec].

    out := '' writeStream.

    in := oldFormatSpec readStream.

    [in atEnd] whileFalse:[

        c := in next.

        nDigits := 1.

        c == $m ifTrue:[

            [in peek == $m] whileTrue:[ nDigits := nDigits + 1. in next ].

            nDigits == 1 ifTrue:[

                out nextPutAll:'%M'.    "/ unpadded

            ] ifFalse:[

                out nextPutAll:'%m'.

            ].

        ] ifFalse:[

            c == $d ifTrue:[

                [in peek == $d] whileTrue:[ nDigits := nDigits + 1. in next ].

                nDigits == 1 ifTrue:[

                    out nextPutAll:'%D'.    "/ unpadded

                ] ifFalse:[

                    out nextPutAll:'%d'.

                ].

            ] ifFalse:[

                c == $y ifTrue:[

                    [in peek == $y] whileTrue:[ nDigits := nDigits + 1. in next ].

                    nDigits == 2 ifTrue:[

                        out nextPutAll:'%Y'.    "/ 2 digits only

                    ] ifFalse:[

                        out nextPutAll:'%y'.

                    ].

                ] ifFalse:[

                    out nextPut:c.

                ].

            ].

        ].

    ].

    ^ out contents.

!

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."

    ^ self dateWithFormat:nil orDefault:Date today

!

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."

    self dateToTextFormattedBy: #(1 2 3 $- 1 1 true)

    "

     |vh|

     vh := Date today asValue.

     TypeConverter new

        dateDDMMYYYY

            model:vh;

            value.    

     vh value       

    "

    "

     |vh|

     vh := Date today asValue.

     TypeConverter new

        dateDDMMYYYY

            model:vh;

            value:'12-01-2008'.    

     vh value       

    "

!

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."

    self dateToTextFormattedBy: #(2 1 3 $/ 1 1 true)

    "

     |vh|

     vh := Date today asValue.

     TypeConverter new

        dateMMDDYYYY

            model:vh;

            value.    

     vh value       

    "

    "

     |vh|

     vh := Date today asValue.

     TypeConverter new

        dateMMDDYYYY

            model:vh;

            value:'01/12/2008'.    

     vh value       

    "

!

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."

    ^ self dateWithFormat:nil orDefault:nil

!

dateOrNilWithFormat:aFormatString