Class: stx_goodies_webServer_htmlTree

• Inheritance
• Description
• Class protocol
  • description
  • description - compilation
  • description - contents
  • description - project information

Inheritance:

   Object
   |
   +--ProjectDefinition
      |
      +--LibraryDefinition
         |
         +--stx_goodies_webServer_htmlTree

Package:

stx:goodies/webServer/htmlTree

Category:

* Projects & Packages *

Version:

rev: 1.43 date: 2019/03/04 16:33:03

user: cg

file: stx_goodies_webServer_htmlTree.st directory: goodies/webServer/htmlTree

module: stx stc-classLibrary: htmlTree

Description:

Package documentation:

This library implements node elements for an HTML (DOM-) tree.
The tree is usually constructed with an HTMLTreeBuilder,
by sending it convenient html-tree-building messages, which are named as corresponding
HTML DOM-elements.
Then, when finished, the html is generated for transmission from a webService.

On the other side, there is an HTMLParser, which creates such trees.

The basic idea is to  
    - isolate browser-specifics and HTML-specifics (think of XHTML),
     into subclassable builders, which know about such details and allow for mapping of elements/attributes
     if desired.    
    - semantically verify the HTML-construction, by asserting that only valid child elements are added.

Example:
    |bldr|
    bldr := HTML::TreeBuilder new.
    bldr
      html;
        head;
            title:'My First HTML Page';
        headEnd;
        body;
            h1:'Chapter 1';
            p;
            table;
                tr;
                    td;
                        text:'hello with some umlauts: öäü (öäü)';
                    tdEnd;
                    td;
                        rawText:'hello with some umlaut: öäü';
                    tdEnd;
                trEnd;
            tableEnd;    
            pEnd;
        bodyEnd;
      htmlEnd.
    bldr htmlString.    

Class protocol:

 excludedFromPreRequisites

list all packages which should be ignored in the automatic
preRequisites scan. See #preRequisites for more.

 mandatoryPreRequisites

list packages which are mandatory as a prerequisite.
This are packages containing superclasses of my classes and classes which
are extended by myself.
They are mandatory, because we need these packages as a prerequisite for loading and compiling.
This method is generated automatically,
by searching along the inheritance chain of all of my classes.
Please take a look at the #referencedPreRequisites method as well.

 referencedPreRequisites

list packages which are a prerequisite, because they contain
classes which are referenced by my classes.
These packages are NOT needed as a prerequisite for compiling or loading,
however, a class from it may be referenced during execution and having it
unloaded then may lead to a runtime doesNotUnderstand error, unless the caller
includes explicit checks for the package being present.
This method is generated automatically,
by searching all classes (and their packages) which are referenced by my classes.
Please also take a look at the #mandatoryPreRequisites method

 subProjects

list packages which are known as subprojects.
The generated makefile will enter those and make there as well.
However: they are not forced to be loaded when a package is loaded;
for those, redefine requiredPrerequisites.

 additionalDefinitions_bc_dot_mak

 classNamesAndAttributes

lists the classes which are to be included in the project.
Each entry in the list may be: a single class-name (symbol),
or an array-literal consisting of class name and attributes.
Attributes are: #autoload or #<os> where os is one of win32, unix,...

 extensionMethodNames

lists the extension methods which are to be included in the project.
Entries are 2-element array literals, consisting of class-name and selector.
A correponding method with real names must be present in my concrete subclasses
if it has extensions.

 companyName

Return a companyname which will appear in <lib>.rc

 description

Return a description string which will appear in nt.def / bc.def

 legalCopyright

Return a copyright string which will appear in <lib>.rc

 productName

Return a product name which will appear in <lib>.rc