UISpecificationTool.st
changeset 580 77cf5b8dcffc
parent 540 cf67668c680c
child 584 351914fcc5a4
equal deleted inserted replaced
579:0f86dfeb6890 580:77cf5b8dcffc
    63     UIHelpTool openOnClass:UISpecificationTool    
    63     UIHelpTool openOnClass:UISpecificationTool    
    64     "
    64     "
    65 
    65 
    66   ^ super helpSpec addPairsFrom:#(
    66   ^ super helpSpec addPairsFrom:#(
    67 
    67 
       
    68 #acceptChannel
       
    69 'acceptChannel for the view. This field specifies the name of the aspect (-method or binding) in your application, which is supposed to return a valueHolder on to the boolean accept-flag.\ If the holder changed its value to true, the contents will be accepted and the modifiaction flag is set to false.'
       
    70 
    68 #acceptImmediate
    71 #acceptImmediate
    69 'input will we sent to the model immediately (every key)'
    72 'input will we sent to the model immediately (every key)'
    70 
    73 
    71 #acceptOnLeave
    74 #acceptOnLeave
    72 'input will we sent to the model when the field is left via cursor keys'
    75 'input will we sent to the model when the field is left via cursor keys'
   111 'set the background color if the color-checkBox is turned on. Otherwise, the widget uses its default background color (which is specified in the styleSheet).'
   114 'set the background color if the color-checkBox is turned on. Otherwise, the widget uses its default background color (which is specified in the styleSheet).'
   112 
   115 
   113 #beDefault
   116 #beDefault
   114 'show/dont show a return-key image after the label'
   117 'show/dont show a return-key image after the label'
   115 
   118 
       
   119 #beDependentOfRows
       
   120 'make each row in the list dependant. Thus, whenever a row raises a change notification, the row will be redrawn (if visible on the screen).'
       
   121 
   116 #booleanHolder
   122 #booleanHolder
   117 'aspect of a boolean holder which keeps the state'
   123 'aspect of a boolean holder which keeps the state'
   118 
   124 
   119 #borderWidth
   125 #borderWidth
   120 'width of the border'
   126 'width of the border'
   126 'the argument to the selector or none'
   132 'the argument to the selector or none'
   127 
   133 
   128 #canvasSelector
   134 #canvasSelector
   129 'after opening the application as specified by the clientKey,  this message will be sent'
   135 'after opening the application as specified by the clientKey,  this message will be sent'
   130 
   136 
       
   137 #clientHolder
       
   138 'holder which provides the sub application to be opened'
       
   139 
   131 #clientKey
   140 #clientKey
   132 'returns an application which provides the builder. By default the application itself is used.'
   141 'returns an application which provides the builder. By default the application itself is used.'
   133 
   142 
   134 #codeBaseHolder
   143 #codeBaseHolder
   135 'The URL of the directory, where the classFile-file resides. If the classFile is located on the local machine, use\     file:/<fullPath>\ where fullPath is an absolute pathname. If its to be accessed via http, use\     http:/<host>/<relativePath>\ where relativePath is the path relative to the http''s top diretory on that host.'
   144 'The URL of the directory, where the classFile-file resides. If the classFile is located on the local machine, use\     file:/<fullPath>\ where fullPath is an absolute pathname. If its to be accessed via http, use\     http:/<host>/<relativePath>\ where relativePath is the path relative to the http''s top diretory on that host.'
   136 
   145 
   137 #codeFileEntry
   146 #codeFileEntry
   138 'The name of the java classFile  which contains the applets code.  For example: ''ArcTest.class'''
   147 'The name of the java classFile  which contains the applets code.  For example: ''ArcTest.class'''
   139 
   148 
       
   149 #columnButton
       
   150 'open the dataset builder'
       
   151 
       
   152 #columnHolder
       
   153 'valuHolder, which provides a list of column descriptions.'
       
   154 
   140 #defaultLabel
   155 #defaultLabel
   141 'the default label  (used, if nothing selected).'
   156 'the default label  (used, if nothing selected).'
   142 
   157 
   143 #document
   158 #document
   144 'a holder which keeps the document name.'
   159 'a holder which keeps the document name.'
   145 
   160 
   146 #doubleClickSelector
   161 #doubleClickSelector
   147 'double click action which is evaluated on double click in  case of a non-nil selection.  If the selector ends with '':'' the method is invoked with the current selection as argument.'
   162 'double click action which is evaluated on double click in case of a non-nil selection. \ If the selector ends with '':'' the method is invoked with the current selection as argument.'
       
   163 
       
   164 #downAction
       
   165 'action selector sent to the application when the down button is activated. The selector may be for a one-arg message; in this case, the argument is passed.'
   148 
   166 
   149 #enableChannel
   167 #enableChannel
   150 'enableHolder for the view. This field specifies the name of the aspect (-method or binding) in your application, which is supposed to return a valueHolder on to the boolean enable-flag. This is convenient, if many widgets are to be enabled/disabled depending on the setting of a single flag, because the application can change them all with a single setting of the enableHolders value.'
   168 'enableHolder for the view. This field specifies the name of the aspect (-method or binding) in your application, which is supposed to return a valueHolder on to the boolean enable-flag. This is convenient, if many widgets are to be enabled/disabled depending on the setting of a single flag, because the application can change them all with a single setting of the enableHolders value.'
   151 
   169 
       
   170 #fileSelectionFilterClas
       
   171 'the name of the Item class used to create the entries into the hierarchical list. The class is oblegated to provide the whole interface of the FileSelectionItem class. If no class is specified, the FileSelectionItem class is used. \ Thus you can define your own filter operations, icons, ....'
       
   172 
   152 #fileSelectionTreeRoot
   173 #fileSelectionTreeRoot
   153 'a holder, which keeps the pathname of the root directory (first entry in the list).'
   174 'a holder, which keeps the pathname of the root directory (first entry in the list).'
   154 
   175 
       
   176 #fitLastRow
       
   177 'fit rows to tab horizontal or vertical extent'
       
   178 
   155 #fontMenu
   179 #fontMenu
   156 'set the font for the widget if the font-checkBox is turned on. Otherwise, the widget uses its default font (which is specified in the viewStyle).'
   180 'set the font for the widget if the font-checkBox is turned on. Otherwise, the widget uses its default font (which is specified in the viewStyle).'
   157 
   181 
   158 #forceRecursiveBackground
   182 #forceRecursiveBackground
   159 'also change all subcomponents viewBackground (recursively).'
   183 'also change all subcomponents viewBackground (recursively).'
   174 'a holder, which keeps the specification of the current selected widget or nil.'
   198 'a holder, which keeps the specification of the current selected widget or nil.'
   175 
   199 
   176 #gallerySelectors
   200 #gallerySelectors
   177 'the list of selectors specify which interface specification should be used dependent on the tab pressed. Each selector must return an interfaceSpec. On default the #windowSpec method is used'
   201 'the list of selectors specify which interface specification should be used dependent on the tab pressed. Each selector must return an interfaceSpec. On default the #windowSpec method is used'
   178 
   202 
       
   203 #has3Dsepartors
       
   204 'show all the column and row separators in a 3D-look'
       
   205 
   179 #hasBorder
   206 #hasBorder
   180 'currently ignored - kept to avoid loosing information of imported VW window specs'
   207 'currently ignored - kept to avoid loosing information of imported VW window specs'
   181 
   208 
   182 #hierarchicalList
   209 #hierarchicalList
   183 'gets a hierarchical list or a holder which keeps a hierarchical list entry; the value must understand the TreeItem protocol.'
   210 'gets a hierarchical list or a holder which keeps a hierarchical list entry; the value must understand the TreeItem protocol.'
   192 'use a mini-horizontalScroller'
   219 'use a mini-horizontalScroller'
   193 
   220 
   194 #horizontalScroller
   221 #horizontalScroller
   195 'make the view horizontally scrollable'
   222 'make the view horizontally scrollable'
   196 
   223 
       
   224 #horizontalSpace
       
   225 'horizontal space between elements on pixels'
       
   226 
   197 #id
   227 #id
   198 'the symbolic name of the component.  This ID can be used by the application to access components, using #componentAt:<ID>'
   228 'the symbolic name of the component.  This ID can be used by the application to access components, using #componentAt:<ID>'
   199 
   229 
   200 #initiallyDisabled
   230 #initiallyDisabled
   201 'if on, the widget is initially disabled (to be enabled programatically with "(self componentAt:<ID>) enable").'
   231 'if on, the widget is initially disabled (to be enabled programatically with "(self componentAt:<ID>) enable").'
   207 'symbolic ID of the input group - fields within a group can be reached via cursor up/down.'
   237 'symbolic ID of the input group - fields within a group can be reached via cursor up/down.'
   208 
   238 
   209 #isMultiSelect
   239 #isMultiSelect
   210 'enable/disable multiple selections.'
   240 'enable/disable multiple selections.'
   211 
   241 
       
   242 #isOpaque
       
   243 'define how the widget is displayed; opaque or not opaque'
       
   244 
   212 #isTriggerOnDown
   245 #isTriggerOnDown
   213 'if true, the action is evaluated when the button is pressed; otherwise, when released.'
   246 'if true, the action is evaluated when the button is pressed; otherwise, when released.'
   214 
   247 
   215 #label
   248 #label
   216 'the label of the widget. If ''label is image'' is off, this is the label string. Otherwise, it specifies the applications selector, which returns the label - either a string or a bitmap image.'
   249 'the label of the widget. If ''label is image'' is off, this is the label string. Otherwise, it specifies the applications selector, which returns the label - either a string or a bitmap image.'
   219 'a holder, which provides the widgets label. Useful if the label is to be changed dynamically.'
   252 'a holder, which provides the widgets label. Useful if the label is to be changed dynamically.'
   220 
   253 
   221 #labelIsImage
   254 #labelIsImage
   222 'if ''label is image'' is off (the default), the widgets label is the string as entered in the label aspect. Otherwise, its the name of the message sent to the application - this should return a string or bitmap image, which is used as logo in the widget.'
   255 'if ''label is image'' is off (the default), the widgets label is the string as entered in the label aspect. Otherwise, its the name of the message sent to the application - this should return a string or bitmap image, which is used as logo in the widget.'
   223 
   256 
       
   257 #labelPositionList
       
   258 'define the position of the label'
       
   259 
   224 #lampColor
   260 #lampColor
   225 'set the lamp color if the color-checkBox is turned on. Otherwise, the widget uses its default lamp color (which is specified in the styleSheet).'
   261 'set the lamp color if the color-checkBox is turned on. Otherwise, the widget uses its default lamp color (which is specified in the styleSheet).'
   226 
   262 
   227 #level
   263 #level
   228 'the 3D-level relative to its superView. If left blank, the components default is used.'
   264 'the 3D-level relative to its superView. If left blank, the components default is used.'
   270 'the minimum height - the user will not be allowed to resize the topView to a smaller height.'
   306 'the minimum height - the user will not be allowed to resize the topView to a smaller height.'
   271 
   307 
   272 #minorKey
   308 #minorKey
   273 'the selector specifies which interface specification to be used. The selector must return an interfaceSpec. By default the #windowSpec method is used.'
   309 'the selector specifies which interface specification to be used. The selector must return an interfaceSpec. By default the #windowSpec method is used.'
   274 
   310 
       
   311 #modifiedChannel
       
   312 'modifiedHolder for the view. This field specifies the name of the aspect (-method or binding) in your application, which is supposed to return a valueHolder on to the boolean modified-flag. \ The holder is set dependant on the modification state of the view contents.'
       
   313 
       
   314 #monitoring
       
   315 'start or stop a background process, which will update the list dependant on any directory change.\ Between each check cycle, there is a defined delay time measured in seconds.'
       
   316 
       
   317 #monitoringDelayTime
       
   318 'delay time of the monitoring task in seconds'
       
   319 
       
   320 #moveSelectedRow
       
   321 'move selected row always to view'
       
   322 
   275 #oneTabPerLine
   323 #oneTabPerLine
   276 'draw only one tab per line'
   324 'draw only one tab per line'
   277 
   325 
       
   326 #orientation
       
   327 'define the orientation of the widget; horizontal or vertical.'
       
   328 
   278 #paramAdd
   329 #paramAdd
   279 'Adds a name-value pair to the parameters collection.'
   330 'Adds a name-value pair to the parameters collection.'
   280 
   331 
   281 #paramList
   332 #paramList
   282 'Lists defined parameters.'
   333 'Lists defined parameters.'
   300 'the value associated with that radioButton. When clicked, this will be stored into the group-model. If left empty, buttons are numbered sequentially, starting with 1.'
   351 'the value associated with that radioButton. When clicked, this will be stored into the group-model. If left empty, buttons are numbered sequentially, starting with 1.'
   301 
   352 
   302 #readOnly
   353 #readOnly
   303 'the field is readOnly - its contents cannot be modified by the user (however, the program can)'
   354 'the field is readOnly - its contents cannot be modified by the user (however, the program can)'
   304 
   355 
       
   356 #regionType
       
   357 'define the shape of the widget'
       
   358 
   305 #resizeForLabel
   359 #resizeForLabel
   306 'if on, the widget is allowed to resize itself to fit the labelString - if off, the size is frozen.'
   360 'if on, the widget is allowed to resize itself to fit the labelString - if off, the size is frozen.'
   307 
   361 
       
   362 #rowIfAbsent
       
   363 'name of a method in the application which is invoked whenever an empty list entry is detected. The method is called with the index into the list and should return a valid row instance. \ Thus, you are able to define a list with all elements set to nil.'
       
   364 
       
   365 #selectConditionSelector
       
   366 'name of a method in the application which is invoked before the selection changed. The selection will not be done, if the method returns false. \ If the selector ends with '':'' the method is invoked with the selection-line-number as argument.'
       
   367 
   308 #selectionHolder
   368 #selectionHolder
   309 'the aspect of the valueHolder which holds the selection or input value.'
   369 'the aspect of the valueHolder which holds the selection or input value.'
   310 
   370 
   311 #setMaxExtent
   371 #setMaxExtent
   312 'set the maximum size from the topViews current size.'
   372 'set the maximum size from the topViews current size.'
   313 
   373 
   314 #setMinExtent
   374 #setMinExtent
   315 'set the minumum size from the topViews current size.'
   375 'set the minumum size from the topViews current size.'
   316 
   376 
   317 #showDirectoryIndication
   377 #showDirectoryIndicator
   318 'show or hide the open/closed indicator on nodes which contains children'
   378 'enable/disable directory indicator (+/-) for none empty directories'
       
   379 
       
   380 #showDirectoryIndicatorForRoot
       
   381 'disable the directory indicator for the first element of the hierarchical list in case that the global directory indication is set to true.'
   319 
   382 
   320 #showFrame
   383 #showFrame
   321 'show the frame'
   384 'show the frame'
   322 
   385 
   323 #showLamp
   386 #showLamp
   324 'enable/disable display of the toggles lamp.'
   387 'enable/disable display of the toggles lamp.'
   325 
   388 
   326 #showLines
   389 #showLines
   327 'show or hide lines'
   390 'show or hide lines'
   328 
   391 
       
   392 #showPercentage
       
   393 'define if the percentage is to be shown numerically'
       
   394 
   329 #showRoot
   395 #showRoot
   330 'show or hide the first element of the hierarchical list.'
   396 'show or hide the first element of the hierarchical list.'
   331 
   397 
       
   398 #showSeparatingLines
       
   399 'seperate each menu item by a vertical or horizontal line dependant on its vertical layout'
       
   400 
   332 #sizeAsDefault
   401 #sizeAsDefault
   333 'let the widget compute its size to include space for the default (return) image. Useful for buttons which are not default buttons initially, but may become a default button dynamically.'
   402 'let the widget compute its size to include space for the default (return) image. Useful for buttons which are not default buttons initially, but may become a default button dynamically.'
   334 
   403 
       
   404 #specHolder
       
   405 'holder which provides the selector to access the windowspec used to open the sub application derived from the application holder. If no selector is defined, the #windowSpec selector is used.'
       
   406 
       
   407 #start
       
   408 'define the scroller/slider''s range minimum'
       
   409 
       
   410 #step
       
   411 'define the scroller/slider''s range step'
       
   412 
       
   413 #stop
       
   414 'define the scroller/slider''s range maximum'
       
   415 
   335 #tabLabels
   416 #tabLabels
   336 'a list or list holder which provides the labels assigned to the tabs.'
   417 'a list or list holder which provides the labels assigned to the tabs.'
   337 
   418 
   338 #tabOrientation
   419 #tabOrientation
   339 'where to place the tabs'
   420 'where to place the tabs'
   348 'if on, the labelString is translated via the resource mechanism to a national language string (if a translation for that string is present in the resource file of the application).'
   429 'if on, the labelString is translated via the resource mechanism to a national language string (if a translation for that string is present in the resource file of the application).'
   349 
   430 
   350 #typeConverter
   431 #typeConverter
   351 'convert the fields string value to some other object. Needed if the aspectValue is not a string (typically numbers).'
   432 'convert the fields string value to some other object. Needed if the aspectValue is not a string (typically numbers).'
   352 
   433 
       
   434 #upAction
       
   435 'action selector sent to the application when the up button is activated. The selector may be for a one-arg message; in this case, the argument is passed.'
       
   436 
   353 #useIndex
   437 #useIndex
   354 'set/clear the useIndex flag. If set, the index of the selection is stored into the model; otherwise the selected string.'
   438 'set/clear the useIndex flag. If set, the index of the selection is stored into the model; otherwise the selected string.'
   355 
   439 
   356 #usePreferredExtent
   440 #usePreferredExtent
   357 'Take the top components preferredExtent as extent of the topView. Only possible if there is exactly one top component (typically: a panel).'
   441 'Take the top components preferredExtent as extent of the topView. Only possible if there is exactly one top component (typically: a panel).'
   358 
   442 
       
   443 #validateDoubleClickSelector
       
   444 'name of a method in the application which is invoked before a not empty directory is opened by a double click. If the method returns false, the directory will not be opened.\ If the selector ends with '':'' the method is invoked with the selection-line-number as argument.'
       
   445 
   359 #valueChangeSelector
   446 #valueChangeSelector
   360 'name of a method in the application which is invoked whenever the selection changed. If the selector ends with '':'' the method is invoked with the current selection.'
   447 'name of a method in the application which is invoked whenever the selection changed. If the selector ends with '':'' the method is invoked with the current selection.'
   361 
   448 
   362 #verticalLayout
   449 #verticalLayout
   363 'specifies how components are to be arranged vertically'
   450 'specifies how components are to be arranged vertically'
   366 'use a mini-verticalScroller'
   453 'use a mini-verticalScroller'
   367 
   454 
   368 #verticalScroller
   455 #verticalScroller
   369 'make the view vertically scrollable'
   456 'make the view vertically scrollable'
   370 
   457 
       
   458 #verticalSpace
       
   459 'the vertical space between elements on pixels'
       
   460 
   371 #windowIcon
   461 #windowIcon
   372 'aspect of the windows icon. This is supposed to provide a bitmap image, which is displayed by the windowManager if your applications gets iconified.'
   462 'aspect of the windows icon. This is supposed to provide a bitmap image, which is displayed by the windowManager if your applications gets iconified.'
   373 
   463 
   374 #windowIconLabel
   464 #windowIconLabel
   375 'the windows icon label. This will be displayed by most windowManagers in the icon if the topView is iconified.'
   465 'the windows icon label. This will be displayed by most windowManagers in the icon if the topView is iconified.'
   376 
   466 
   377 #windowLabel
   467 #windowLabel
   378 'the windows label. This will be displayed by the windowManager in the windows frame.'
   468 'the windows label. This will be displayed by the windowManager in the windows frame.'
   379 
   469 
   380 )
   470 )
   381 
       
   382     "Modified: / 1.2.1998 / 15:00:50 / cg"
       
   383 ! !
   471 ! !
   384 
   472 
   385 !UISpecificationTool class methodsFor:'interface specs'!
   473 !UISpecificationTool class methodsFor:'interface specs'!
   386 
   474 
   387 windowSpec
   475 windowSpec