DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements
Class Path

java.lang.Object
  extended by com.cete.dynamicpdf.PageElement
      extended by com.cete.dynamicpdf.pageelements.TaggablePageElement
          extended by com.cete.dynamicpdf.pageelements.Path
All Implemented Interfaces:
ICoordinate

public class Path
extends TaggablePageElement
implements ICoordinate

This class can be used to specify a collection of sub paths which will be used to complete your path. Sub paths that can be added are CurveFromSubPath, CurveSubPath, CurveToSubPath and LineSubPath.

Licensing:
This class is a DynamicPDF Generator Professional Edition feature. One of the following licenses is required for non-evaluation usage:

View Example


Constructor Summary
Path(float x, float y)
          Initializes a new instance of the Path class.
Path(float x, float y, Color lineColor)
          Initializes a new instance of the Path class.
Path(float x, float y, Color lineColor, Color fillColor)
          Initializes a new instance of the Path class.
Path(float x, float y, Color lineColor, Color fillColor, float lineWidth, LineStyle lineStyle, boolean closePath)
          Initializes a new instance of the Path class.
Path(float x, float y, Color lineColor, float lineWidth, LineStyle lineStyle)
          Initializes a new instance of the Path class.
Path(float x, float y, Color lineColor, float lineWidth, LineStyle lineStyle, boolean closePath)
          Initializes a new instance of the Path class.
 
Method Summary
 void draw(PageWriter writer)
          Draws the path to the given PageWriter object.
 boolean getClosePath()
          Gets a value specifying if the path should be closed.
 Color getFillColor()
          Gets the Color object to use for the fill of the path.
 LineCap getLineCap()
          Gets the LineCap enumeration used to specify the line cap style of the path's lines.
 Color getLineColor()
          Gets the Color object to use for the path's lines.
 LineJoin getLineJoin()
          Gets the LineJoin enumeration used to specify the line join style of the path's lines.
 LineStyle getLineStyle()
          Gets the LineStyle object used to specify the style of the path's lines.
 float getLineWidth()
          Gets the width of the path's lines.
 float getMiterLimit()
          Gets the miter limit of the path's lines.
 SubPathList getSubPaths()
          Gets SubPathList that contains a collection of SubPath objects.
 float getX()
          Gets the X coordinate of the path.
 float getY()
          Gets the Y coordinate of the path.
 void setClosePath(boolean value)
          Sets a value specifying if the path should be closed.
 void setFillColor(Color value)
          Sets the Color object to use for the fill of the path.
 void setLineCap(LineCap value)
          Sets the LineCap enumeration used to specify the line cap style of the path's lines.
 void setLineColor(Color value)
          Sets the Color object to use for the path's lines.
 void setLineJoin(LineJoin value)
          Sets the LineJoin enumeration used to specify the line join style of the path's lines.
 void setLineStyle(LineStyle value)
          Sets the LineStyle object used to specify the style of the path's lines.
 void setLineWidth(float value)
          Sets the width of the path's lines.
 void setMiterLimit(float value)
          Sets the miter limit of the path's lines.
 void setX(float value)
          Set the X coordinate of the path.
 void setY(float value)
          Sets the Y coordinate of the path.
 
Methods inherited from class com.cete.dynamicpdf.pageelements.TaggablePageElement
getTag, getTagOrder, setTag, setTagOrder
 
Methods inherited from class com.cete.dynamicpdf.PageElement
getRequiredLicenseLevel, getStrID, setRequiredLicenseLevel, setStrID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Path

public Path(float x,
            float y)
Initializes a new instance of the Path class.

Parameters:
x - X coordinate of the path.
y - Y coordinate of the path.
See Also:
Path

Path

public Path(float x,
            float y,
            Color lineColor)
Initializes a new instance of the Path class.

Parameters:
x - X coordinate of the path.
y - Y coordinate of the path.
lineColor - Color of the lines of the path.
See Also:
Path

Path

public Path(float x,
            float y,
            Color lineColor,
            Color fillColor)
Initializes a new instance of the Path class.

Parameters:
x - X coordinate of the path.
y - Y coordinate of the path.
lineColor - Color of the lines of the path.
fillColor - Color of the fill of the path.
See Also:
Path

Path

public Path(float x,
            float y,
            Color lineColor,
            float lineWidth,
            LineStyle lineStyle)
Initializes a new instance of the Path class.

Parameters:
x - X coordinate of the path.
y - Y coordinate of the path.
lineColor - Color of the lines of the path.
lineWidth - Width of the lines of the path.
lineStyle - Style of the lines of the path.
See Also:
Path

Path

public Path(float x,
            float y,
            Color lineColor,
            float lineWidth,
            LineStyle lineStyle,
            boolean closePath)
Initializes a new instance of the Path class.

Parameters:
x - X coordinate of the path.
y - Y coordinate of the path.
lineColor - Color of the lines of the path.
lineWidth - Width of the lines of the path.
lineStyle - Style of the lines of the path.
closePath - Specifies if the path should be closed.
See Also:
Path

Path

public Path(float x,
            float y,
            Color lineColor,
            Color fillColor,
            float lineWidth,
            LineStyle lineStyle,
            boolean closePath)
Initializes a new instance of the Path class.

Parameters:
x - X coordinate of the path.
y - Y coordinate of the path.
lineColor - Color of the lines of the path.
fillColor - Color of the fill of the path.
lineWidth - Width of the lines of the path.
lineStyle - Style of the lines of the path.
closePath - Specifies if the path should be closed.
See Also:
Path
Method Detail

setLineStyle

public void setLineStyle(LineStyle value)
Sets the LineStyle object used to specify the style of the path's lines.

Parameters:
value - the line style of the path's lines.
See Also:
LineStyle

getLineStyle

public LineStyle getLineStyle()
Gets the LineStyle object used to specify the style of the path's lines.

Returns:
the line style of the path's lines.
See Also:
LineStyle

setLineCap

public void setLineCap(LineCap value)
Sets the LineCap enumeration used to specify the line cap style of the path's lines.

Parameters:
value - the line cap of the path's lines.
See Also:
LineCap

getLineCap

public LineCap getLineCap()
Gets the LineCap enumeration used to specify the line cap style of the path's lines.

Returns:
the line cap of the path's lines.
See Also:
LineCap

setLineJoin

public void setLineJoin(LineJoin value)
Sets the LineJoin enumeration used to specify the line join style of the path's lines.

Parameters:
value - the line join style of the path's lines.
See Also:
LineJoin

getLineJoin

public LineJoin getLineJoin()
Gets the LineJoin enumeration used to specify the line join style of the path's lines.

Returns:
the line join style of the path's lines.
See Also:
LineJoin

setMiterLimit

public void setMiterLimit(float value)
Sets the miter limit of the path's lines.

Parameters:
value - the miter limit of the path's lines.

getMiterLimit

public float getMiterLimit()
Gets the miter limit of the path's lines.

Returns:
the miter limit of the path's lines.

getSubPaths

public SubPathList getSubPaths()
Gets SubPathList that contains a collection of SubPath objects.

Returns:
the subpath list.
See Also:
SubPathList, SubPath

setLineWidth

public void setLineWidth(float value)
Sets the width of the path's lines.

Parameters:
value - the width of the path's lines.

getLineWidth

public float getLineWidth()
Gets the width of the path's lines.

Returns:
the width of the path's lines.

setLineColor

public void setLineColor(Color value)
Sets the Color object to use for the path's lines.

Parameters:
value - the line color of the path's lines.
See Also:
Color

getLineColor

public Color getLineColor()
Gets the Color object to use for the path's lines.

Returns:
the line color of the path's lines.
See Also:
Color

setFillColor

public void setFillColor(Color value)
Sets the Color object to use for the fill of the path.

Parameters:
value - the fill color of the path's lines.
See Also:
Color

getFillColor

public Color getFillColor()
Gets the Color object to use for the fill of the path.

Returns:
the fill color of the path's lines.
See Also:
Color

setX

public void setX(float value)
Set the X coordinate of the path.

Specified by:
setX in interface ICoordinate
Parameters:
value - the x coordinate of the path's lines.

getX

public float getX()
Gets the X coordinate of the path.

Specified by:
getX in interface ICoordinate
Returns:
the x coordinate of the path's lines.

setY

public void setY(float value)
Sets the Y coordinate of the path.

Specified by:
setY in interface ICoordinate
Parameters:
value - the y coordinate of the path's lines.

getY

public float getY()
Gets the Y coordinate of the path.

Specified by:
getY in interface ICoordinate
Returns:
the y coordinate of the path's lines.

setClosePath

public void setClosePath(boolean value)
Sets a value specifying if the path should be closed.

Parameters:
value - specifying if the path should be closed.

getClosePath

public boolean getClosePath()
Gets a value specifying if the path should be closed.

Returns:
specifying if the path should be closed.

draw

public void draw(PageWriter writer)
Draws the path to the given PageWriter object.

Overrides:
draw in class TaggablePageElement
Parameters:
writer - PageWriter object to receive the sub path's output.
See Also:
PageWriter

DynamicPDF by ceTe Software

API Reference for DynamicPDF v10.04 for Java generated on September 25, 2019
© Copyright 2019, ceTe Software