Class: ActiveHelpView

• Inheritance
• Description
• Related information
• Class protocol
  • instance creation
  • updateStyleCache
• Instance protocol
  • accessing
  • event handling
  • initialization
  • private
  • queries

Inheritance:

   Object
   |
   +--GraphicsMedium
      |
      +--DisplaySurface
         |
         +--SimpleView
            |
            +--View
               |
               +--ActiveHelpView

Package:

stx:libview2

Category:

Interface-Help

Version:

rev: 1.61 date: 2018/06/29 09:48:16

user: cg

file: ActiveHelpView.st directory: libview2

module: stx stc-classLibrary: libview2

Author:

Claus Gittinger

Description:

a bubbleHelp view.

Instances of myself show up either as a comics-like talking
view, or as a simple square popup. This is configured via the
styleSheet. The default is simple-square.

To get the fancy comics style, add a resource 'activeHelpStyle' with 
a symbol-value of #cartoon to the stylesheet, or set the overwrite
in the userPrefs with:
    UserPreferences current toolTipShapeStyle:#cartoon.
However, be aware that some servers have performance problems with
these view-shapes (or do not support shapes at all, like XQuartz on OSX).
Therefore, the default style is a rectangular popupView.
If the prefs were changed, you can return back to the stylesheet's default with:
    UserPreferences current toolTipShapeStyle:nil.

Related information:

    ActiveHelp

Class protocol:

 for: someText

create a bubble-view for some text

 for: someText onDevice: aDevice

create a bubble-view for some text

 with: aView

create a talking-view wrapping some other view

usage example(s):

(ActiveHelpView with:(TextView new)) realize (ActiveHelpView with:(TextView new)) open (ActiveHelpView with:(Button label:'ok')) open

 updateStyleCache

(comment from inherited method)
this method gets some heavily used style stuff and keeps
it in class-variables for faster access.
Subclasses should redefine this to load any cached style-values
into faster class variables as well. These should NOT do a
super updateStyleCache, since this method is called for all view-classes
anyway.

Instance protocol:

 contents: someText

set the text

 controllingHelpListener: something

 shapeStyle: aStyleSymbol

set the shapeStyle.
Currently, only nil and #cartoon are supported

 withView: aView

set the component view

 keyPress: key x: x y: y

 initStyle

setup viewStyle specifics

 realize

 computeShape

compute the shape, based upon the size of my component view

 resizeToFit

resize myself to make the component view fit

 isPopUpView

return true - I am a popUp type of view (no decoration, pop-to-top)

 wantsFocusWithButtonPress