jetweb is hosted by Hepforge, IPPP Durham

A bundle of utilities for producing HTML output for JetWeb applications. This should as far as possible just invoke various HTMLWriter classes, or have methods which just return strings.

Version:

$Date: 2006-06-21 12:36:40 +0100 (Wed, 21 Jun 2006) $ $Revision: 1197 $

Author:

Jon Butterworth

Field Summary

static java.lang.String	CHI2ALL Result sort option
static java.lang.String	CHI2ALLEE Result sort option
static java.lang.String	CHI2ALLEP Result sort option
static java.lang.String	CHI2ALLPP Result sort option
static java.lang.String	CHI2CHARM Result sort option
static java.lang.String	CHI2CHARMEE Result sort option
static java.lang.String	CHI2CHARMEP Result sort option
static java.lang.String	CHI2CHARMPP Result sort option
static java.lang.String	CHI2HIGH Result sort option
static java.lang.String	CHI2HIGHEE Result sort option
static java.lang.String	CHI2HIGHEP Result sort option
static java.lang.String	CHI2HIGHPP Result sort option
static java.lang.String	CHI2LOW Result sort option
static java.lang.String	CHI2LOWEE Result sort option
static java.lang.String	CHI2LOWEP Result sort option
static java.lang.String	CHI2LOWPP Result sort option
static java.lang.String	CHI2SHAPE Result sort option
static java.lang.String	CHI2SHAPEEE Result sort option
static java.lang.String	CHI2SHAPEEP Result sort option
static java.lang.String	CHI2SHAPEPP Result sort option
static java.lang.String	DATE Result sort option
static java.lang.String	DONTCARE Result filter option (no filter)
static java.lang.String	LATEST Result filter option
static java.lang.String	LATESTEE Result filter option
static java.lang.String	LATESTEP Result filter option
static java.lang.String	LATESTPP Result filter option
static java.lang.String	PTHAT Result sort option

Constructor Summary

HTMLUtils()

Method Summary

static void	listPendingJobs(java.io.PrintWriter out, java.lang.String servletPath)
static void	writeControlScreen(java.lang.String message, ResultSearchPattern pattern, PlotSelection whichpapers, java.io.PrintWriter out, java.lang.String servletPath) Return the standard control screen with message.
static java.lang.String	writeInputBox(java.lang.String name, java.lang.Object obj) Write an HTML input box using the give name and object.
static java.lang.String	writeInputBox(java.lang.String name, java.lang.String hover, java.lang.Object obj) Write an HTML input box using the give name, hover text and object.
static java.lang.String	writeInputTag(java.lang.String type, java.lang.String name, java.lang.String hover, java.lang.Object obj) Write an HTML input box using the give type, name, hover text and object.
static void	writeJobRequestForm(java.lang.String message, ResultSearchPattern pattern, PlotSelection whichpapers, java.io.PrintWriter out, java.lang.String servletPath) Write out the Job Request HTML form based.
static void	writeParameterScreen(ResultSearchPattern pattern, java.io.PrintWriter out, java.lang.String servletPath, boolean submitting) Write a screen for the user to enter generator parameters.
static void	writeProcScreen(java.lang.String modelIdString, java.io.PrintWriter out, java.lang.String servletPath) Write out the screen which allows the user to choose which processTypes to generate.
static void	writeQueryScreen(java.lang.String message, ResultSearchPattern pattern, PlotSelection whichpapers, java.io.PrintWriter out, java.lang.String servletPath) Return the standard query screen, with message.
static void	writeSelectPlotsPage(ResultSearchPattern pattern, PlotSelection whichPlots, java.io.PrintWriter out, java.lang.String servletPath) Write out the Job Request HTML form based.
static java.lang.String	writeSubmitButton(java.lang.String name, java.lang.String hover, java.lang.String text) Write an HTML input box using the give name, hover text and object.
static java.lang.String	writeTopMessage(java.lang.String message) Write an HTML message from the server at the top of the screen.

Methods inherited from class java.lang.Object

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

Field Detail

PTHAT

public static final java.lang.String PTHAT

Result sort option

See Also:

Constant Field Values

DATE

public static final java.lang.String DATE

Result sort option

See Also:

Constant Field Values

CHI2ALL

public static final java.lang.String CHI2ALL

Result sort option

See Also:

Constant Field Values

CHI2HIGH

public static final java.lang.String CHI2HIGH

Result sort option

See Also:

Constant Field Values

CHI2LOW

public static final java.lang.String CHI2LOW

Result sort option

See Also:

Constant Field Values

CHI2SHAPE

public static final java.lang.String CHI2SHAPE

Result sort option

See Also:

Constant Field Values

CHI2CHARM

public static final java.lang.String CHI2CHARM

Result sort option

See Also:

Constant Field Values

CHI2ALLEP

public static final java.lang.String CHI2ALLEP

Result sort option

See Also:

Constant Field Values

CHI2HIGHEP

public static final java.lang.String CHI2HIGHEP

Result sort option

See Also:

Constant Field Values

CHI2LOWEP

public static final java.lang.String CHI2LOWEP

Result sort option

See Also:

Constant Field Values

CHI2SHAPEEP

public static final java.lang.String CHI2SHAPEEP

Result sort option

See Also:

Constant Field Values

CHI2CHARMEP

public static final java.lang.String CHI2CHARMEP

Result sort option

See Also:

Constant Field Values

CHI2ALLEE

public static final java.lang.String CHI2ALLEE

Result sort option

See Also:

Constant Field Values

CHI2HIGHEE

public static final java.lang.String CHI2HIGHEE

Result sort option

See Also:

Constant Field Values

CHI2LOWEE

public static final java.lang.String CHI2LOWEE

Result sort option

See Also:

Constant Field Values

CHI2SHAPEEE

public static final java.lang.String CHI2SHAPEEE

Result sort option

See Also:

Constant Field Values

CHI2CHARMEE

public static final java.lang.String CHI2CHARMEE

Result sort option

See Also:

Constant Field Values

CHI2ALLPP

public static final java.lang.String CHI2ALLPP

Result sort option

See Also:

Constant Field Values

CHI2HIGHPP

public static final java.lang.String CHI2HIGHPP

Result sort option

See Also:

Constant Field Values

CHI2LOWPP

public static final java.lang.String CHI2LOWPP

Result sort option

See Also:

Constant Field Values

CHI2SHAPEPP

public static final java.lang.String CHI2SHAPEPP

Result sort option

See Also:

Constant Field Values

CHI2CHARMPP

public static final java.lang.String CHI2CHARMPP

Result sort option

See Also:

Constant Field Values

DONTCARE

public static final java.lang.String DONTCARE

Result filter option (no filter)

See Also:

Constant Field Values

LATEST

public static final java.lang.String LATEST

Result filter option

See Also:

Constant Field Values

LATESTEP

public static final java.lang.String LATESTEP

Result filter option

See Also:

Constant Field Values

LATESTEE

public static final java.lang.String LATESTEE

Result filter option

See Also:

Constant Field Values

LATESTPP

public static final java.lang.String LATESTPP

Result filter option

See Also:

Constant Field Values

Constructor Detail

HTMLUtils

public HTMLUtils()

Method Detail

writeProcScreen

public static void writeProcScreen(java.lang.String modelIdString,
                                   java.io.PrintWriter out,
                                   java.lang.String servletPath)
                            throws JetWebException

Write out the screen which allows the user to choose which processTypes to generate.

Throws:

JetWebException

writeQueryScreen

public static void writeQueryScreen(java.lang.String message,
                                    ResultSearchPattern pattern,
                                    PlotSelection whichpapers,
                                    java.io.PrintWriter out,
                                    java.lang.String servletPath)
                             throws JetWebException

Return the standard query screen, with message.

Throws:

JetWebException

writeControlScreen

public static void writeControlScreen(java.lang.String message,
                                      ResultSearchPattern pattern,
                                      PlotSelection whichpapers,
                                      java.io.PrintWriter out,
                                      java.lang.String servletPath)

Return the standard control screen with message.

writeJobRequestForm

public static void writeJobRequestForm(java.lang.String message,
                                       ResultSearchPattern pattern,
                                       PlotSelection whichpapers,
                                       java.io.PrintWriter out,
                                       java.lang.String servletPath)
                                throws JetWebException

Write out the Job Request HTML form based.

Throws:

JetWebException

listPendingJobs

public static void listPendingJobs(java.io.PrintWriter out,
                                   java.lang.String servletPath)

writeParameterScreen

public static void writeParameterScreen(ResultSearchPattern pattern,
                                        java.io.PrintWriter out,
                                        java.lang.String servletPath,
                                        boolean submitting)
                                 throws JetWebException

Write a screen for the user to enter generator parameters.

Throws:

JetWebException

writeSelectPlotsPage

public static void writeSelectPlotsPage(ResultSearchPattern pattern,
                                        PlotSelection whichPlots,
                                        java.io.PrintWriter out,
                                        java.lang.String servletPath)
                                 throws JetWebException

Write out the Job Request HTML form based.

Throws:

JetWebException

writeInputBox

public static java.lang.String writeInputBox(java.lang.String name,
                                             java.lang.String hover,
                                             java.lang.Object obj)

Write an HTML input box using the give name, hover text and object.

writeInputBox

public static java.lang.String writeInputBox(java.lang.String name,
                                             java.lang.Object obj)

Write an HTML input box using the give name and object.

writeSubmitButton

public static java.lang.String writeSubmitButton(java.lang.String name,
                                                 java.lang.String hover,
                                                 java.lang.String text)

Write an HTML input box using the give name, hover text and object.

Parameters:

name - The name of the tag to be submitted

hover - The hover text which will appear when the mouse lies over it.

obj - The text which will appear on the button.

writeInputTag

public static java.lang.String writeInputTag(java.lang.String type,
                                             java.lang.String name,
                                             java.lang.String hover,
                                             java.lang.Object obj)

Write an HTML input box using the give type, name, hover text and object.

Parameters:

type - the type of input tag.

name - The name of the tag to be submitted

hover - The hover text which will appear when the mouse lies over it.

obj - The value which will be submitted.

writeTopMessage

public static java.lang.String writeTopMessage(java.lang.String message)

Write an HTML message from the server at the top of the screen.