Class: InspectorView

• Inheritance
• Description
• Class protocol
  • common label support
  • defaults
  • image specs
  • initialization
  • instance creation
  • presentation
  • queries-plugin
• Instance protocol
  • accessing
  • accessing-channels
  • change & update
  • drag & drop
  • event handling
  • initialization & release
  • menu
  • menu actions
  • presentation
  • private
  • queries
  • selection
  • user interaction
  • workspace protocol

Inheritance:

   Object
   |
   +--GraphicsMedium
      |
      +--DisplaySurface
         |
         +--SimpleView
            |
            +--InspectorView
               |
               +--ClassInspectorView
               |
               +--ColorInspectorView
               |
               +--ContextInspectorView
               |
               +--DictionaryInspectorView
               |
               +--ImageInspectorView
               |
               +--OrderedCollectionInspectorView
               |
               +--SetInspectorView

Package:

stx:libtool

Category:

Interface-Inspector

Version:

rev: 1.434 date: 2019/08/06 17:09:46

user: stefan

file: InspectorView.st directory: libtool

module: stx stc-classLibrary: libtool

Author:

Claus Gittinger

Description:

This class implements a graphical inspector.
Inspecting can be done on an object -
(where its instvarnames/values are inspected)
or a list of objects (where a nameArray/valuesArray is inspected).
The later is used by the debugger to inspect method variables/args.

The system calls the inspector through the global variable 'Inspector'
which is bound to this class (but could be redefined - it actually is
set to MiniInspector in a smalltalk without graphical user interface,
or to NewInspector if that is wanted).

Also notice, that there are two methods to inspect an object:
sending #basicInspect to any object, will open this kind of inspector on 
it (showing instance variables which are physically present).

Sending it #inspect, will - depending on the object - sometimes invoke a
specialized inspector. 
(see OrderedCollectionInspectorView, ImageInspectorView, 
 ColorInspectorView etc. as examples).

You can also open a monitoring inspector, which displays some instance
variable in regular intervals. See #openOn:monitor:.

examples:
        #(1 2 3 4) asOrderedCollection inspect
        #(1 2 3 4) asOrderedCollection basicInspect
        (Array new:10000) inspect
        (Image fromFile:'bitmaps/claus.gif') inspect
        (Image fromFile:'bitmaps/claus.gif') basicInspect
        (Image fromFile:'bitmaps/SBrowser.xbm') inspect
        (Image fromFile:'bitmaps/SBrowser.xbm') basicInspect

        InspectorView openOn:Display
        InspectorView openOn:Display monitor:'shiftDown'
        InspectorView openOn:(Image fromScreen)
        InspectorView openOn:(Image fromFile:'banner8.xpm')

The InspectorView can also be used as a subComponent within another view.
In this case, the isStandAlone flag should be cleared, to prevent the
inspector from changing the topViews window label.

Notice:
    the instvars 'inspectedObject' and 'selectedLine' have been 
    renamed to 'object' and 'selectionIndex' for squeak compatibility;
    however, the old vars are kept (in sync) for a while, to allow for
    smooth migration.

  Controlling the contents from the inspected object.

By redefining inspectorExtraAttributes or inspectorExtraNamedFields, the inspected
object can add items to the list of fields as ashown in the left list-view of the inspector.
These methods are meant to return a sequencable Collection of Associations, which represent
of pseudo slot-name, slot-value pairs.
In the list, extra attributes are shown with a dash (-), extra named fields are marked with a tick (`).
These are added (read only) to the list.

Class protocol:

 commonLabelFor: anObject

return the windowLabel to use in my topView, when inspecting anObject.
Identical objects are labelled with the same id, which makes it easy to
see if two objects are identical (and is very useful, indeed).
WARNING: used by both Inspector and Inspector2 !!!

 labelNameFor: anObject

return the iconLabel to use in my topView, when inspecting anObject.
Simply returns the className or name of anObjects class

 defaultExtent

return the default extent of my instances.
The value returned here is usually ignored, and
the value from preferredExtent taken instead.

 defaultHideHashes

 defaultHideHashes: aBoolean

 defaultHideMessages

 defaultHideMessages: aBoolean

 defaultIcon

return the browsers default window icon

 defaultIntegerDisplayRadix

 defaultMaxValueDisplayStringLength

cut off and show '...' if longer

 defaultMaxValueDisplayStringLength: anIntegerOrNilForDefault

cut off and show '...' if longer

 defaultSortOrder

 defaultTopViewExtent

 expandArraysInAllLists

in the 'all instvars' list, expand arrays

 expandArraysInAllLists: aBoolean

in the 'all instvars' list, expand arrays

 rememberLastExtent: anExtent

 sortOrderAlphabetical

 sortOrderInstvarOrder

 imageFor_arrays

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

usage example(s):

self imageFor_arrays inspect ImageEditor openOnClass:self andSelector:#imageFor_arrays Icon flushCachedIcons

 imageFor_boolean

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

usage example(s):

self imageFor_boolean inspect ImageEditor openOnClass:self andSelector:#imageFor_boolean Icon flushCachedIcons

 imageFor_characters

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

usage example(s):

self imageFor_characters inspect ImageEditor openOnClass:self andSelector:#imageFor_characters Icon flushCachedIcons

 imageFor_classes

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

usage example(s):

self imageFor_classes inspect ImageEditor openOnClass:self andSelector:#imageFor_classes Icon flushCachedIcons

 imageFor_collectionHolder

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

usage example(s):

self imageFor_collectionHolder inspect ImageEditor openOnClass:self andSelector:#imageFor_collectionHolder Icon flushCachedIcons

 imageFor_collections

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

usage example(s):

self imageFor_collections inspect ImageEditor openOnClass:self andSelector:#imageFor_collections Icon flushCachedIcons

 imageFor_collections_empty

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

usage example(s):

self imageFor_collections_empty inspect ImageEditor openOnClass:self andSelector:#imageFor_collections_empty Icon flushCachedIcons

 imageFor_colors

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

usage example(s):

self imageFor_colors inspect ImageEditor openOnClass:self andSelector:#imageFor_colors Icon flushCachedIcons

 imageFor_dictionaries

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

usage example(s):

self imageFor_dictionaries inspect ImageEditor openOnClass:self andSelector:#imageFor_dictionaries Icon flushCachedIcons

 imageFor_false

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

usage example(s):

self imageFor_false inspect ImageEditor openOnClass:self andSelector:#imageFor_false Icon flushCachedIcons

 imageFor_falseHolder

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

usage example(s):

self imageFor_falseHolder inspect ImageEditor openOnClass:self andSelector:#imageFor_falseHolder Icon flushCachedIcons

 imageFor_floats

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

usage example(s):

self imageFor_floats inspect ImageEditor openOnClass:self andSelector:#imageFor_floats Icon flushCachedIcons

 imageFor_fractions

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

usage example(s):

self imageFor_fractions inspect ImageEditor openOnClass:self andSelector:#imageFor_fractions Icon flushCachedIcons

 imageFor_integers

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

usage example(s):

self imageFor_integers inspect ImageEditor openOnClass:self andSelector:#imageFor_integers Icon flushCachedIcons

 imageFor_nil

 imageFor_nil1

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

usage example(s):

self imageFor_nil1 inspect ImageEditor openOnClass:self andSelector:#imageFor_nil1 Icon flushCachedIcons

 imageFor_nil2

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

usage example(s):

self imageFor_nil2 inspect ImageEditor openOnClass:self andSelector:#imageFor_nil2 Icon flushCachedIcons

 imageFor_nilHolder

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

usage example(s):

self imageFor_nilHolder inspect ImageEditor openOnClass:self andSelector:#imageFor_nilHolder Icon flushCachedIcons

 imageFor_numberHolder

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

usage example(s):

self imageFor_numberHolder inspect ImageEditor openOnClass:self andSelector:#imageFor_numberHolder Icon flushCachedIcons

 imageFor_numbers

 imageFor_others

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

usage example(s):

self imageFor_others inspect ImageEditor openOnClass:self andSelector:#imageFor_others Icon flushCachedIcons

 imageFor_othersHolder

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

usage example(s):

self imageFor_othersHolder inspect ImageEditor openOnClass:self andSelector:#imageFor_othersHolder Icon flushCachedIcons

 imageFor_proxy

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

usage example(s):

self imageFor_proxy inspect ImageEditor openOnClass:self andSelector:#imageFor_proxy Icon flushCachedIcons

 imageFor_sequenceableCollections

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

usage example(s):

self imageFor_sequenceableCollections inspect ImageEditor openOnClass:self andSelector:#imageFor_sequenceableCollections Icon flushCachedIcons

 imageFor_strings

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

usage example(s):

self imageFor_strings inspect ImageEditor openOnClass:self andSelector:#imageFor_strings Icon flushCachedIcons

 imageFor_symbols

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

usage example(s):

self imageFor_symbols inspect ImageEditor openOnClass:self andSelector:#imageFor_symbols Icon flushCachedIcons

 imageFor_timeAndDate

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

usage example(s):

self imageFor_timeAndDate inspect ImageEditor openOnClass:self andSelector:#imageFor_timeAndDate Icon flushCachedIcons

 imageFor_true

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

usage example(s):

self imageFor_true inspect ImageEditor openOnClass:self andSelector:#imageFor_true Icon flushCachedIcons

 imageFor_trueHolder

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

usage example(s):

self imageFor_trueHolder inspect ImageEditor openOnClass:self andSelector:#imageFor_trueHolder Icon flushCachedIcons

 imageGreenBullet

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

usage example(s):

self imageGreenBullet inspect ImageEditor openOnClass:self andSelector:#imageGreenBullet Icon flushCachedIcons

 imageRedBullet

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

usage example(s):

self imageRedBullet inspect ImageEditor openOnClass:self andSelector:#imageRedBullet Icon flushCachedIcons

 initialize

 for: anObject

create and launch a new inspector for anObject.
This protocol is a historic leftover - this method will vanish.

 inspect: anObject

create and launch a new inspector for anObject.
This protocol is a historic leftover - this method will vanish.

 openOn: anObject

create and launch a new inspector for anObject

usage example(s):

InspectorView openOn:(5 @ 7) InspectorView openOn:(Array new:400) DictionaryInspectorView openOn:(IdentityDictionary new)

 openOn: anObject monitor: anInstVarNameOrNil

create and launch a new inspector for anObject.
If anInstVarNameOrNil is nonNil, let the inspector monitor it
(use an integer-printString as name, for indexed instVars).

 openOn: anObject title: aString

create and launch a new inspector for anObject

usage example(s):

InspectorView openOn:(5 @ 7) title:'my point'

 openOn: anObject withEvalPane: withEvalPane

 openOn: anObject withEvalPane: withEvalPane withLabel: aLabel

 iconForValue: anObject

choose a nice icon image to be shown in the list

 iconForValueClass: aClass

this is useful if we do not want to or cannot access the value itself easily;
For example as a helper for bridge objects

 aspectSelectors

Instance protocol:

 allowFollow: aBoolean

enable/disable the follow menu item;
This is disabled for inspectors which are embedded in the debugger

 dereferenceValueHolders: aBoolean

 fieldListLabel: aString

 headLineLabel: aString

an alternative headline label (if used as embedded inspector)

 headLineLabelView

provides access to the headline

 hideHashes: aBoolean

hide/show the hash-entries in the field list;
This can be hidden for end-user applications

 hideMessages: aBoolean

hide/show the messages-entries in the field list;
This can be hidden for end-user applications

 hideReceiver: aBoolean

hide/show the self-entry for the inspected object;
This is hidden for context inspectors in the debugger

 inspect: anObject

set/update the object to be inspected

 inspect: anObject keepSelection: keepSelectionBoolean

set/update the object to be inspected

 inspectNext: anObject

do a followup inspect on an object.
This does either open a new inspector, or advances
the Inspector2 to anObject

 isStandaloneInspector: aBoolean

obsolete now

 label: aString

set the fieldListLabel - obsolete; collides with inherited label-functionality

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

 listView

 maxValueDisplayStringLength

strip off and add '...' if the display string of a selected item is longer.
(can be changed via class default and menu)

 maxValueDisplayStringLength: something

 reinspect

update display for a changed inspectedObject

 suppressHeadline: aBoolean

hide/show the title line above the list/value

 suppressPseudoSlots: aBoolean

to enable/disable the pseudo slots (eg. inspectorExtraAttributes)

 workspace

 inspectedObjectHolder

 inspectedObjectHolder: aValueHolder

 sortOrderHolder

 sortOrderHolder: aValueHolder

 holderChanged: aValueHolder

a valueHolder of which I have registered an iterest
has changed (see the menu item: 'Catch Change').
Remove the interest (no further notifications) either by evaluating:
aValueHolder retractInterestsFor:holderChangeInterest
or:
self doUncatchChanges
here, or via the field menu

 sortOrderHolderChanged

 update: something with: aParameter from: changedObject

Invoked when one of my dependees sends a change notification.

 getDisplayObjects

 getDropObjects

 doubleClickOnLine: lineNr

 keyPress: key x: x y: y

handle special keys

 selectedField

 sizeChanged: how