|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.batik.transcoder.TranscoderSupport
org.apache.batik.transcoder.AbstractTranscoder
org.apache.batik.transcoder.XMLAbstractTranscoder
org.apache.batik.transcoder.SVGAbstractTranscoder
org.apache.batik.transcoder.print.PrintTranscoder
This class is a Transcoder that prints SVG images.
This class works as follows: any-time the transcode method
is invoked, the corresponding input is cached and nothing
else happens.
However, the PrintTranscoder is also a Printable. If used
in a print operation, it will print each of the input
it cached, one input per page.
The PrintTranscoder uses several different hints that
guide its printing:
Nested Class Summary |
Nested classes inherited from class org.apache.batik.transcoder.SVGAbstractTranscoder |
SVGAbstractTranscoder.SVGAbstractTranscoderUserAgent |
Fields inherited from class org.apache.batik.transcoder.SVGAbstractTranscoder |
builder, ctx, curAOI, curTxf, DEFAULT_ALLOWED_SCRIPT_TYPES, DEFAULT_DEFAULT_FONT_FAMILY, height, KEY_ALLOWED_SCRIPT_TYPES, KEY_ALTERNATE_STYLESHEET, KEY_AOI, KEY_CONSTRAIN_SCRIPT_ORIGIN, KEY_DEFAULT_FONT_FAMILY, KEY_EXECUTE_ONLOAD, KEY_HEIGHT, KEY_LANGUAGE, KEY_MAX_HEIGHT, KEY_MAX_WIDTH, KEY_MEDIA, KEY_PIXEL_TO_MM, KEY_PIXEL_UNIT_TO_MILLIMETER, KEY_SNAPSHOT_TIME, KEY_USER_STYLESHEET_URI, KEY_WIDTH, root, userAgent, width |
Fields inherited from class org.apache.batik.transcoder.XMLAbstractTranscoder |
KEY_DOCUMENT_ELEMENT, KEY_DOCUMENT_ELEMENT_NAMESPACE_URI, KEY_DOM_IMPLEMENTATION, KEY_XML_PARSER_CLASSNAME, KEY_XML_PARSER_VALIDATING |
Fields inherited from class org.apache.batik.transcoder.TranscoderSupport |
handler, hints |
Fields inherited from interface java.awt.print.Printable |
NO_SUCH_PAGE, PAGE_EXISTS |
Constructor Summary | |
PrintTranscoder()
Constructs a new transcoder that prints images. |
Method Summary | |
static void |
handleValueError(String property,
String value)
|
static void |
main(String[] args)
|
void |
print()
Convenience method |
int |
print(Graphics _g,
PageFormat pageFormat,
int pageIndex)
Printable implementation |
protected void |
setImageSize(float docWidth,
float docHeight)
Sets document size according to the hints. |
static void |
setTranscoderBooleanHint(Transcoder transcoder,
String property,
TranscodingHints.Key key)
|
static void |
setTranscoderFloatHint(Transcoder transcoder,
String property,
TranscodingHints.Key key)
|
static void |
setTranscoderRectangleHint(Transcoder transcoder,
String property,
TranscodingHints.Key key)
|
static void |
setTranscoderStringHint(Transcoder transcoder,
String property,
TranscodingHints.Key key)
|
protected void |
transcode(Document document,
String uri,
TranscoderOutput output)
Transcodes the specified Document as an image in the specified output. |
void |
transcode(TranscoderInput in,
TranscoderOutput out)
Transcodes the specified XML input in the specified output. |
Methods inherited from class org.apache.batik.transcoder.SVGAbstractTranscoder |
createBridgeContext, createBridgeContext, createBridgeContext, createDocumentFactory, createUserAgent, getCanvasGraphicsNode |
Methods inherited from class org.apache.batik.transcoder.TranscoderSupport |
addTranscodingHint, getErrorHandler, getTranscodingHints, removeTranscodingHint, setErrorHandler, setTranscodingHints, setTranscodingHints |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.batik.transcoder.Transcoder |
addTranscodingHint, getErrorHandler, getTranscodingHints, removeTranscodingHint, setErrorHandler, setTranscodingHints, setTranscodingHints |
Field Detail |
public static final String KEY_AOI_STR
public static final String KEY_HEIGHT_STR
public static final String KEY_LANGUAGE_STR
public static final String KEY_MARGIN_BOTTOM_STR
public static final String KEY_MARGIN_LEFT_STR
public static final String KEY_MARGIN_RIGHT_STR
public static final String KEY_MARGIN_TOP_STR
public static final String KEY_PAGE_HEIGHT_STR
public static final String KEY_PAGE_ORIENTATION_STR
public static final String KEY_PAGE_WIDTH_STR
public static final String KEY_PIXEL_TO_MM_STR
public static final String KEY_SCALE_TO_PAGE_STR
public static final String KEY_SHOW_PAGE_DIALOG_STR
public static final String KEY_SHOW_PRINTER_DIALOG_STR
public static final String KEY_USER_STYLESHEET_URI_STR
public static final String KEY_WIDTH_STR
public static final String KEY_XML_PARSER_CLASSNAME_STR
public static final String VALUE_MEDIA_PRINT
public static final String VALUE_PAGE_ORIENTATION_LANDSCAPE
public static final String VALUE_PAGE_ORIENTATION_PORTRAIT
public static final String VALUE_PAGE_ORIENTATION_REVERSE_LANDSCAPE
public static final TranscodingHints.Key KEY_SHOW_PAGE_DIALOG
Key: |
KEY_SHOW_PAGE_DIALOG |
---|---|
Value: |
Boolean |
Default: |
false |
Required: |
No |
Description: |
Specifies whether or not the transcoder should pop up a dialog box for selecting the page format. |
public static final TranscodingHints.Key KEY_SHOW_PRINTER_DIALOG
Key: |
KEY_SHOW_PAGE_DIALOG |
---|---|
Value: |
Boolean |
Default: |
false |
Required: |
No |
Description: |
Specifies whether or not the transcoder should pop up a dialog box for selecting the printer. If the dialog box is not shown, the transcoder will use the default printer. |
public static final TranscodingHints.Key KEY_PAGE_WIDTH
Key: |
KEY_PAGE_WIDTH |
---|---|
Value: |
Length |
Default: |
None |
Required: |
No |
Description: |
The width of the print page |
public static final TranscodingHints.Key KEY_PAGE_HEIGHT
Key: |
KEY_PAGE_HEIGHT |
---|---|
Value: |
Length |
Default: |
None |
Required: |
No |
Description: |
The height of the print page |
public static final TranscodingHints.Key KEY_MARGIN_TOP
Key: |
KEY_MARGIN_TOP |
---|---|
Value: |
Length |
Default: |
None |
Required: |
No |
Description: |
The print page top margin |
public static final TranscodingHints.Key KEY_MARGIN_RIGHT
Key: |
KEY_MARGIN_RIGHT |
---|---|
Value: |
Length |
Default: |
None |
Required: |
No |
Description: |
The print page right margin |
public static final TranscodingHints.Key KEY_MARGIN_BOTTOM
Key: |
KEY_MARGIN_BOTTOM |
---|---|
Value: |
Length |
Default: |
None |
Required: |
No |
Description: |
The print page bottom margin |
public static final TranscodingHints.Key KEY_MARGIN_LEFT
Key: |
KEY_MARGIN_LEFT |
---|---|
Value: |
Length |
Default: |
None |
Required: |
No |
Description: |
The print page left margin |
public static final TranscodingHints.Key KEY_PAGE_ORIENTATION
Key: |
KEY_PAGE_ORIENTATION |
---|---|
Value: |
String |
Default: |
VALUE_PAGE_ORIENTATION_PORTRAIT |
Required: |
No |
Description: |
The print page's orientation |
public static final TranscodingHints.Key KEY_SCALE_TO_PAGE
Key: |
KEY_SCALE_TO_PAGE |
---|---|
Value: |
Boolean |
Default: |
true |
Required: |
No |
Description: |
Specifies whether or not the SVG images are scaled to fit into the printed page |
public static final String USAGE
Constructor Detail |
public PrintTranscoder()
Method Detail |
public void transcode(TranscoderInput in, TranscoderOutput out)
XMLAbstractTranscoder
transcode
in interface Transcoder
transcode
in class SVGAbstractTranscoder
protected void transcode(Document document, String uri, TranscoderOutput output) throws TranscoderException
transcode
in class SVGAbstractTranscoder
document
- the document to transcodeuri
- the uri of the document or null if anyoutput
- the ouput where to transcode
TranscoderException
- if an error occured while transcodingpublic void print() throws PrinterException
PrinterException
public int print(Graphics _g, PageFormat pageFormat, int pageIndex)
print
in interface Printable
protected void setImageSize(float docWidth, float docHeight)
setImageSize
in class SVGAbstractTranscoder
docWidth
- Width of the document.docHeight
- Height of the document.public static void main(String[] args) throws Exception
Exception
public static void setTranscoderFloatHint(Transcoder transcoder, String property, TranscodingHints.Key key)
public static void setTranscoderRectangleHint(Transcoder transcoder, String property, TranscodingHints.Key key)
public static void setTranscoderBooleanHint(Transcoder transcoder, String property, TranscodingHints.Key key)
public static void setTranscoderStringHint(Transcoder transcoder, String property, TranscodingHints.Key key)
public static void handleValueError(String property, String value)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |