DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements
Class Link

java.lang.Object
  extended by com.cete.dynamicpdf.PageElement
      extended by com.cete.dynamicpdf.pageelements.TaggablePageElement
          extended by com.cete.dynamicpdf.pageelements.Link
All Implemented Interfaces:
IAnnotation, IArea, ICoordinate

public class Link
extends TaggablePageElement
implements IAnnotation, IArea, ICoordinate

This class can be used to place links on the PDF.

NOTE: This page element cannot be used within a table cell, or tranformation group.

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
Link(float x, float y, float width, float height, Action action)
          Creates a new instance of Link.
 
Method Summary
 void draw(PageWriter writer)
          Draws the link to the given PageWriter object.
 void drawAnnotation(DocumentWriter writer)
          Draws the link to the given DocumentWriter object.
 void drawLink(PageWriter writer)
           
 Action getAction()
          Gets the Action to be taken by the link.
 float getHeight()
          Gets the height of the link.
 float getWidth()
          Gets the width of the link.
 float getX()
          Gets the X coordinate of the link.
 float getY()
          Gets the Y coordinate of the link.
 void setHeight(float value)
          Sets the height of the link.
 void setTag(Tag tag)
          Sets the structure element of the link element.
 void setWidth(float value)
          Sets the width of the link.
 void setX(float value)
          Sets the X coordinate of the link.
 void setY(float value)
          Sets the Y coordinate of the link.
 
Methods inherited from class com.cete.dynamicpdf.pageelements.TaggablePageElement
getTag, getTagOrder, 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

Link

public Link(float x,
            float y,
            float width,
            float height,
            Action action)
Creates a new instance of Link.

Parameters:
x - X coordinate of the link.
y - Y coordinate of the link.
width - Width of the link.
height - Height of the link.
action - Action or Destination of the link.
See Also:
Link
Method Detail

getHeight

public float getHeight()
Gets the height of the link.

Specified by:
getHeight in interface IArea
Returns:
the height of the link.

getWidth

public float getWidth()
Gets the width of the link.

Specified by:
getWidth in interface IArea
Returns:
the width of the link.

getX

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

Specified by:
getX in interface ICoordinate
Returns:
the X coordinate of the link.

getY

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

Specified by:
getY in interface ICoordinate
Returns:
the Y coordinate of the link.

setHeight

public void setHeight(float value)
Sets the height of the link.

Specified by:
setHeight in interface IArea
Parameters:
value - the height of the link.

setWidth

public void setWidth(float value)
Sets the width of the link.

Specified by:
setWidth in interface IArea
Parameters:
value - the width of the link.

setX

public void setX(float value)
Sets the X coordinate of the link.

Specified by:
setX in interface ICoordinate
Parameters:
value - the X coordinate of the link.

setY

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

Specified by:
setY in interface ICoordinate
Parameters:
value - the Y coordinate of the link.

getAction

public Action getAction()
Gets the Action to be taken by the link.

Returns:
the Action to be taken by the link.
See Also:
Action

draw

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

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

drawLink

public void drawLink(PageWriter writer)

drawAnnotation

public void drawAnnotation(DocumentWriter writer)
Draws the link to the given DocumentWriter object.

Specified by:
drawAnnotation in interface IAnnotation
Parameters:
writer - DocumentWriter object to receive the link's output.
See Also:
DocumentWriter

setTag

public void setTag(Tag tag)
Sets the structure element of the link element.

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

Overrides:
setTag in class TaggablePageElement
Parameters:
tag - a structure element for taggable link element.

DynamicPDF by ceTe Software

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