rsc3/doc-schelp/HelpSource/Classes/Class.schelp

117 lines
2.5 KiB
Text

class::Class
summary::A Class describes the structure and implementation of a set objects which are its instances.
categories::Core>Kernel, Language>OOP
ClassMethods::
method:: allClasses
returns:: an link::Classes/Array:: of all Classes
InstanceMethods::
method::browse
Open a graphical browser for this Class. Shows methods, arguments, variables, subclasses, and has buttons for navigating to the superclass, source, helpfile, etc.
method::findMethod
Find the Method referred to by name. If not found, return nil.
method::findRespondingMethodFor
As above, but climb the class tree to see if the method is inherited from a superclass. If not found, return nil.
method::dumpAllMethods
Post all instance methods which instances of this class responds too, including inherited ones. code::this.class.dumpAllMethods:: will post all class methods which this class responds to.
method::dumpByteCodes
Dump the byte codes of the named method.
method::dumpClassSubtree
Post the tree of all Classes that inherit from this class.
method::dumpInterface
Post all the methods defined by this Class and their arguments.
method::dumpFullInterface
Post all the class and instance methods that this class responds to (i.e. those defined in this class and those inherited by it).
method::help
Opens the help file for this Class if it exists.
method::helpFilePath
Returns the path of this Class's helpfile as a String.
method::helpFileForMethod
Opens the helpfile for the class in which the responding method is implemented.
code::
Array.helpFileForMethod('select'); // This will open the Collection helpfile
::
method::asClass
Return this.
method::asString
Return the name of the class as a String.
subsection:: Accessing
method::name
A Symbol that is the name of the class.
method::nextclass
The next class in a linked list of all classes.
method::superclass
The Class from which this class directly inherits.
method::superclasses
An Array of this class's superclasses, going back to Object.
method::subclasses
An Array of the direct subclasses of this.
method::allSubclasses
An Array of all subclasses of this.
method::methods
An Array of the methods of this class.
method::instVarNames
An Array of the names of the instance variables for this class.
method::classVarNames
An Array of the names of the class variables for this class.
method::iprototype
An Array of the initial values of instance variables.
method::cprototype
An Array of the initial values of class variables.
method::filenameSymbol
A Symbol which is a path to the file which defines the Class.