Smalltalk/X Webserver

Documentation of class 'InspectorView':

Class: InspectorView

Inheritance
Description
Class protocol
Instance protocol

Inheritance:

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

Package:: stx:libtool

Category:: Interface-Inspector

Version:: rev: 1.513 date: 2024/04/22 17:43:29; user: stefan; file: InspectorView.st directory: libtool; module: stx stc-classLibrary: libtool

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.

Catching/Debugging errors in the displayString/printString generation
set TraceErrors or DebugErrors to true
TraceErrors := true

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.

Class protocol:

common label support

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

defaults

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
defaultIntegerDisplayRadix: anInteger
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
sortOrderByValuesClassName
sortOrderByValuesPrintString
sortOrderInstvarOrder

image specs

imageFor_arrays