com.goldencode.p2j.ui.client

Class PageElement

java.lang.Object

com.goldencode.p2j.ui.client.PageElement

All Implemented Interfaces:

RepeatedOutput

public class PageElement
extends java.lang.Object
implements RepeatedOutput

Implements page-top/page-bottom frame output for reports by providing an output callback mechanism which allows the output from a given frame to be generated at the top or bottom of a page in a paged output stream. This enables page headers and footers.

Please note that the only requirement for this output is that the number of lines which it consumes MUST be constant across all invocations of the render(com.goldencode.p2j.util.Stream) method. This is necessary to properly determine when a header/footer needs to be emitted. The output within the given number of lines may vary (e.g. page numbers may increment).

Field Summary

Fields

Modifier and Type	Field and Description
private int	frameId The frame id of the frame to be output.
private int	height The total number of rows output during rendering.
private ThinClient	term The client terminal which is redirected to a paged output stream.

Constructor Summary

Constructors

Constructor and Description
PageElement(ThinClient term, int frameId) Construct a page element and initialize its data structures.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object x) Compares two objects for equality.
int	hashCode() Return a hash code for the instance.
int	height() Returns the height of the output as the number of lines that will be generated when render(com.goldencode.p2j.util.Stream) is called.
void	render(Stream out) Generate output and write it to the given stream.

Methods inherited from class java.lang.Object

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

Field Detail

term

private ThinClient term

The client terminal which is redirected to a paged output stream.

frameId

private int frameId

The frame id of the frame to be output.

height

private int height

The total number of rows output during rendering.

Constructor Detail

PageElement

public PageElement(ThinClient term,
                   int frameId)

Construct a page element and initialize its data structures.

Parameters:

term - The client terminal which is redirected to a paged output stream.

frameId - The frame id of the frame to be output.

Method Detail

equals

public boolean equals(java.lang.Object x)

Compares two objects for equality.

Overrides:

equals in class java.lang.Object

Parameters:

x - Object to compare with.

Returns:

true if instances are equal and false otherwise.

hashCode

public int hashCode()

Return a hash code for the instance.

Overrides:

hashCode in class java.lang.Object

Returns:

Hash code for the instance.

height

public int height()

Returns the height of the output as the number of lines that will be generated when render(com.goldencode.p2j.util.Stream) is called.

Specified by:

height in interface RepeatedOutput

Returns:

The height of the generated output in lines.

render

public void render(Stream out)

Generate output and write it to the given stream.

Specified by:

render in interface RepeatedOutput

Parameters:

out - A stream that is opened for output.