ice.storm.print.jdk12
Class PageableDocument

java.lang.Object
  extended byice.storm.print.jdk12.PageableDocument

public class PageableDocument
extends Object

The pageable document class allows StormPrinter to be easily printed using Java 2 Pageable interface.

Since:
6.0
Version:
%I%, %G%
Author:
Patrick Corless

Constructor Summary
PageableDocument(StormPrinter stormPrinter)
          Create a new PageableDocument for the specified stormPrinter.
 
Method Summary
 String getDocumentName()
          Gets the document name used for the print job.
 boolean print()
          Print all of the pages in the print job.
 boolean print(int startPage, int endPage)
          Print all of the pages in specified print range.
 void setDocumentName(String parName)
          Sets the document name used for the print job.
 void setPageDialogVisible(boolean isPageDialogVisible)
          Sets the page dialog windows as visible when the print job is started.
 void setPrintDialogVisible(boolean isPrintDialogVisible)
          Sets the print dialog visibility when the print method is called.
 void setStormPrinter(StormPrinter stormPrinter)
          Sets the StormPrinter for this PageableDocument.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageableDocument

public PageableDocument(StormPrinter stormPrinter)
Create a new PageableDocument for the specified stormPrinter.

Parameters:
stormPrinter - a pilot printer to be printed.
See Also:
StormPrinter
Method Detail

setStormPrinter

public void setStormPrinter(StormPrinter stormPrinter)
Sets the StormPrinter for this PageableDocument.

Parameters:
stormPrinter - the PageableDocument object to which to set the PageableDocument object for this PageableDocument.

setPrintDialogVisible

public void setPrintDialogVisible(boolean isPrintDialogVisible)
Sets the print dialog visibility when the print method is called. The default behavior is not to display the dialog when the print method is called.

Parameters:
isPrintDialogVisible -

setPageDialogVisible

public void setPageDialogVisible(boolean isPageDialogVisible)
Sets the page dialog windows as visible when the print job is started.

Parameters:
isPageDialogVisible - true to display the dialog, false otherwise

getDocumentName

public String getDocumentName()
Gets the document name used for the print job.

Returns:
print job name
See Also:
getDocumentName()

setDocumentName

public void setDocumentName(String parName)
Sets the document name used for the print job.

Parameters:
parName - print job name
See Also:
setDocumentName(java.lang.String)

print

public boolean print()
Print all of the pages in the print job.

Returns:
true if the user does not cancel the print dialog; false otherwise

print

public boolean print(int startPage,
                     int endPage)
Print all of the pages in specified print range.

Parameters:
startPage - start page for print job range
endPage - end page for print job range
Returns:
true if the user does not cancel the print dialog; false otherwise