HelpSource/Classes/Class.schelp

   1 class::Class
   2 summary::A Class describes the structure and implementation of a set objects which are its instances.
   3 categories::Core>Kernel, Language>OOP
   4
   5 ClassMethods::
   6 method:: allClasses
   7 returns:: an link::Classes/Array:: of all Classes
   8
   9 InstanceMethods::
  10
  11 method::browse
  12
  13 Open a graphical browser for this Class. (OSX only). Shows methods, arguments, variables, subclasses, and has buttons for navigating to the superclass, source, helpfile, cvs, etc.
  14
  15 method::findMethod
  16
  17 Find the Method referred to by name. If not found, return nil.
  18
  19 method::findRespondingMethodFor
  20
  21 As above, but climb the class tree to see if the method is inherited from a superclass. If not found, return nil.
  22
  23 method::dumpAllMethods
  24
  25 Post all instance methods which instances of this class responde too, including inherited ones. this.class.dumpAllMethods will post all class methods which this class responds to.
  26
  27 method::dumpByteCodes
  28
  29 Dump the byte codes of the named method.
  30
  31 method::dumpClassSubtree
  32
  33 Post the tree of all Classes that inherit from this class.
  34
  35 method::dumpInterface
  36
  37 Post all the methods defined by this Class and their arguments.
  38
  39 method::dumpFullInterface
  40
  41 Post all the class and instance methods that this class responds to (i.e. those defined in this class and those inherited by it).
  42
  43 method::openHelpFile
  44
  45 Opens the help file for this Class if it exists.
  46
  47 method::helpFilePath
  48
  49 Returns the path of this Class's helpfile as a String.
  50
  51 method::helpFileForMethod
  52
  53 Opens the helpfile for the class in which the responding method is implemented.
  54
  55 Array.helpFileForMethod('select'); // This will open the Collection helpfile
  56
  57 method::asClass
  58
  59 Return this.
  60
  61 method::asString
  62
  63 Return the name of the class as a String.
  64
  65
  66 subsection:: Accessing
  67
  68 method::name
  69
  70 A Symbol that is the name of the class.
  71
  72 method::nextclass
  73
  74 The next class in a linked list of all classes.
  75
  76 method::superclass
  77
  78 The Class from which this class directly inherits.
  79
  80 method::superclasses
  81
  82 An Array of this class's superclasses, going back to Object.
  83
  84 method::subclasses
  85
  86 An Array of the direct subclasses of this.
  87
  88 method::allSubclasses
  89
  90 An Array of all subclasses of this.
  91
  92 method::methods
  93
  94 An Array of the methods of this class.
  95
  96 method::instVarNames
  97
  98 An Array of the names of the instance variables for this class.
  99
 100 method::classVarNames
 101
 102 An Array of the names of the class variables for this class.
 103
 104 method::iprototype
 105
 106 An Array of the initial values of instance variables.
 107
 108 method::cprototype
 109
 110 An Array of the initial values of class variables.
 111
 112 method::filenameSymbol
 113
 114 A Symbol which is a path to the file which defines the Class.
 115