Package org.apache.batik.ext.awt.g2d
Class GraphicContext
- java.lang.Object
-
- org.apache.batik.ext.awt.g2d.GraphicContext
-
- All Implemented Interfaces:
java.lang.Cloneable
public class GraphicContext extends java.lang.Object implements java.lang.CloneableHandles the attributes in a graphic context:
+ Composite
+ Font
+ Paint
+ Stroke
+ Clip
+ RenderingHints
+ AffineTransform- Version:
- $Id: GraphicContext.java 1733416 2016-03-03 07:07:13Z gadams $
-
-
Field Summary
Fields Modifier and Type Field Description protected java.awt.ColorbackgroundCurrent background color.protected java.awt.ShapeclipCurrent clipprotected java.awt.CompositecompositeCurrent Compositeprotected java.awt.geom.AffineTransformdefaultTransformDefault Transform to be used for creating FontRenderContext.protected java.awt.FontfontCurrent Fontprotected java.awt.ColorforegroundCurrent foreground colorprotected java.awt.RenderingHintshintsCurrent set of RenderingHintsprotected java.awt.PaintpaintCurrent Paintprotected java.awt.StrokestrokeCurrent Strokeprotected java.awt.geom.AffineTransformtransformCurrent AffineTransform.protected java.util.ListtransformStackTransform stackprotected booleantransformStackValidDefines whether the transform stack is valide or not.
-
Constructor Summary
Constructors Constructor Description GraphicContext()Default constructorGraphicContext(java.awt.geom.AffineTransform defaultDeviceTransform)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddRenderingHints(java.util.Map hints)Sets the values of an arbitrary number of preferences for the rendering algorithms.voidclip(java.awt.Shape s)Intersects the currentClipwith the interior of the specifiedShapeand sets theClipto the resulting intersection.voidclipRect(int x, int y, int width, int height)Intersects the current clip with the specified rectangle.java.lang.Objectclone()java.awt.ColorgetBackground()Returns the background color used for clearing a region.java.awt.ShapegetClip()Gets the current clipping area.java.awt.RectanglegetClipBounds()Returns the bounding rectangle of the current clipping area.java.awt.ColorgetColor()Gets this graphics context's current color.java.awt.CompositegetComposite()Returns the currentCompositein theGraphics2Dcontext.java.awt.FontgetFont()Gets the current font.java.awt.font.FontRenderContextgetFontRenderContext()Get the rendering context of theFontwithin thisGraphics2Dcontext.java.awt.PaintgetPaint()Returns the currentPaintof theGraphics2Dcontext.java.lang.ObjectgetRenderingHint(java.awt.RenderingHints.Key hintKey)Returns the value of a single preference for the rendering algorithms.java.awt.RenderingHintsgetRenderingHints()Gets the preferences for the rendering algorithms.java.awt.StrokegetStroke()Returns the currentStrokein theGraphics2Dcontext.java.awt.geom.AffineTransformgetTransform()Returns a copy of the currentTransformin theGraphics2Dcontext.TransformStackElement[]getTransformStack()protected voidinvalidateTransformStack()Marks the GraphicContext's isNewTransformStack to true as a memento that the current transform stack was reset since it was last read.booleanisTransformStackValid()Checks the status of the transform stackvoidrotate(double theta)Concatenates the currentGraphics2DTransformwith a rotation transform.voidrotate(double theta, double x, double y)Concatenates the currentGraphics2DTransformwith a translated rotation transform.voidscale(double sx, double sy)Concatenates the currentGraphics2DTransformwith a scaling transformation Subsequent rendering is resized according to the specified scaling factors relative to the previous scaling.voidsetBackground(java.awt.Color color)Sets the background color for theGraphics2Dcontext.voidsetClip(int x, int y, int width, int height)Sets the current clip to the rectangle specified by the given coordinates.voidsetClip(java.awt.Shape clip)Sets the current clipping area to an arbitrary clip shape.voidsetColor(java.awt.Color c)Sets this graphics context's current color to the specified color.voidsetComposite(java.awt.Composite comp)Sets theCompositefor theGraphics2Dcontext.voidsetFont(java.awt.Font font)Sets this graphics context's font to the specified font.voidsetPaint(java.awt.Paint paint)Sets thePaintattribute for theGraphics2Dcontext.voidsetRenderingHint(java.awt.RenderingHints.Key hintKey, java.lang.Object hintValue)Sets the value of a single preference for the rendering algorithms.voidsetRenderingHints(java.util.Map hints)Replaces the values of all preferences for the rendering algorithms with the specifiedhints.voidsetStroke(java.awt.Stroke s)Sets theStrokefor theGraphics2Dcontext.voidsetTransform(java.awt.geom.AffineTransform Tx)Sets theTransformin theGraphics2Dcontext.voidshear(double shx, double shy)Concatenates the currentGraphics2DTransformwith a shearing transform.voidtransform(java.awt.geom.AffineTransform Tx)Composes anAffineTransformobject with theTransformin thisGraphics2Daccording to the rule last-specified-first-applied.voidtranslate(double tx, double ty)Concatenates the currentGraphics2DTransformwith a translation transform.voidtranslate(int x, int y)Translates the origin of the graphics context to the point (x, y) in the current coordinate system.voidvalidateTransformStack()Marks the GraphicContext's isNewTransformStack to false as a memento that the current transform stack was read and has not been reset.
-
-
-
Field Detail
-
defaultTransform
protected java.awt.geom.AffineTransform defaultTransform
Default Transform to be used for creating FontRenderContext.
-
transform
protected java.awt.geom.AffineTransform transform
Current AffineTransform. This is the concatenation of the original AffineTransform (i.e., last setTransform invocation) and the following transform invocations, as captured by originalTransform and the transformStack.
-
transformStack
protected java.util.List transformStack
Transform stack
-
transformStackValid
protected boolean transformStackValid
Defines whether the transform stack is valide or not. This is for use by the class clients. The client should validate the stack every time it starts using it. The stack becomes invalid when a new transform is set.
-
paint
protected java.awt.Paint paint
Current Paint
-
stroke
protected java.awt.Stroke stroke
Current Stroke
-
composite
protected java.awt.Composite composite
Current Composite
-
clip
protected java.awt.Shape clip
Current clip
-
hints
protected java.awt.RenderingHints hints
Current set of RenderingHints
-
font
protected java.awt.Font font
Current Font
-
background
protected java.awt.Color background
Current background color.
-
foreground
protected java.awt.Color foreground
Current foreground color
-
-
Method Detail
-
clone
public java.lang.Object clone()
- Overrides:
clonein classjava.lang.Object- Returns:
- a deep copy of this context
-
getColor
public java.awt.Color getColor()
Gets this graphics context's current color.- Returns:
- this graphics context's current color.
- See Also:
Color,Graphics.setColor(java.awt.Color)
-
setColor
public void setColor(java.awt.Color c)
Sets this graphics context's current color to the specified color. All subsequent graphics operations using this graphics context use this specified color.- Parameters:
c- the new rendering color.- See Also:
Color,Graphics.getColor()
-
getFont
public java.awt.Font getFont()
Gets the current font.- Returns:
- this graphics context's current font.
- See Also:
Font,Graphics.setFont(java.awt.Font)
-
setFont
public void setFont(java.awt.Font font)
Sets this graphics context's font to the specified font. All subsequent text operations using this graphics context use this font.- Parameters:
font- the font.- See Also:
Graphics.getFont()
-
getClipBounds
public java.awt.Rectangle getClipBounds()
Returns the bounding rectangle of the current clipping area. This method refers to the user clip, which is independent of the clipping associated with device bounds and window visibility. If no clip has previously been set, or if the clip has been cleared usingsetClip(null), this method returnsnull. The coordinates in the rectangle are relative to the coordinate system origin of this graphics context.- Returns:
- the bounding rectangle of the current clipping area,
or
nullif no clip is set. - Since:
- JDK1.1
- See Also:
Graphics.getClip(),Graphics.clipRect(int, int, int, int),Graphics.setClip(int, int, int, int),Graphics.setClip(Shape)
-
clipRect
public void clipRect(int x, int y, int width, int height)Intersects the current clip with the specified rectangle. The resulting clipping area is the intersection of the current clipping area and the specified rectangle. If there is no current clipping area, either because the clip has never been set, or the clip has been cleared usingsetClip(null), the specified rectangle becomes the new clip. This method sets the user clip, which is independent of the clipping associated with device bounds and window visibility. This method can only be used to make the current clip smaller. To set the current clip larger, use any of the setClip methods. Rendering operations have no effect outside of the clipping area.- Parameters:
x- the x coordinate of the rectangle to intersect the clip withy- the y coordinate of the rectangle to intersect the clip withwidth- the width of the rectangle to intersect the clip withheight- the height of the rectangle to intersect the clip with- See Also:
setClip(int, int, int, int),setClip(Shape)
-
setClip
public void setClip(int x, int y, int width, int height)Sets the current clip to the rectangle specified by the given coordinates. This method sets the user clip, which is independent of the clipping associated with device bounds and window visibility. Rendering operations have no effect outside of the clipping area.- Parameters:
x- the x coordinate of the new clip rectangle.y- the y coordinate of the new clip rectangle.width- the width of the new clip rectangle.height- the height of the new clip rectangle.- Since:
- JDK1.1
- See Also:
Graphics.clipRect(int, int, int, int),Graphics.setClip(Shape)
-
getClip
public java.awt.Shape getClip()
Gets the current clipping area. This method returns the user clip, which is independent of the clipping associated with device bounds and window visibility. If no clip has previously been set, or if the clip has been cleared usingsetClip(null), this method returnsnull.- Returns:
- a
Shapeobject representing the current clipping area, ornullif no clip is set. - Since:
- JDK1.1
- See Also:
Graphics.getClipBounds(),Graphics.clipRect(int, int, int, int),Graphics.setClip(int, int, int, int),Graphics.setClip(Shape)
-
setClip
public void setClip(java.awt.Shape clip)
Sets the current clipping area to an arbitrary clip shape. Not all objects that implement theShapeinterface can be used to set the clip. The onlyShapeobjects that are guaranteed to be supported areShapeobjects that are obtained via thegetClipmethod and viaRectangleobjects. This method sets the user clip, which is independent of the clipping associated with device bounds and window visibility.- Parameters:
clip- theShapeto use to set the clip- Since:
- JDK1.1
- See Also:
Graphics.getClip(),Graphics.clipRect(int, int, int, int),Graphics.setClip(int, int, int, int)
-
setComposite
public void setComposite(java.awt.Composite comp)
Sets theCompositefor theGraphics2Dcontext. TheCompositeis used in all drawing methods such asdrawImage,drawString,draw, andfill. It specifies how new pixels are to be combined with the existing pixels on the graphics device during the rendering process.If this
Graphics2Dcontext is drawing to aComponenton the display screen and theCompositeis a custom object rather than an instance of theAlphaCompositeclass, and if there is a security manager, itscheckPermissionmethod is called with anAWTPermission("readDisplayPixels")permission.- Parameters:
comp- theCompositeobject to be used for rendering- Throws:
java.lang.SecurityException- if a customCompositeobject is being used to render to the screen and a security manager is set and itscheckPermissionmethod does not allow the operation.- See Also:
Graphics.setXORMode(java.awt.Color),Graphics.setPaintMode(),AlphaComposite
-
setPaint
public void setPaint(java.awt.Paint paint)
Sets thePaintattribute for theGraphics2Dcontext. Calling this method with anullPaintobject does not have any effect on the currentPaintattribute of thisGraphics2D.- Parameters:
paint- thePaintobject to be used to generate color during the rendering process, ornull- See Also:
Graphics.setColor(java.awt.Color),GradientPaint,TexturePaint
-
setStroke
public void setStroke(java.awt.Stroke s)
Sets theStrokefor theGraphics2Dcontext.- Parameters:
s- theStrokeobject to be used to stroke aShapeduring the rendering process- See Also:
BasicStroke
-
setRenderingHint
public void setRenderingHint(java.awt.RenderingHints.Key hintKey, java.lang.Object hintValue)Sets the value of a single preference for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to theRenderingHintsclass for definitions of some common keys and values.- Parameters:
hintKey- the key of the hint to be set.hintValue- the value indicating preferences for the specified hint category.- See Also:
RenderingHints
-
getRenderingHint
public java.lang.Object getRenderingHint(java.awt.RenderingHints.Key hintKey)
Returns the value of a single preference for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to theRenderingHintsclass for definitions of some common keys and values.- Parameters:
hintKey- the key corresponding to the hint to get.- Returns:
- an object representing the value for the specified hint key.
Some of the keys and their associated values are defined in the
RenderingHintsclass. - See Also:
RenderingHints
-
setRenderingHints
public void setRenderingHints(java.util.Map hints)
Replaces the values of all preferences for the rendering algorithms with the specifiedhints. The existing values for all rendering hints are discarded and the new set of known hints and values are initialized from the specifiedMapobject. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to theRenderingHintsclass for definitions of some common keys and values.- Parameters:
hints- the rendering hints to be set- See Also:
RenderingHints
-
addRenderingHints
public void addRenderingHints(java.util.Map hints)
Sets the values of an arbitrary number of preferences for the rendering algorithms. Only values for the rendering hints that are present in the specifiedMapobject are modified. All other preferences not present in the specified object are left unmodified. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to theRenderingHintsclass for definitions of some common keys and values.- Parameters:
hints- the rendering hints to be set- See Also:
RenderingHints
-
getRenderingHints
public java.awt.RenderingHints getRenderingHints()
Gets the preferences for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Returns all of the hint key/value pairs that were ever specified in one operation. Refer to theRenderingHintsclass for definitions of some common keys and values.- Returns:
- a reference to an instance of
RenderingHintsthat contains the current preferences. - See Also:
RenderingHints
-
translate
public void translate(int x, int y)Translates the origin of the graphics context to the point (x, y) in the current coordinate system. Modifies this graphics context so that its new origin corresponds to the point (x, y) in this graphics context's original coordinate system. All coordinates used in subsequent rendering operations on this graphics context will be relative to this new origin.- Parameters:
x- the x coordinate.y- the y coordinate.
-
translate
public void translate(double tx, double ty)Concatenates the currentGraphics2DTransformwith a translation transform. Subsequent rendering is translated by the specified distance relative to the previous position. This is equivalent to calling transform(T), where T is anAffineTransformrepresented by the following matrix:[ 1 0 tx ] [ 0 1 ty ] [ 0 0 1 ]- Parameters:
tx- the distance to translate along the x-axisty- the distance to translate along the y-axis
-
rotate
public void rotate(double theta)
Concatenates the currentGraphics2DTransformwith a rotation transform. Subsequent rendering is rotated by the specified radians relative to the previous origin. This is equivalent to callingtransform(R), where R is anAffineTransformrepresented by the following matrix:[ cos(theta) -sin(theta) 0 ] [ sin(theta) cos(theta) 0 ] [ 0 0 1 ]Rotating with a positive angle theta rotates points on the positive x axis toward the positive y axis.- Parameters:
theta- the angle of rotation in radians
-
rotate
public void rotate(double theta, double x, double y)Concatenates the currentGraphics2DTransformwith a translated rotation transform. Subsequent rendering is transformed by a transform which is constructed by translating to the specified location, rotating by the specified radians, and translating back by the same amount as the original translation. This is equivalent to the following sequence of calls:translate(x, y); rotate(theta); translate(-x, -y);Rotating with a positive angle theta rotates points on the positive x axis toward the positive y axis.- Parameters:
theta- the angle of rotation in radiansx- x coordinate of the origin of the rotationy- y coordinate of the origin of the rotation
-
scale
public void scale(double sx, double sy)Concatenates the currentGraphics2DTransformwith a scaling transformation Subsequent rendering is resized according to the specified scaling factors relative to the previous scaling. This is equivalent to callingtransform(S), where S is anAffineTransformrepresented by the following matrix:[ sx 0 0 ] [ 0 sy 0 ] [ 0 0 1 ]- Parameters:
sx- the amount by which X coordinates in subsequent rendering operations are multiplied relative to previous rendering operations.sy- the amount by which Y coordinates in subsequent rendering operations are multiplied relative to previous rendering operations.
-
shear
public void shear(double shx, double shy)Concatenates the currentGraphics2DTransformwith a shearing transform. Subsequent renderings are sheared by the specified multiplier relative to the previous position. This is equivalent to callingtransform(SH), where SH is anAffineTransformrepresented by the following matrix:[ 1 shx 0 ] [ shy 1 0 ] [ 0 0 1 ]- Parameters:
shx- the multiplier by which coordinates are shifted in the positive X axis direction as a function of their Y coordinateshy- the multiplier by which coordinates are shifted in the positive Y axis direction as a function of their X coordinate
-
transform
public void transform(java.awt.geom.AffineTransform Tx)
Composes anAffineTransformobject with theTransformin thisGraphics2Daccording to the rule last-specified-first-applied. If the currentTransformis Cx, the result of composition with Tx is a newTransformCx'. Cx' becomes the currentTransformfor thisGraphics2D. Transforming a point p by the updatedTransformCx' is equivalent to first transforming p by Tx and then transforming the result by the originalTransformCx. In other words, Cx'(p) = Cx(Tx(p)). A copy of the Tx is made, if necessary, so further modifications to Tx do not affect rendering.- Parameters:
Tx- theAffineTransformobject to be composed with the currentTransform- See Also:
setTransform(java.awt.geom.AffineTransform),AffineTransform
-
setTransform
public void setTransform(java.awt.geom.AffineTransform Tx)
Sets theTransformin theGraphics2Dcontext.- Parameters:
Tx- theAffineTransformobject to be used in the rendering process- See Also:
transform,AffineTransform
-
validateTransformStack
public void validateTransformStack()
Marks the GraphicContext's isNewTransformStack to false as a memento that the current transform stack was read and has not been reset. Only the setTransform method can override this memento.
-
isTransformStackValid
public boolean isTransformStackValid()
Checks the status of the transform stack
-
getTransformStack
public TransformStackElement[] getTransformStack()
- Returns:
- array containing the successive transforms that were concatenated with the original one.
-
invalidateTransformStack
protected void invalidateTransformStack()
Marks the GraphicContext's isNewTransformStack to true as a memento that the current transform stack was reset since it was last read. Only validateTransformStack can override this memento
-
getTransform
public java.awt.geom.AffineTransform getTransform()
Returns a copy of the currentTransformin theGraphics2Dcontext.- Returns:
- the current
AffineTransformin theGraphics2Dcontext. - See Also:
transform,setTransform(java.awt.geom.AffineTransform)
-
getPaint
public java.awt.Paint getPaint()
Returns the currentPaintof theGraphics2Dcontext.- Returns:
- the current
Graphics2DPaint, which defines a color or pattern. - See Also:
setPaint(java.awt.Paint),Graphics.setColor(java.awt.Color)
-
getComposite
public java.awt.Composite getComposite()
Returns the currentCompositein theGraphics2Dcontext.- Returns:
- the current
Graphics2DComposite, which defines a compositing style. - See Also:
setComposite(java.awt.Composite)
-
setBackground
public void setBackground(java.awt.Color color)
Sets the background color for theGraphics2Dcontext. The background color is used for clearing a region. When aGraphics2Dis constructed for aComponent, the background color is inherited from theComponent. Setting the background color in theGraphics2Dcontext only affects the subsequentclearRectcalls and not the background color of theComponent. To change the background of theComponent, use appropriate methods of theComponent.- Parameters:
color- the background color that isused in subsequent calls toclearRect- See Also:
getBackground(),Graphics.clearRect(int, int, int, int)
-
getBackground
public java.awt.Color getBackground()
Returns the background color used for clearing a region.- Returns:
- the current
Graphics2DColor, which defines the background color. - See Also:
setBackground(java.awt.Color)
-
getStroke
public java.awt.Stroke getStroke()
Returns the currentStrokein theGraphics2Dcontext.- Returns:
- the current
Graphics2DStroke, which defines the line style. - See Also:
setStroke(java.awt.Stroke)
-
clip
public void clip(java.awt.Shape s)
Intersects the currentClipwith the interior of the specifiedShapeand sets theClipto the resulting intersection. The specifiedShapeis transformed with the currentGraphics2DTransformbefore being intersected with the currentClip. This method is used to make the currentClipsmaller. To make theCliplarger, usesetClip. The user clip modified by this method is independent of the clipping associated with device bounds and visibility. If no clip has previously been set, or if the clip has been cleared usingsetClipwith anullargument, the specifiedShapebecomes the new user clip.- Parameters:
s- theShapeto be intersected with the currentClip. Ifsisnull, this method clears the currentClip.
-
getFontRenderContext
public java.awt.font.FontRenderContext getFontRenderContext()
Get the rendering context of theFontwithin thisGraphics2Dcontext. TheFontRenderContextencapsulates application hints such as anti-aliasing and fractional metrics, as well as target device specific information such as dots-per-inch. This information should be provided by the application when using objects that perform typographical formatting, such asFontandTextLayout. This information should also be provided by applications that perform their own layout and need accurate measurements of various characteristics of glyphs such as advance and line height when various rendering hints have been applied to the text rendering.- Returns:
- a reference to an instance of FontRenderContext.
- Since:
- JDK1.2
- See Also:
FontRenderContext,Font.createGlyphVector(FontRenderContext,char[]),TextLayout
-
-