org.apache.batik.bridge

Class PaintServer

public abstract class PaintServer extends Object implements SVGConstants, CSSConstants, ErrorConstants

A collection of utility methods to deliver java.awt.Paint, java.awt.Stroke objects that could be used to paint a shape. This class also provides additional methods the deliver SVG Paint using the ShapePainter interface.
Constructor Summary
protected PaintServer()
No instance of this class is required.
Method Summary
static ColorconvertColor(Value c, float opacity)
Converts the given Value and opacity to a Color object.
static ShapePainterconvertFillAndStroke(Element e, ShapeNode node, BridgeContext ctx)
Returns a ShapePainter defined on the specified element and for the specified shape node, and using the specified bridge context.
static PaintconvertFillPaint(Element filledElement, GraphicsNode filledNode, BridgeContext ctx)
Converts for the specified element, its fill paint properties to a Paint object.
static ColorconvertICCColor(Element e, ICCColor c, float opacity, BridgeContext ctx)
Returns a Color object that corresponds to the input Paint's ICC color value or null if the related color profile could not be used or loaded for any reason.
static MarkerconvertMarker(Element e, Value v, BridgeContext ctx)
Returns a Marker defined on the specified element by the specified value, and for the specified shape node.
static ShapePainterconvertMarkers(Element e, ShapeNode node, BridgeContext ctx)
Returns a ShapePainter defined on the specified element and for the specified shape node.
static floatconvertOpacity(Value v)
Returns the opacity represented by the specified CSSValue.
static PaintconvertPaint(Element paintedElement, GraphicsNode paintedNode, Value paintDef, float opacity, BridgeContext ctx)
Converts a Paint definition to a concrete java.awt.Paint instance according to the specified parameters.
static ColorconvertRGBICCColor(Element paintedElement, Value colorDef, ICCColor iccColor, float opacity, BridgeContext ctx)
Returns a Color object that corresponds to the input Paint's ICC color value or an RGB color if the related color profile could not be used or loaded for any reason.
static StrokeconvertStroke(Element e)
Converts a Stroke object defined on the specified element.
static float[]convertStrokeDasharray(Value v)
Converts the 'stroke-dasharray' property to a list of float number in user units.
static intconvertStrokeLinecap(Value v)
Converts the 'linecap' property to the appropriate BasicStroke constant.
static intconvertStrokeLinejoin(Value v)
Converts the 'linejoin' property to the appropriate BasicStroke constant.
static floatconvertStrokeMiterlimit(Value v)
Converts the 'miterlimit' property to the appropriate float number.
static PaintconvertStrokePaint(Element strokedElement, GraphicsNode strokedNode, BridgeContext ctx)
Converts for the specified element, its stroke paint properties to a Paint object.
static ShapePainterconvertStrokePainter(Element e, ShapeNode node, BridgeContext ctx)
static PaintconvertURIPaint(Element paintedElement, GraphicsNode paintedNode, Value paintDef, float opacity, BridgeContext ctx)
Converts a Paint specified as a URI.
static intresolveColorComponent(Value v)
Returns the value of one color component (0 <= result <= 255).
static PaintsilentConvertURIPaint(Element paintedElement, GraphicsNode paintedNode, Value paintDef, float opacity, BridgeContext ctx)
Converts a Paint specified by URI without sending any error. if a problem occured while processing the URI, it just returns null (same effect as 'none')

Constructor Detail

PaintServer

protected PaintServer()
No instance of this class is required.

Method Detail

convertColor

public static Color convertColor(Value c, float opacity)
Converts the given Value and opacity to a Color object.

Parameters: c The CSS color to convert. opacity The opacity value (0 <= o <= 1).

convertFillAndStroke

public static ShapePainter convertFillAndStroke(Element e, ShapeNode node, BridgeContext ctx)
Returns a ShapePainter defined on the specified element and for the specified shape node, and using the specified bridge context.

Parameters: e the element interested in a shape painter node the shape node ctx the bridge context

convertFillPaint

public static Paint convertFillPaint(Element filledElement, GraphicsNode filledNode, BridgeContext ctx)
Converts for the specified element, its fill paint properties to a Paint object.

Parameters: filledElement the element interested in a Paint filledNode the graphics node to fill ctx the bridge context

convertICCColor

public static Color convertICCColor(Element e, ICCColor c, float opacity, BridgeContext ctx)
Returns a Color object that corresponds to the input Paint's ICC color value or null if the related color profile could not be used or loaded for any reason.

Parameters: e the element using the color c the ICC color definition opacity the opacity ctx the bridge context to use

convertMarker

public static Marker convertMarker(Element e, Value v, BridgeContext ctx)
Returns a Marker defined on the specified element by the specified value, and for the specified shape node.

Parameters: e the painted element v the CSS value describing the marker to construct ctx the bridge context

convertMarkers

public static ShapePainter convertMarkers(Element e, ShapeNode node, BridgeContext ctx)
Returns a ShapePainter defined on the specified element and for the specified shape node.

Parameters: e the element with the marker CSS properties node the shape node ctx the bridge context

convertOpacity

public static float convertOpacity(Value v)
Returns the opacity represented by the specified CSSValue.

Parameters: v the value that represents the opacity

Returns: the opacity between 0 and 1

convertPaint

public static Paint convertPaint(Element paintedElement, GraphicsNode paintedNode, Value paintDef, float opacity, BridgeContext ctx)
Converts a Paint definition to a concrete java.awt.Paint instance according to the specified parameters.

Parameters: paintedElement the element interested in a Paint paintedNode the graphics node to paint (objectBoundingBox) paintDef the paint definition opacity the opacity to consider for the Paint ctx the bridge context

convertRGBICCColor

public static Color convertRGBICCColor(Element paintedElement, Value colorDef, ICCColor iccColor, float opacity, BridgeContext ctx)
Returns a Color object that corresponds to the input Paint's ICC color value or an RGB color if the related color profile could not be used or loaded for any reason.

Parameters: paintedElement the element using the color colorDef the color definition iccColor the ICC color definition opacity the opacity ctx the bridge context to use

convertStroke

public static Stroke convertStroke(Element e)
Converts a Stroke object defined on the specified element.

Parameters: e the element on which the stroke is specified

convertStrokeDasharray

public static float[] convertStrokeDasharray(Value v)
Converts the 'stroke-dasharray' property to a list of float number in user units.

Parameters: v the CSS value describing the dasharray property

convertStrokeLinecap

public static int convertStrokeLinecap(Value v)
Converts the 'linecap' property to the appropriate BasicStroke constant.

Parameters: v the CSS value describing the linecap property

convertStrokeLinejoin

public static int convertStrokeLinejoin(Value v)
Converts the 'linejoin' property to the appropriate BasicStroke constant.

Parameters: v the CSS value describing the linejoin property

convertStrokeMiterlimit

public static float convertStrokeMiterlimit(Value v)
Converts the 'miterlimit' property to the appropriate float number.

Parameters: v the CSS value describing the miterlimit property

convertStrokePaint

public static Paint convertStrokePaint(Element strokedElement, GraphicsNode strokedNode, BridgeContext ctx)
Converts for the specified element, its stroke paint properties to a Paint object.

Parameters: strokedElement the element interested in a Paint strokedNode the graphics node to stroke ctx the bridge context

convertStrokePainter

public static ShapePainter convertStrokePainter(Element e, ShapeNode node, BridgeContext ctx)

convertURIPaint

public static Paint convertURIPaint(Element paintedElement, GraphicsNode paintedNode, Value paintDef, float opacity, BridgeContext ctx)
Converts a Paint specified as a URI.

Parameters: paintedElement the element interested in a Paint paintedNode the graphics node to paint (objectBoundingBox) paintDef the paint definition opacity the opacity to consider for the Paint ctx the bridge context

resolveColorComponent

public static int resolveColorComponent(Value v)
Returns the value of one color component (0 <= result <= 255).

Parameters: v the value that defines the color component

silentConvertURIPaint

public static Paint silentConvertURIPaint(Element paintedElement, GraphicsNode paintedNode, Value paintDef, float opacity, BridgeContext ctx)
Converts a Paint specified by URI without sending any error. if a problem occured while processing the URI, it just returns null (same effect as 'none')

Parameters: paintedElement the element interested in a Paint paintedNode the graphics node to paint (objectBoundingBox) paintDef the paint definition opacity the opacity to consider for the Paint ctx the bridge context

Returns: the paint object or null when impossible

Copyright B) 2008 Apache Software Foundation. All Rights Reserved.