eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'ListEntry':

Home

Documentation
www.exept.de
Everywhere
for:
[back]

Class: ListEntry


Inheritance:

   Object
   |
   +--ListEntry
      |
      +--ListEntry::SeparatingLineEntry
      |
      +--ModelListEntry
      |
      +--MultiColListEntry
      |
      +--Tools::NewSystemBrowser::OwnershipGraph

Package:
stx:libwidg2
Category:
Views-Support
Version:
rev: 1.23 date: 2018/10/27 08:15:43
user: cg
file: ListEntry.st directory: libwidg2
module: stx stc-classLibrary: libwidg2
Author:
Claus Gittinger

Description:


ListEntry is an abstract superclass for objects which can be used
in place of strings in ListViews or SelectionInListViews.

If you want to create new subclasses, implement (at least) the methods
found in the 'required protocol' category.


Related information:

    ListView

Class protocol:

instance creation
o  separatingLineEntry


Instance protocol:

comparing
o  < aString
behave like a string when comparing

o  = aString
behave like a string when comparing

o  hash
return an integer useful for hashing

printing & storing
o  printOn: aStream
(comment from inherited method)
append a user printed representation of the receiver to aStream.
The format is suitable for a human - not meant to be read back.

The default here is to output the receiver's class name.
BUT: this method is heavily redefined for objects which
can print prettier.

o  printString
(comment from inherited method)
return a string for printing the receiver.
Since we now use printOn: as the basic print mechanism,
we have to create a stream and print into it.

queries
o  hasChangeOfEmphasis
return true, if the receiver contains non-empty emphasis information
i.e. any non-normal (=emphasized) characters

o  hasIcon

o  hasImage

o  includes: aCharacter
behave like a string when testing

o  size
behave like a string when asked for the size

o  species
(comment from inherited method)
return a class which is similar to (or the same as) the receiver's class.
This is used to create an appropriate object when creating derived
copies in the collection classes (sometimes redefined).

o  string

required protocol
o  asString
return the receiver as a string (for example, to store it in a file)

** This method raises an error - it must be redefined in concrete classes **

o  displayOn: aGC x: x y: y opaque: opaque
display the receiver on a GC

** This method raises an error - it must be redefined in concrete classes **

o  heightOn: aGC
return the height of the receiver when displayed in aGC.
Assume the GC's font is taken. If that is not the case in a
particular subclass, this method is to be redefined there.

o  sameStringAndEmphasisAs: aStringOrText

o  widthOn: aGC
return the width (in device units) of the receiver when displayed in aGC

** This method raises an error - it must be redefined in concrete classes **

string protocol
o  at: index
behave like a string when accessing characters

o  do: aBlock
behave like a string when enumerating characters

o  withoutAnyColorEmphasis
to be redefined in subclasses


Private classes:

    SeparatingLineEntry


ST/X 7.2.0.0; WebServer 1.670 at bd0aa1f87cdd.unknown:8081; Mon, 04 Jul 2022 11:47:17 GMT