no.g9.service.print

Class PrintContext

java.lang.Object

no.g9.service.print.PrintContext

All Implemented Interfaces:

Serializable

public class PrintContext
extends Object
implements Serializable

The PrintContext is a carrier of data and parameters, used by implementations of the PrintService.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PrintContext() Construct a new Print context
PrintContext(String dialogName, Document document) Create a PrintContext based on a Document.
PrintContext(String dialogName, Document document, Map<String,Object> params) Create a PrintContext based on a Document.
PrintContext(String dialogName, Document document, String printerName) Create a PrintContext based on a Document.
PrintContext(String dialogName, Document document, String printerName, Map<String,Object> params) Create a PrintContext based on a Document.
PrintContext(String dialogName, String xml, String printerName) Create a PrintContext based on an XML string.
PrintContext(String dialogName, URI file) Create a PrintContext based on a file given as an URI.
PrintContext(String dialogName, URI file, Map<String,Object> params) Create a PrintContext based on a file given as an URI.
PrintContext(String dialogName, URI file, String printerName) Create a PrintContext based on a file given as an URI.
PrintContext(String dialogName, URI file, String printerName, Map<String,Object> params) Create a PrintContext based on a file given as an URI.

Method Summary

Modifier and Type	Method and Description
String	getDialogName()
Document	getDocument()
URI	getFile()
Map<String,Object>	getParams()
String	getPrinterName()
String	getXml()
boolean	isValid() Check whether this PrintContext is valid for printing.
void	setDialogName(String dialogName)
void	setDocument(Document document)
void	setFile(URI file)
void	setParams(Map<String,Object> params)
void	setPrinterName(String printerName)
void	setXml(String xml)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintContext

public PrintContext()

Construct a new Print context

PrintContext

public PrintContext(String dialogName,
                    Document document)

Create a PrintContext based on a Document.

Parameters:

dialogName - The name of the print dialog (print template)

document - Data to be printed formed in a Document

PrintContext

public PrintContext(String dialogName,
                    Document document,
                    String printerName)

Create a PrintContext based on a Document. The given printer name will be used for printing.

Parameters:

dialogName - The name of the print dialog (print template)

document - Data to be printed formed in a Document

printerName - The name of the printer to be used

PrintContext

public PrintContext(String dialogName,
                    URI file)

Create a PrintContext based on a file given as an URI.

Parameters:

dialogName - The name of the print dialog (print template)

file - Data to be printed formed in a file (XML file)

PrintContext

public PrintContext(String dialogName,
                    URI file,
                    String printerName)

Create a PrintContext based on a file given as an URI.

Parameters:

dialogName - The name of the print dialog (print template)

file - Data to be printed formed in a file (XML file)

printerName - The name of the printer to be used

PrintContext

public PrintContext(String dialogName,
                    Document document,
                    Map<String,Object> params)

Create a PrintContext based on a Document. The given printer name will be used for printing.

Parameters:

dialogName - The name of the print dialog (print template)

document - Data to be printed formed in a Document

params - Additional print parameters

PrintContext

public PrintContext(String dialogName,
                    Document document,
                    String printerName,
                    Map<String,Object> params)

Create a PrintContext based on a Document. The given printer name will be used for printing.

Parameters:

dialogName - The name of the print dialog (print template)

document - Data to be printed formed in a Document

printerName - The name of the printer to be used

params - Additional print parameters

PrintContext

public PrintContext(String dialogName,
                    URI file,
                    Map<String,Object> params)

Create a PrintContext based on a file given as an URI.

Parameters:

dialogName - The name of the print dialog (print template)

file - Data to be printed formed in a file (XML file)

params - Additional print parameters

PrintContext

public PrintContext(String dialogName,
                    URI file,
                    String printerName,
                    Map<String,Object> params)

Create a PrintContext based on a file given as an URI.

Parameters:

dialogName - The name of the print dialog (print template)

file - Data to be printed formed in a file (XML file)

printerName - The name of the printer to be used

params - Additional print parameters

PrintContext

public PrintContext(String dialogName,
                    String xml,
                    String printerName)

Create a PrintContext based on an XML string.

Parameters:

dialogName - The name of the print dialog (print template)

xml - Data to be printed formed in an XML string

printerName - The name of the printer to be used

Method Detail

isValid

public boolean isValid()

Check whether this PrintContext is valid for printing.

Returns:

true if valid

toString

public String toString()

Overrides:

toString in class Object

getDialogName

public String getDialogName()

Returns:

(missing javadoc)

setDialogName

public void setDialogName(String dialogName)

Parameters:

dialogName - (missing javadoc)

getFile

public URI getFile()

Returns:

(missing javadoc)

setFile

public void setFile(URI file)

Parameters:

file - (missing javadoc)

getDocument

public Document getDocument()

Returns:

(missing javadoc)

setDocument

public void setDocument(Document document)

Parameters:

document - (missing javadoc)

getXml

public String getXml()

Returns:

(missing javadoc)

setXml

public void setXml(String xml)

Parameters:

xml - (missing javadoc)

getPrinterName

public String getPrinterName()

Returns:

(missing javadoc)

setPrinterName

public void setPrinterName(String printerName)

Parameters:

printerName - (missing javadoc)

getParams

public Map<String,Object> getParams()

Returns:

(missing javadoc)

setParams

public void setParams(Map<String,Object> params)

Parameters:

params - (missing javadoc)