com.itextpdf.svg.utils

Class SvgTextProperties

java.lang.Object

com.itextpdf.svg.utils.SvgTextProperties

public class SvgTextProperties
extends Object

This class represents text and tspan SVG elements properties identifying their graphics state. Created for internal usage.

Constructor Summary

Constructors

Constructor and Description
SvgTextProperties() Creates new SvgTextProperties instance.
SvgTextProperties(SvgTextProperties textProperties) Creates copy of the provided SvgTextProperties instance.

Method Summary

Modifier and Type	Method and Description
float[]	getDashArray() Gets dash array part of the dash pattern to be used when paths are stroked.
float	getDashPhase() Gets dash phase part of the dash pattern to be used when paths are stroked.
com.itextpdf.kernel.colors.Color	getFillColor() Gets text fill color.
float	getFillOpacity() Gets text fill opacity.
float	getLineWidth() Gets text line (or stroke) width.
com.itextpdf.kernel.colors.Color	getStrokeColor() Gets text stroke color.
float	getStrokeOpacity() Gets text stroke opacity.
List<Underline>	getTextDecoration() Gets the list of Underline values representing text-decoration horizontal lines that can be an underline, strikethrough or overline.
SvgTextProperties	setDashPattern(float[] dashArray, float dashPhase) Sets a description of the dash pattern to be used when paths are stroked.
SvgTextProperties	setFillColor(com.itextpdf.kernel.colors.Color fillColor) Sets text fill color.
SvgTextProperties	setFillOpacity(float fillOpacity) Sets text fill opacity.
SvgTextProperties	setLineWidth(float lineWidth) Sets text line (or stroke) width.
SvgTextProperties	setStrokeColor(com.itextpdf.kernel.colors.Color strokeColor) Sets text stroke color.
SvgTextProperties	setStrokeOpacity(float strokeOpacity) Sets text stroke opacity.
SvgTextProperties	setTextDecoration(List<Underline> underlineList) Sets the list of Underline values representing text-decoration horizontal lines that can be an underline, strikethrough or overline.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SvgTextProperties

public SvgTextProperties()

Creates new SvgTextProperties instance.

SvgTextProperties

public SvgTextProperties(SvgTextProperties textProperties)

Creates copy of the provided SvgTextProperties instance.

Parameters:

textProperties - SvgTextProperties instance to copy

Method Detail

getStrokeColor

public com.itextpdf.kernel.colors.Color getStrokeColor()

Gets text stroke color.

Returns:

stroke color

setStrokeColor

public SvgTextProperties setStrokeColor(com.itextpdf.kernel.colors.Color strokeColor)

Sets text stroke color.

Parameters:

strokeColor - stroke color to set

Returns:

this same SvgTextProperties instance

getFillColor

public com.itextpdf.kernel.colors.Color getFillColor()

Gets text fill color.

Returns:

fill color

setFillColor

public SvgTextProperties setFillColor(com.itextpdf.kernel.colors.Color fillColor)

Sets text fill color.

Parameters:

fillColor - fill color to set

Returns:

this same SvgTextProperties instance

getLineWidth

public float getLineWidth()

Gets text line (or stroke) width.

Returns:

text line width

setLineWidth

public SvgTextProperties setLineWidth(float lineWidth)

Sets text line (or stroke) width.

Parameters:

lineWidth - text line width

Returns:

this same SvgTextProperties instance

getStrokeOpacity

public float getStrokeOpacity()

Gets text stroke opacity.

Returns:

stroke opacity

setStrokeOpacity

public SvgTextProperties setStrokeOpacity(float strokeOpacity)

Sets text stroke opacity.

Parameters:

strokeOpacity - stroke opacity to set

Returns:

this same SvgTextProperties instance

getFillOpacity

public float getFillOpacity()

Gets text fill opacity.

Returns:

fill opacity

setFillOpacity

public SvgTextProperties setFillOpacity(float fillOpacity)

Sets text fill opacity.

Parameters:

fillOpacity - fill opacity to set

Returns:

this same SvgTextProperties instance

getTextDecoration

public List<Underline> getTextDecoration()

Gets the list of Underline values representing text-decoration horizontal lines that can be an underline, strikethrough or overline.

Returns:

the list of Underline values

setTextDecoration

public SvgTextProperties setTextDecoration(List<Underline> underlineList)

Sets the list of Underline values representing text-decoration horizontal lines that can be an underline, strikethrough or overline.

Parameters:

underlineList - the list of Underline values to set

Returns:

this same SvgTextProperties instance

getDashArray

public float[] getDashArray()

Gets dash array part of the dash pattern to be used when paths are stroked. Default value is solid line.

The line dash pattern is expressed as an array of the form [ dashArray dashPhase ], where dashArray is itself an array and dashPhase is an integer.

An empty dash array (first element in the array) and zero phase (second element in the array) can be used to restore the dash pattern to a solid line.

Returns:

float dash array

getDashPhase

public float getDashPhase()

Gets dash phase part of the dash pattern to be used when paths are stroked. Default value is solid line.

The line dash pattern is expressed as an array of the form [ dashArray dashPhase ], where dashArray is itself an array and dashPhase is an integer.

An empty dash array (first element in the array) and zero phase (second element in the array) can be used to restore the dash pattern to a solid line.

Returns:

float dash array

setDashPattern

public SvgTextProperties setDashPattern(float[] dashArray,
                                        float dashPhase)

Sets a description of the dash pattern to be used when paths are stroked. Default value is solid line.

The line dash pattern is expressed as an array of the form [ dashArray dashPhase ], where dashArray is itself an array and dashPhase is a number.

An empty dash array (first element in the array) and zero phase (second element in the array) can be used to restore the dash pattern to a solid line.

Parameters:

dashArray - dash array

dashPhase - dash phase value

Returns:

this same SvgTextProperties instance