com.physpics.tutorials.sourceexplorer

Class SXPage

java.lang.Object

com.physpics.tutorials.sourceexplorer.SXPage

public class SXPage
extends java.lang.Object

An instance of SXPage copies from a .java file in an SXData object to another form, text, code, or html. The work proceeds through "Wrapper"s, each of which does a pass through the lines of the page. A page is the contents of an HTML page, divided into its three sections: header, lines, trailer. String values are null if unassigned.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SXPage.AddEllipses Where lines have been omitted, insert ellipses.
protected static class	SXPage.AssignColorClasses Make any line whose whatFor is non-null have the associated class name Requires: ParseLines
protected static class	SXPage.BePage Wraps lines in a <table>
protected static class	SXPage.BeProgram Creates an executable program from the goals lines.
protected static class	SXPage.BeTable Wraps lines in a <table>
protected static class	SXPage.ComputeSectBodies Compute body for Section lines in program code.
protected static class	SXPage.ComputeTailComments Make any line whose whatFor is colored have a pointer to the Highlight object Requires: ParseLinetour" value="FontViewer-tour" s
class	SXPage.Criteria Class responsible for retaining all information about line acceptability.
static class	SXPage.Hue
protected static class	SXPage.MarkComments Find lines that are comments, either those beginning with // or those in comment blocks: / * .
static class	SXPage.OutForm distinguish output formats
protected static class	SXPage.PickLines Mark as SKIP those lines that are not goals by their tags and the criteria in page.crit
protected static class	SXPage.PruneSects Change type to SKIP for SECT entries not followed by goals lines Requires: ParseLines, PickLines We keep a stack of SECT entries.
protected static class	SXPage.RemoveUnneededLines Remove lines that are not needed for output.
protected static class	SXPage.SetLineSects Assign to each PgLine.sect the SectLine for its enclosing section.
static class	SXPage.Wrapper A Wrapper is invoked to embellish the text of an SXPage.
class	SXPage.Writer

Field Summary

Fields

Modifier and Type	Field and Description
boolean	ellipsesOn
boolean	executableOn
boolean	linenumOn
protected static int	MAX_SECTION_DEPTH
static java.lang.String	NL
boolean	sectionsOn
boolean	whatForOn

Constructor Summary

Constructors

Constructor and Description
SXPage(SourceExplorer main, SXData original)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	ampLify(java.lang.String s) Convert html characters to character entities: & < > " convert to &amp; &lt; &gt; &quot;
static java.lang.String[]	getOptions()
static java.lang.String[]	getOutForms()
java.lang.String	parseGoals(java.util.ArrayList<java.lang.String> argl)
java.lang.String	parseGoals(java.lang.String s)
java.lang.String	parseOptions(java.util.ArrayList<java.lang.String> argl)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NL

public static final java.lang.String NL

See Also:

Constant Field Values

MAX_SECTION_DEPTH

protected static final int MAX_SECTION_DEPTH

See Also:

Constant Field Values

executableOn

public boolean executableOn

sectionsOn

public boolean sectionsOn

ellipsesOn

public boolean ellipsesOn

linenumOn

public boolean linenumOn

whatForOn

public boolean whatForOn

Constructor Detail

SXPage

public SXPage(SourceExplorer main,
              SXData original)

Method Detail

getOutForms

public static java.lang.String[] getOutForms()

getOptions

public static java.lang.String[] getOptions()

ampLify

public static java.lang.String ampLify(java.lang.String s)

Convert html characters to character entities: & < > " convert to &amp; &lt; &gt; &quot;

Parameters:

s - The string to write as a row to the output

Returns:

The revised string

parseGoals

public java.lang.String parseGoals(java.lang.String s)

parseGoals

public java.lang.String parseGoals(java.util.ArrayList<java.lang.String> argl)

parseOptions

public java.lang.String parseOptions(java.util.ArrayList<java.lang.String> argl)