Package org.apache.xmlgraphics.ps
Class PSGenerator
java.lang.Object
org.apache.xmlgraphics.ps.PSGenerator
- All Implemented Interfaces:
PSCommandMap
This class is used to output PostScript code to an OutputStream. This class assumes that
the
PSProcSets.STD_PROCSET
has been added to the PostScript file.- Version:
- $Id$
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Object
Deprecated.Please use DSCConstants.ATEND.static final int
Default postscript language levelstatic final char
Line feed used by PostScript -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Writes a comment to the stream and ends the line.void
concatMatrix
(double[] matrix) Concats the transformations matrix.void
concatMatrix
(double a, double b, double c, double d, double e, double f) Concats the transformation matrix.void
Concats the transformations matric.static final String
convertRealToDSC
(float value) Converts a <real> value for use in DSC comments.static final String
convertStringToDSC
(String text) Converts text by applying escaping rules established in the DSC specs.static final String
convertStringToDSC
(String text, boolean forceParentheses) Converts text by applying escaping rules established in the DSC specs.void
defineRect
(double x, double y, double w, double h) Adds a rectangle to the current path.boolean
Embeds the Identity-H CMap file into the output stream, if that has not already been done.static final void
escapeChar
(char c, StringBuffer target) Escapes a character conforming to the rules established in the PostScript Language Reference (Search for "Literal Text Strings").void
flush()
Flushes the OutputStream.formatDouble
(double value) Formats a double value for PostScript output.formatDouble5
(double value) Formats a double value for PostScript output (higher resolution).Formats a transformation matrix.Formats a Rectangle2D to an array.Returns the current graphics state.Returns the PSResource instance corresponding to the Identity-H CMap resource.Returns the OutputStream the PSGenerator writes to.Returns the PSResource instance corresponding to the CIDInit ProcSet resource.int
Returns the selected PostScript level.Resturns the ResourceTracker instance associated with this PSGenerator.void
Adds a PostScript DSC comment to the output stream requiring the inclusion of the CIDInit ProcSet resource.boolean
boolean
Indicates whether this instance allows to write comments.boolean
Indicates whether this instance is in compact mode.boolean
Deprecated.Use the isResourceSupplied() on ResourceTracker instead.mapCommand
(String command) Maps a standard PostScript command (like "setlinejoin" or "setrgbcolor") to a macro.final void
newLine()
Writes a newline character to the OutputStream.void
notifyResourceUsage
(PSResource res, boolean needed) Deprecated.Use the notifyResourceUsageOnPage() on ResourceTracker insteadvoid
Deprecated.Use the notifyStartNewPage() on ResourceTracker instead.resolveURI
(String uri) Attempts to resolve the given URI.boolean
Restores the last graphics state of the rendering engine.void
Saves the graphics state of the rendering engine.void
setAcrobatDownsample
(boolean b) void
setCommentsEnabled
(boolean value) Controls whether this instance allows to write comments using thecommentln(String)
method.void
setCompactMode
(boolean value) Controls whether this instance shall produce compact PostScript (omitting comments and using short macros).void
setPSLevel
(int level) Sets the PostScript level that is used to generate the current document.void
setResourceTracker
(ResourceTracker resTracker) Sets the ResourceTracker instance to be associated with this PSGenerator.void
showPage()
Issues the "showpage" command and resets the painting state accordingly.void
Establishes the specified color.void
Establishes the specified dash pattern.void
Establishes the specified font and size.void
useLineCap
(int linecap) Establishes the specified line cap style.void
useLineJoin
(int linejoin) Establishes the specified line join style.void
useLineWidth
(double width) Establishes the specified line width.void
useMiterLimit
(float miterlimit) Establishes the specified miter limit.void
useRGBColor
(Color col) Deprecated.use useColor method insteadvoid
write
(int n) Writes the given number to the stream in decimal format.void
Writes a PostScript command to the stream.void
writeByteArr
(byte[] cmd) Writes encoded data to the PostScript stream.void
writeDSCComment
(String name) Writes a DSC comment to the output stream.void
writeDSCComment
(String name, Object param) Writes a DSC comment to the output stream.void
writeDSCComment
(String name, Object[] params) Writes a DSC comment to the output stream.void
Writes a PostScript command to the stream and ends the line.void
writeResources
(boolean pageLevel) Deprecated.Use the writeResources() on ResourceTracker instead.
-
Field Details
-
DEFAULT_LANGUAGE_LEVEL
public static final int DEFAULT_LANGUAGE_LEVELDefault postscript language level- See Also:
-
ATEND
Deprecated.Please use DSCConstants.ATEND. This constant was in the wrong place.Indicator for the PostScript interpreter that the value is provided later in the document (mostly in the %%Trailer section). -
LF
public static final char LFLine feed used by PostScript- See Also:
-
-
Constructor Details
-
PSGenerator
Creates a new instance.- Parameters:
out
- the OutputStream to write the generated PostScript code to
-
-
Method Details
-
isCompactMode
public boolean isCompactMode()Indicates whether this instance is in compact mode. SeesetCompactMode(boolean)
for details.- Returns:
- true if compact mode is enabled (the default)
-
setCompactMode
public void setCompactMode(boolean value) Controls whether this instance shall produce compact PostScript (omitting comments and using short macros). Enabling this mode requires that the standard procset (PSProcSets.STD_PROCSET
) is included in the PostScript file. Setting this to false produces more verbose PostScript suitable for debugging.- Parameters:
value
- true to enable compact mode, false for verbose mode
-
isCommentsEnabled
public boolean isCommentsEnabled()Indicates whether this instance allows to write comments. SeesetCommentsEnabled(boolean)
for details.- Returns:
- true if comments are enabled (the default)
-
setCommentsEnabled
public void setCommentsEnabled(boolean value) Controls whether this instance allows to write comments using thecommentln(String)
method.- Parameters:
value
- true to enable comments, false to disable them
-
getOutputStream
Returns the OutputStream the PSGenerator writes to.- Returns:
- the OutputStream
-
getPSLevel
public int getPSLevel()Returns the selected PostScript level.- Returns:
- the PostScript level
-
setPSLevel
public void setPSLevel(int level) Sets the PostScript level that is used to generate the current document.- Parameters:
level
- the PostScript level (currently 1, 2 and 3 are known)
-
isAcrobatDownsample
public boolean isAcrobatDownsample() -
setAcrobatDownsample
public void setAcrobatDownsample(boolean b) -
resolveURI
Attempts to resolve the given URI. PSGenerator should be subclasses to provide more sophisticated URI resolution.- Parameters:
uri
- URI to access- Returns:
- A
Source
object, or null if the URI cannot be resolved.
-
newLine
Writes a newline character to the OutputStream.- Throws:
IOException
- In case of an I/O problem
-
formatDouble
Formats a double value for PostScript output.- Parameters:
value
- value to format- Returns:
- the formatted value
-
formatDouble5
Formats a double value for PostScript output (higher resolution).- Parameters:
value
- value to format- Returns:
- the formatted value
-
write
Writes a PostScript command to the stream.- Parameters:
cmd
- The PostScript code to be written.- Throws:
IOException
- In case of an I/O problem
-
write
Writes the given number to the stream in decimal format.- Parameters:
n
- a number- Throws:
IOException
- in case of an I/O problem
-
writeln
Writes a PostScript command to the stream and ends the line.- Parameters:
cmd
- The PostScript code to be written.- Throws:
IOException
- In case of an I/O problem
-
commentln
Writes a comment to the stream and ends the line. Output of comments can be disabled to reduce the size of the generated file.- Parameters:
comment
- comment to write- Throws:
IOException
- In case of an I/O problem
-
mapCommand
Maps a standard PostScript command (like "setlinejoin" or "setrgbcolor") to a macro. If no mapping is available, the command itself is returned again.- Specified by:
mapCommand
in interfacePSCommandMap
- Parameters:
command
- the command- Returns:
- the mapped command (or the "command" parameter if no mapping is available)
-
writeByteArr
Writes encoded data to the PostScript stream.- Parameters:
cmd
- The encoded PostScript code to be written.- Throws:
IOException
- In case of an I/O problem
-
flush
Flushes the OutputStream.- Throws:
IOException
- In case of an I/O problem
-
escapeChar
Escapes a character conforming to the rules established in the PostScript Language Reference (Search for "Literal Text Strings").- Parameters:
c
- character to escapetarget
- target StringBuffer to write the escaped character to
-
convertStringToDSC
Converts text by applying escaping rules established in the DSC specs.- Parameters:
text
- Text to convert- Returns:
- String The resulting String
-
convertRealToDSC
Converts a <real> value for use in DSC comments.- Parameters:
value
- the value to convert- Returns:
- String The resulting String
-
convertStringToDSC
Converts text by applying escaping rules established in the DSC specs.- Parameters:
text
- Text to convertforceParentheses
- Force the use of parentheses- Returns:
- String The resulting String
-
writeDSCComment
Writes a DSC comment to the output stream.- Parameters:
name
- Name of the DSC comment- Throws:
IOException
- In case of an I/O problem- See Also:
-
writeDSCComment
Writes a DSC comment to the output stream. The parameter to the DSC comment can be any object. The object is converted to a String as necessary.- Parameters:
name
- Name of the DSC commentparam
- Single parameter to the DSC comment- Throws:
IOException
- In case of an I/O problem- See Also:
-
writeDSCComment
Writes a DSC comment to the output stream. The parameters to the DSC comment can be any object. The objects are converted to Strings as necessary. Please see the source code to find out what parameters are currently supported.- Parameters:
name
- Name of the DSC commentparams
- Array of parameters to the DSC comment- Throws:
IOException
- In case of an I/O problem- See Also:
-
saveGraphicsState
Saves the graphics state of the rendering engine.- Throws:
IOException
- In case of an I/O problem
-
restoreGraphicsState
Restores the last graphics state of the rendering engine.- Returns:
- true if the state was restored, false if there's a stack underflow.
- Throws:
IOException
- In case of an I/O problem
-
getCurrentState
Returns the current graphics state.- Returns:
- the current graphics state
-
showPage
Issues the "showpage" command and resets the painting state accordingly.- Throws:
IOException
- In case of an I/O problem
-
concatMatrix
public void concatMatrix(double a, double b, double c, double d, double e, double f) throws IOException Concats the transformation matrix.- Parameters:
a
- A partb
- B partc
- C partd
- D parte
- E partf
- F part- Throws:
IOException
- In case of an I/O problem
-
concatMatrix
Concats the transformations matrix.- Parameters:
matrix
- Matrix to use- Throws:
IOException
- In case of an I/O problem
-
formatMatrix
Formats a transformation matrix.- Parameters:
at
- the AffineTransform with the matrix- Returns:
- the formatted transformation matrix (example: "[1 0 0 1 0 0]")
-
concatMatrix
Concats the transformations matric.- Parameters:
at
- the AffineTransform whose matrix to use- Throws:
IOException
- In case of an I/O problem
-
formatRectangleToArray
Formats a Rectangle2D to an array.- Parameters:
rect
- the rectangle- Returns:
- the formatted array
-
defineRect
Adds a rectangle to the current path.- Parameters:
x
- upper left cornery
- upper left cornerw
- widthh
- height- Throws:
IOException
- In case of an I/O problem
-
useLineCap
Establishes the specified line cap style.- Parameters:
linecap
- the line cap style (0, 1 or 2) as defined by the setlinecap command.- Throws:
IOException
- In case of an I/O problem
-
useLineJoin
Establishes the specified line join style.- Parameters:
linejoin
- the line join style (0, 1 or 2) as defined by the setlinejoin command.- Throws:
IOException
- In case of an I/O problem
-
useMiterLimit
Establishes the specified miter limit.- Parameters:
miterlimit
- the miter limit as defined by the setmiterlimit command.- Throws:
IOException
- In case of an I/O problem
-
useLineWidth
Establishes the specified line width.- Parameters:
width
- the line width as defined by the setlinewidth command.- Throws:
IOException
- In case of an I/O problem
-
useDash
Establishes the specified dash pattern.- Parameters:
pattern
- the dash pattern as defined by the setdash command.- Throws:
IOException
- In case of an I/O problem
-
useRGBColor
Deprecated.use useColor method insteadEstablishes the specified color (RGB).- Parameters:
col
- the color as defined by the setrgbcolor command.- Throws:
IOException
- In case of an I/O problem
-
useColor
Establishes the specified color.- Parameters:
col
- the color.- Throws:
IOException
- In case of an I/O problem
-
useFont
Establishes the specified font and size.- Parameters:
name
- name of the font for the "F" command (see FOP Std Proc Set)size
- size of the font- Throws:
IOException
- In case of an I/O problem
-
getResourceTracker
Resturns the ResourceTracker instance associated with this PSGenerator.- Returns:
- the ResourceTracker instance or null if none is assigned
-
setResourceTracker
Sets the ResourceTracker instance to be associated with this PSGenerator.- Parameters:
resTracker
- the ResourceTracker instance
-
notifyStartNewPage
Deprecated.Use the notifyStartNewPage() on ResourceTracker instead.Notifies the generator that a new page has been started and that the page resource set can be cleared. -
notifyResourceUsage
Deprecated.Use the notifyResourceUsageOnPage() on ResourceTracker insteadNotifies the generator about the usage of a resource on the current page.- Parameters:
res
- the resource being usedneeded
- true if this is a needed resource, false for a supplied resource
-
writeResources
Deprecated.Use the writeResources() on ResourceTracker instead.Writes a DSC comment for the accumulated used resources, either at page level or at document level.- Parameters:
pageLevel
- true if the DSC comment for the page level should be generated, false for the document level (in the trailer)- Throws:
IOException
- In case of an I/O problem
-
isResourceSupplied
Deprecated.Use the isResourceSupplied() on ResourceTracker instead.Indicates whether a particular resource is supplied, rather than needed.- Parameters:
res
- the resource- Returns:
- true if the resource is registered as being supplied.
-
embedIdentityH
Embeds the Identity-H CMap file into the output stream, if that has not already been done.- Returns:
- true if embedding has actually been performed, false otherwise (which means that a call to this method had already been made earlier)
- Throws:
IOException
- in case of an I/O problem
-
getIdentityHCMapResource
Returns the PSResource instance corresponding to the Identity-H CMap resource.- Returns:
- the Identity-H CMap resource.
-
getProcsetCIDInitResource
Returns the PSResource instance corresponding to the CIDInit ProcSet resource.- Returns:
- the ProcSet CIDInit resource
-
includeProcsetCIDInitResource
Adds a PostScript DSC comment to the output stream requiring the inclusion of the CIDInit ProcSet resource.- Throws:
IOException
- in case of an I/O problem
-