com.saic.isd.printscreen
Interface IPrintScreenText

public interface IPrintScreenText

Interface to allow applications to provide greater control over how their information gets printed during a print screen operation.

Currently the library only allows for overriding the text information from the screen.

Field Summary

static int	HTML File type for printing text information to a file with HTML formatting tags.
static int	UNFORMATTED File type for printing text information to a file with no formatting tags.
static int	XML File type for printing text information to a file with XML formatting tags.

Method Summary

boolean	isPrintScreenTextAvailable(int type) Returns true if the object overrides the print type indicated.
java.lang.String	printScreenText(int type) Returns the text to include in a document when printing this object.

Field Detail

UNFORMATTED

public static final int UNFORMATTED

File type for printing text information to a file with no formatting tags.

See Also:

Constant Field Values

HTML

public static final int HTML

File type for printing text information to a file with HTML formatting tags.

See Also:

Constant Field Values

XML

public static final int XML

File type for printing text information to a file with XML formatting tags.

See Also:

Constant Field Values

Method Detail

isPrintScreenTextAvailable

public boolean isPrintScreenTextAvailable(int type)

Returns true if the object overrides the print type indicated. If UNFORMATTED returns true, then TEXT should return true.

Parameters:

type - One of: UNFORMATTED, HTML, XML

Returns:

True if this component will provide overriden text for the indicated type. If false, then a call to

printScreenText

public java.lang.String printScreenText(int type)

Returns the text to include in a document when printing this object.

Parameters:

type - One of: UNFORMATTED, HTML, XML

Returns:

Screen text to print.

Throws:

java.lang.IllegalArgumentException - if the type is not supported.