net.wimpi.telnetd.io.toolkit
Class Pager

java.lang.Object
  net.wimpi.telnetd.io.toolkit.Pager

public class Pager
extends java.lang.Object

Class implementing a pager.

Version:

2.0 (16/07/2006);

Author:

Dieter Wimberger

Constructor Summary

Pager(BasicTerminalIO io)
Constructor method

Pager(BasicTerminalIO io, java.lang.String prompt, char stopKey)
Constructor method for a pager with a prompt set and a default stop key.

Method Summary

void	page(java.io.InputStream in) Method that pages text read from an InputStream.
void	page(java.lang.String str) Method that pages the String to the client terminal, being aware of its geometry, and its geometry changes.
void	setPrompt(java.lang.String prompt) Mutator method for the pagers prompt.
void	setShowPosition(boolean b) Method to make the pager add pager postion to the prompt.
void	setStopKey(char key) Mutator method for the pagers stop key.

Methods inherited from class java.lang.Object

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

Constructor Detail

Pager

public Pager(BasicTerminalIO io)

Constructor method

Pager

public Pager(BasicTerminalIO io,
             java.lang.String prompt,
             char stopKey)

Constructor method for a pager with a prompt set and a default stop key.

Parameters:

prompt - String that represents the paging prompt.

stopKey - String that represents the stop key.

Method Detail

setStopKey

public void setStopKey(char key)

Mutator method for the pagers stop key.

Parameters:

key - char that represents the new stop key.

setPrompt

public void setPrompt(java.lang.String prompt)

Mutator method for the pagers prompt.

Parameters:

prompt - String that represents the new promptkey.

setShowPosition

public void setShowPosition(boolean b)

Method to make the pager add pager postion to the prompt.

page

public void page(java.lang.String str)
          throws java.io.IOException

Method that pages the String to the client terminal, being aware of its geometry, and its geometry changes.

Parameters:

str - String to be paged.

Throws:

java.io.IOException

page

public void page(java.io.InputStream in)
          throws java.io.IOException

Method that pages text read from an InputStream.

Parameters:

in - InputStream representing a source for paging.

Throws:

java.io.IOException