com.netscape.pm.htmlFE
Interface IHTMLPage

public interface IHTMLPage

This object is used to stream output from Process Manager.

See Also:

IPresentationElement

Method Summary

IHTMLPage	addAttribute(java.lang.String name, boolean value) Adds an attribute to the model.
IHTMLPage	addAttribute(java.lang.String name, java.util.Date value) Adds an attribute to the model.
IHTMLPage	addAttribute(java.lang.String name, double value) Adds an attribute to the model.
IHTMLPage	addAttribute(java.lang.String name, java.util.Enumeration en) Adds an attribute to the model.
IHTMLPage	addAttribute(java.lang.String name, java.util.Hashtable ht) Adds an attribute to the data model.
IHTMLPage	addAttribute(java.lang.String name, int value) Adds an attribute to the model.
IHTMLPage	addAttribute(java.lang.String name, long value) Adds an attribute to the model.
IHTMLPage	addAttribute(java.lang.String name, java.lang.Object value) Adds an attribute to the model.
IHTMLPage	addAttribute(java.lang.String name, java.lang.String value) Adds an attribute to the model.
IHTMLPage	addAttribute(java.lang.String name, java.util.Vector v) Adds an attribute to the model.
IHTMLPage	beginScript(java.lang.String comment) Writes out the following string to the stream.
IHTMLPage	closeModel() Writes the following string to the servlet response stream.
IHTMLPage	closeNode() Writes the following string to the servlet response stream.
IHTMLPage	endScript() Writes out the following string to the stream.
void	flush() Flushes out the contents of the buffer to the stream of the HttpServletResponse object.
IHTMLPage	openModel(java.lang.String root) Writes the following string to the servlet response stream.
IHTMLPage	openNode(java.lang.String name) Writes the following string to the servlet response stream.
IHTMLPage	println(java.lang.String content) Writes out the content to the HttpServletResponse object.
IHTMLPage	write(java.lang.String content) Writes out the content to the HttpServletResponse object.
IHTMLPage	writeComment(java.lang.String comment) writes out a comment of the following format to the stream <!-- comment -->
IHTMLPage	writeln(java.lang.String content) Writes out the content to the HttpServletResponse object.
IHTMLPage	writeScript(java.lang.String csjsContent) Writes out the following string to the stream.
IHTMLPage	writeScript(java.lang.String csjsContent, java.lang.String comment) Writes out the following string to the stream.

Method Detail

write

public IHTMLPage write(java.lang.String content)

Writes out the content to the HttpServletResponse object.

Parameters:

content - a String object

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

println(java.lang.String), writeln(java.lang.String)

println

public IHTMLPage println(java.lang.String content)

Writes out the content to the HttpServletResponse object. Writes a a newline character to the stream after writing the content.

Parameters:

content - a String object

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

println(java.lang.String), writeln(java.lang.String)

writeln

public IHTMLPage writeln(java.lang.String content)

Writes out the content to the HttpServletResponse object. Also writes the characters

<BR>

to the stream after the content.

Parameters:

content - a String object

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

println(java.lang.String), writeln(java.lang.String)

flush

public void flush()

Flushes out the contents of the buffer to the stream of the HttpServletResponse object.

writeComment

public IHTMLPage writeComment(java.lang.String comment)

writes out a comment of the following format to the stream <!-- comment -->

Parameters:

comment - The comment that should be written out.

Returns:

this IHTMLPage object.

Since:

PAE 4.0

writeScript

public IHTMLPage writeScript(java.lang.String csjsContent)

Writes out the following string to the stream.

 <SCRIPT language='JavaScript'>
 <!--
     ... JavaScript source contained in the csjsContent parameter...
 // -->
 </SCRIPT>
 

Parameters:

csjsContent - The client side Javascript content that should be written out

Returns:

this IHTMLPage object.

Since:

PAE 4.0

writeScript

public IHTMLPage writeScript(java.lang.String csjsContent,
                             java.lang.String comment)

Writes out the following string to the stream.

 <!-- begin comment -->
 <SCRIPT language='JavaScript'>
 <!--
     ... JavaScript source ...
 // -->
 </SCRIPT>
 <!-- end comment -->
 

Parameters:

csjsContent - The client side Javascript content that should be written out

comment - The comment that should be written out to the stream.

Returns:

this IHTMLPage object.

Since:

PAE 4.0

beginScript

public IHTMLPage beginScript(java.lang.String comment)

Writes out the following string to the stream. This method can be used to write the beginning of a Javascript script to the servlet response stream.

 <!-- begin comment -->
 <SCRIPT language='JavaScript'>
 <!--
 

Parameters:

comment - The comment that should be written out to the stream.

Returns:

this IHTMLPage object.

Since:

PAE 4.0

endScript

public IHTMLPage endScript()

Writes out the following string to the stream. This method can be used to write the ending of a Javascript script to the servlet response stream.

     
 // --<
 </SCRIPT>
 

Returns:

this IHTMLPage object.

Since:

PAE 4.0

openNode

public IHTMLPage openNode(java.lang.String name)

Writes the following string to the servlet response stream. This method should be used to dump the a data model to the servlet response stream. A __DataModel object is a collection of name value pairs keyed by the names.

 n# = new __DataModel();
 __add( 'name', n# );
 with( n# ) {
 

Parameters:

name - The name of the object that should be added to the data model.

Returns:

this IHTMLPage object.

Since:

PAE 4.0

closeNode

public IHTMLPage closeNode()

Writes the following string to the servlet response stream.

 }  // closes with block 
 

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

openModel

public IHTMLPage openModel(java.lang.String root)

Writes the following string to the servlet response stream.

 <DATA NAME='root' TYPE='JavaScript'>
 <!-- begin root -->
 <SCRIPT language='JavaScript'>
 <!--
     root = new __DataModel();
     with( root ) {
 

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

closeModel

public IHTMLPage closeModel()

Writes the following string to the servlet response stream.

     }  // closeNode
 // -->
 </SCRIPT>
 </DATA>
 

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

addAttribute

public IHTMLPage addAttribute(java.lang.String name,
                              java.lang.Object value)

Adds an attribute to the model. The object's type is determined and the appropriate addAttribute method is called. Writes the following string to the servlet response stream where

valueString

is a stringified representation of the object parameter

value

.

 __add( 'name', valueString );
 

Parameters:

name - The name by which the object that is to be added to the data model is going to be indexed.

obj - The object that is to be stored in the data model

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

addAttribute

public IHTMLPage addAttribute(java.lang.String name,
                              long value)

Adds an attribute to the model. The stringified representation of the long parameter is written out to the servlet response stream. Writes the following string to the servlet response stream where

valueString

is a stringified representation of the long parameter

value

.

 __add( 'name', valueString );
 

Parameters:

name - The name by which the object that is to be added to the data model is going to be indexed.

value - The long that is to be stored in the data model

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

addAttribute

public IHTMLPage addAttribute(java.lang.String name,
                              double value)

Adds an attribute to the model. The stringified representation of the double parameter is written out to the servlet response stream. Writes the following string to the servlet response stream where

valueString

is a stringified representation of the double parameter

value

.

 __add( 'name', valueString );
 

Parameters:

name - The name by which the object that is to be added to the data model is going to be indexed.

value - The double that is to be stored in the data model

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

addAttribute

public IHTMLPage addAttribute(java.lang.String name,
                              int value)

Adds an attribute to the model. The stringified representation of the int parameter is written out to the servlet response stream. Writes the following string to the servlet response stream where

valueString

is a stringified representation of the int parameter

value

.

 __add( 'name', valueString );
 

Parameters:

name - The name by which the object that is to be added to the data model is going to be indexed.

value - The int that is to be stored in the data model

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

addAttribute

public IHTMLPage addAttribute(java.lang.String name,
                              boolean value)

Adds an attribute to the model. The stringified representation of the boolean parameter is written out to the servlet response stream. Writes the following string to the servlet response stream where

valueString

is a stringified representation of the boolean parameter

value

.

 __add( 'name', valueString );
 

Parameters:

name - The name by which the object that is to be added to the data model is going to be indexed.

value - The boolean that is to be stored in the data model

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

addAttribute

public IHTMLPage addAttribute(java.lang.String name,
                              java.lang.String value)

Adds an attribute to the model. The stringified representation of the string parameter is written out to the servlet response stream. Writes the following string to the servlet response stream where

valueString

is a stringified representation of the string parameter

value

.

 __add( 'name', valueString );
 

Parameters:

name - The name by which the object that is to be added to the data model is going to be indexed.

value - The string that is to be stored in the data model

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

addAttribute

public IHTMLPage addAttribute(java.lang.String name,
                              java.util.Date value)

Adds an attribute to the model. The stringified representation of the date parameter is written out to the servlet response stream. Writes the following string to the servlet response stream where

valueString

is a stringified representation of the date parameter

value

.

 __add( 'name', valueString );
 

Parameters:

name - The name by which the object that is to be added to the data model is going to be indexed.

value - The date that is to be stored in the data model

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

addAttribute

public IHTMLPage addAttribute(java.lang.String name,
                              java.util.Enumeration en)

Adds an attribute to the model. The stringified representation of the enumeration is written out to the servlet response stream. The enumeration is written out in a string format that can be understood as a client side Javascript array.

Parameters:

name - The name by which the object that is to be added to the data model is going to be indexed.

en - The enumeration that is to be stored in the data model

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

addAttribute

public IHTMLPage addAttribute(java.lang.String name,
                              java.util.Vector v)

Adds an attribute to the model. The stringified representation of the vector is written out to the servlet response stream. The vector is written out in a string format that can be understood as a client side Javascript array.

Parameters:

name - The name by which the object that is to be added to the data model is going to be indexed.

v - The vector that is to be stored in the data model

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)

addAttribute

public IHTMLPage addAttribute(java.lang.String name,
                              java.util.Hashtable ht)

Adds an attribute to the data model. The stringified representation of the hashtable is written out to the servlet response stream. The hashtable is written out in a string format that can be understood as a client side Javascript array.

Parameters:

name - The name by which the object that is to be added to the data model is going to be indexed.

ht - The hashtable that is to be stored in the data model

Returns:

this IHTMLPage object.

Since:

PAE 4.0

See Also:

openNode(java.lang.String)