com.cete.dynamicpdf.pageelements
Class Circle

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.TaggablePageElement
          com.cete.dynamicpdf.pageelements.Circle

public class Circle
extends TaggablePageElement

This class can be used to place circles on a page.

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

• DynamicPDF Generator Professional Edition
• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Professional Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

Circle(float x, float y, float radius)
Initializes a new instance of the Circle class.

Circle(float x, float y, float radius, Color borderColor)
Initializes a new instance of the Circle class.

Circle(float x, float y, float radius, Color borderColor, Color fillColor)
Initializes a new instance of the Circle class.

Circle(float x, float y, float radius, Color borderColor, Color fillColor, float borderWidth)
Initializes a new instance of the Circle class.

Circle(float x, float y, float radius, Color borderColor, Color fillColor, float borderWidth, LineStyle borderStyle)
Initializes a new instance of the Circle class.

Circle(float x, float y, float radius, Color borderColor, float borderWidth, LineStyle borderStyle)
Initializes a new instance of the Circle class.

Circle(float x, float y, float radiusX, float radiusY)
Initializes a new instance of the Circle class.

Circle(float x, float y, float radiusX, float radiusY, Color borderColor, Color fillColor, float borderWidth, LineStyle borderStyle)
Initializes a new instance of the Circle class.

Circle(float x, float y, float radius, float borderWidth, LineStyle borderStyle)
Initializes a new instance of the Circle class.

Method Summary

void	draw(PageWriter writer) Draws the circle to the given PageWriter object.
Color	getBorderColor() Gets the Color object used for the border of the circle.
LineStyle	getBorderStyle() Gets the LineStyle object that represents the border style of the circle.
float	getBorderWidth() Gets the border width of the circle.
Color	getFillColor() Gets the Color object used for the fill of the circle.
float	getRadiusX() Gets the horizontal radius of the circle.
float	getRadiusY() Gets the vertical radius of the circle.
float	getX() Gets the X coordinate of the circle.
float	getY() Gets the Y coordinate of the circle.
void	setBorderColor(Color borderColor) Sets the Color object to use for the border of the circle.
void	setBorderStyle(LineStyle borderStyle) Sets the LineStyle object that represents the border style of the circle.
void	setBorderWidth(float borderWidth) Sets the border width of the circle.
void	setFillColor(Color fillColor) Sets the Color object to use for the fill of the circle.
void	setRadiusX(float radiusX) Sets the horizontal radius of the circle.
void	setRadiusY(float radiusY) Sets the vertical radius of the circle.
void	setX(float x) Sets the X coordinate of the circle.
void	setY(float y) Sets the Y coordinate of the circle.

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

Circle

public Circle(float x,
              float y,
              float radius)

Initializes a new instance of the Circle class.

Parameters:

x - the float value indicating the X coordinate of the circle.

y - the float value indicating the Y coordinate of the circle.

radius - the float value specifying Radius of the circle.

Circle

public Circle(float x,
              float y,
              float radiusX,
              float radiusY)

Initializes a new instance of the Circle class.

Parameters:

x - the float value indicating the X coordinate of the circle.

y - the float value indicating the Y coordinate of the circle.

radiusX - the float specifying Horizontal radius of the circle.

radiusY - the float specifying Vertical radius of the circle.

Circle

public Circle(float x,
              float y,
              float radius,
              Color borderColor)

Initializes a new instance of the Circle class.

Parameters:

x - the float value indicating the X coordinate of the circle.

y - the float value indicating the Y coordinate of the circle.

radius - the float value specifying Radius of the circle.

borderColor - the Color of the border of the circle.

Circle

public Circle(float x,
              float y,
              float radius,
              float borderWidth,
              LineStyle borderStyle)

Initializes a new instance of the Circle class.

Parameters:

x - the float value indicating the X coordinate of the circle.

y - the float value indicating the Y coordinate of the circle.

radius - the float value specifying Radius of the circle.

borderWidth - float specifying width of the border of the circle.

borderStyle - LineStyle of the border of the circle.

Circle

public Circle(float x,
              float y,
              float radius,
              Color borderColor,
              float borderWidth,
              LineStyle borderStyle)

Initializes a new instance of the Circle class.

Parameters:

x - the float value indicating the X coordinate of the circle.

y - the float value indicating the Y coordinate of the circle.

radius - the float value specifying Radius of the circle.

borderColor - Color of the border of the circle.

borderWidth - float specifying width of the border of the circle.

borderStyle - LineStyle of the border of the circle.

Circle

public Circle(float x,
              float y,
              float radius,
              Color borderColor,
              Color fillColor)

Initializes a new instance of the Circle class.

Parameters:

x - the float value indicating the X coordinate of the circle.

y - the float value indicating the Y coordinate of the circle.

radius - the float value specifying Radius of the circle.

borderColor - Color of the border of the circle.

fillColor - Fill Color of the circle.

Circle

public Circle(float x,
              float y,
              float radius,
              Color borderColor,
              Color fillColor,
              float borderWidth)

Initializes a new instance of the Circle class.

Parameters:

x - the float value indicating the X coordinate of the circle.

y - the float value indicating the Y coordinate of the circle.

radius - the float value specifying Radius of the circle.

borderColor - Color of the border of the circle.

fillColor - Fill Color of the circle.

borderWidth - float specifying width of the border of the circle.

Circle

public Circle(float x,
              float y,
              float radius,
              Color borderColor,
              Color fillColor,
              float borderWidth,
              LineStyle borderStyle)

Initializes a new instance of the Circle class.

Parameters:

x - the float value indicating the X coordinate of the circle.

y - the float value indicating the Y coordinate of the circle.

radius - the float value specifying Radius of the circle.

borderColor - Color of the border of the circle.

fillColor - Fill Color of the circle.

borderWidth - float specifying width of the border of the circle.

borderStyle - LineStyle of the border of the circle.

Circle

public Circle(float x,
              float y,
              float radiusX,
              float radiusY,
              Color borderColor,
              Color fillColor,
              float borderWidth,
              LineStyle borderStyle)

Initializes a new instance of the Circle class.

Parameters:

x - the float value indicating the X coordinate of the circle.

y - the float value indicating the Y coordinate of the circle.

radiusX - the float specifying Horizontal radius of the circle.

radiusY - the float specifying Vertical radius of the circle.

borderColor - Color of the border of the circle.

fillColor - Fill Color of the circle.

borderWidth - float specifying width of the border of the circle.

borderStyle - LineStyle of the border of the circle.

Method Detail

setBorderStyle

public void setBorderStyle(LineStyle borderStyle)

Sets the LineStyle object that represents the border style of the circle.

Parameters:

borderStyle - LineStyle object specifying border style of the circle.

See Also:

LineStyle

getBorderStyle

public LineStyle getBorderStyle()

Gets the LineStyle object that represents the border style of the circle.

Returns:

LineStyle LineStyle object specifying border style of the circle.

See Also:

LineStyle

setBorderWidth

public void setBorderWidth(float borderWidth)

Sets the border width of the circle.

Parameters:

borderWidth - the float specifying the border width of the circle.

getBorderWidth

public float getBorderWidth()

Gets the border width of the circle.

Returns:

the float specifying the border width of the circle.

setBorderColor

public void setBorderColor(Color borderColor)

Sets the Color object to use for the border of the circle.

Parameters:

borderColor - the Color object to use for the border of the circle.

See Also:

Color

getBorderColor

public Color getBorderColor()

Gets the Color object used for the border of the circle.

Returns:

the Color object used for the border of the circle.

See Also:

Color

setFillColor

public void setFillColor(Color fillColor)

Sets the Color object to use for the fill of the circle.

Parameters:

fillColor - Color object to use for the fill of the circle.

See Also:

Color

getFillColor

public Color getFillColor()

Gets the Color object used for the fill of the circle.

Returns:

the Color object used for the fill of the circle.

See Also:

Color

setX

public void setX(float x)

Sets the X coordinate of the circle.

Parameters:

x - the float value used to set the X coordinate of the circle.

getX

public float getX()

Gets the X coordinate of the circle.

Returns:

the float value specifying the X coordinate of the circle.

setY

public void setY(float y)

Sets the Y coordinate of the circle.

Parameters:

y - the float value used to set the Y coordinate of the circle.

getY

public float getY()

Gets the Y coordinate of the circle.

Returns:

the float value specifying the Y coordinate of the circle.

setRadiusX

public void setRadiusX(float radiusX)

Sets the horizontal radius of the circle.

Parameters:

radiusX - the float value used to set the horizontal radius of the circle.

getRadiusX

public float getRadiusX()

Gets the horizontal radius of the circle.

Returns:

the float value specifying the horizontal radius of the circle.

setRadiusY

public void setRadiusY(float radiusY)

Sets the vertical radius of the circle.

Parameters:

radiusY - the float value used to set the vertical radius of the circle.

getRadiusY

public float getRadiusY()

Gets the vertical radius of the circle.

Returns:

the float value specifying the vertical radius of the circle.

draw

public void draw(PageWriter writer)

Draws the circle to the given PageWriter object.

Overrides:

draw in class TaggablePageElement

Parameters:

writer - PageWriter object to receive the circle's output.

See Also:

PageWriter