li.netcat.print
Interface PrintIterator

All Known Implementing Classes:

WrappedPrintIterator

public interface PrintIterator

The PrintIterator is an object similar to the java Enumeration. It's hasNext() method reports whether there are more Painters available. If this method returns true, it is allowed to call the getNext(...) method, which returns a Painter that is able to paint the next part of the Print.

In general, it's not possible to reuse a PrintIterator. If the PrintIterator is consumed, i.e. the hasNext() method returns false, it's worth nothing any more and it's reference should be released. A new and "full" PrintIterator can be produced by the Print over and over again.

Author:

Arthur Marxer

Method Summary

Painter	getNext(java.awt.Graphics g, int width, int height) Returns a Painter that is capable of painting the next part of the Print.
boolean	hasNext() Reports, whether there is at least one more Painter available.

Method Detail

hasNext

public boolean hasNext()

Reports, whether there is at least one more Painter available. If this method returns false, a call to getNext(...) is illegal.

Returns:

true if there is at least one more Painter available.

getNext

public Painter getNext(java.awt.Graphics g,
                       int width,
                       int height)

Returns a Painter that is capable of painting the next part of the Print. The size of the returned Painter must not be larger than the given size. If the given size is too small to paint anything, this method returns null.

Parameters:

g - The relevant Graphics object.

width - The maximum available width that the Painter might use. This parameter is always > 0.

height - The maximum available height that the Painter might use. This parameter is always > 0.

Returns:

A Painter that is capable of painting the next part of the Print.