Class: InputFieldSpec

• Inheritance
• Description
• Related information
• Class protocol
  • image specs
  • interface specs
  • interface-painter
• Instance protocol
  • accessing
  • accessing-channels
  • accessing-color & font
  • building
  • converting
  • parsing a view
  • queries
  • queries-UIDefiner
  • visiting

Inheritance:

   Object
   |
   +--UISpecification
      |
      +--ComponentSpec
         |
         +--NamedSpec
            |
            +--MenuComponentSpec
               |
               +--InputFieldSpec
                  |
                  +--ComboBoxSpec
                  |
                  +--EditFieldWithCompletionSpec
                  |
                  +--FilenameInputFieldSpec

Package:

stx:libui

Category:

Interface-Support-UI-Specs

Version:

rev: 1.188 date: 2019/05/17 14:55:36

user: stefan

file: InputFieldSpec.st directory: libui

module: stx stc-classLibrary: libui

Author:

Claus Atzkern

Description:

Not normally used by applications.

Notice:
    this class was implemented using protocol information
    from alpha testers, literature and by read public domain code
    - 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.

Related information:

    UIBuilder
    UIPainter

Class protocol:

 icon

This resource specification was automatically generated
by the ImageEditor of ST/X.

usage example(s):

ImageEditor openOnClass:self andSelector:#icon

 basicsEditSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

usage example(s):

UIPainter new openOnClass:InputFieldSpec andSelector:#basicsEditSpec

 channelsAndModifiedEditSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

usage example(s):

UIPainter new openOnClass:InputFieldSpec andSelector:#channelsAndModifiedEditSpec

 detailsAcceptSubSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

usage example(s):

UIPainter new openOnClass:InputFieldSpec andSelector:#detailsAcceptSubSpec

 detailsEditSpec

This resource specification was automatically generated
by the UIPainter of ST/X.

usage example(s):

UIPainter new openOnClass:InputFieldSpec andSelector:#detailsEditSpec

 subSpecForEntryCompletionBlockHolder

This resource specification was automatically generated
by the UIPainter of ST/X.

usage example(s):

UIPainter new openOnClass:InputFieldSpec andSelector:#subSpecForEntryCompletionBlockHolder

 addBindingsTo: env for: inst channel: aChannel

add bindings as required to allow the GUI Painter to operate on an instance of me

 commonReplacementClasses

used by the UIPainter's 'replace-by' function

 slices

return the slices for the attribute sections in the GUI Painter

Instance protocol:

 acceptIfUnchanged

 acceptIfUnchanged: something

 acceptOnLeave

 acceptOnLeave: something

 acceptOnLostFocus

make the default true; seems to be a good default.

 acceptOnLostFocus: aBoolean

Modified (format): / 24-11-2017 / 00:24:06 / cg

 acceptOnPointerLeave

 acceptOnPointerLeave: something

 acceptOnReturn

 acceptOnReturn: something

 acceptOnTab

 acceptOnTab: something

 alignment

 alignment: something

 autoSelectInitialText

 autoSelectInitialText: aBoolean

 callbacksSpec

 callbacksSpec: something

 converter

 converter: something

 emptyFieldReplacementText

 emptyFieldReplacementText: aStringOrNil

 entryCompletionBlock

 entryCompletionBlock: something

 formatString

 formatString: something

 group

 group: something

 hasBorder

 hasBorder: aBoolean

 hasKeyboardFocusInitially

 hasKeyboardFocusInitially: aBoolean

 immediateAccept

true

 immediateAccept: aBoolean

 isReadOnly

return true, if the text is readonly.

 isReadOnly: aBoolean

 maxValue

 maxValue: aNumberOrNil

 minValue

return the value of the instance variable 'minValue' (automatically generated)

 minValue: aNumberOrNil

 numChars

 numChars: anIntegerOrNil

 tabable

redefined to default to true (if never set explicitly)

 translateEmptyFieldReplacementText

 translateEmptyFieldReplacementText: aBoolean

 type

 type: something

 valueChangeCallBackSelector

 valueChangeCallBackSelector: aSymbolOrNil

 acceptChannel

 acceptChannel: something

 modifiedChannel

 modifiedChannel: aSymbolOrNil

 x_acceptChannel

return the value of the instance variable 'acceptChannel'.
This MUST not be named acceptChannel, as there is such channel when a spec is edited

 x_acceptChannel: something

set the value of the instance variable 'acceptChannel'
This MUST not be named acceptChannel, as there is such channel when a spec is edited

 x_modifiedChannel

return the value of the instance variable 'modifiedChannel'
This MUST not be named modifiedChannel, as there is such channel when a spec is edited

 x_modifiedChannel: something

set the value of the instance variable 'modifiedChannel'
This MUST not be named modifiedChannel, as there is such channel when a spec is edited

 backgroundColor

 backgroundColor: something

 foregroundColor

 foregroundColor: something

 defineCallBacksFor: aBuilder view: aView

transform ST-80 Style callBackSpec

 getMaxValue: aBuilder

maxValue: either a valueHolder or a constant value

 getMinValue: aBuilder

minValue: either a valueHolder or a constant value

 modelInBuilder: aBuilder

redefined to get a model with optional typeconverter

 nameShownWhileEditingFor: aView

 setAttributesIn: aView with: aBuilder

set my attributes to aView

 setChannelsIn: anEditField with: aBuilder

set my model attributes to anEditField (or its model)

 setKeyboardFocusAttributesIn: aView with: aBuilder

(comment from inherited method)
helper - common code for InputField and TextEditor

 setModelAttributeIn: anEditField with: aBuilder

set my model attributes to anEditField (or its model)

 typeConverterOn: aModel builder: aBuilder

 fromLiteralArrayEncoding: aSpecArray

read my attributes from aSpecArray

 skippedInLiteralEncoding

define the inst-slots which are skipped when generating a literalArrayEncoding;
(to skip the ones with default values.)

 fromView: aView callBack: aBlock

extract attributes from aView

 hasMinMax

 userFriendlyName

answer a good noticeable name of the widget for the GUI Painter and the documentation

 viewClass

return the corresponding view class of the spec

 aspectSelectors

add more aspect selectors (these generate aspect methods in the definer)

 defaultModelClassFor: someAspect

used by the UIPainters aspectGenerator

 acceptUISpecVisitor: aVisitor

Double dispatch back to the visitor, passing my type encoded in
the selector (visitor pattern)