DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements.html
Class HtmlArea

java.lang.Object
  extended by com.cete.dynamicpdf.PageElement
      extended by com.cete.dynamicpdf.pageelements.TaggablePageElement
          extended by com.cete.dynamicpdf.pageelements.RotatingPageElement
              extended by com.cete.dynamicpdf.pageelements.html.HtmlArea
All Implemented Interfaces:
IArea, ICoordinate

public class HtmlArea
extends RotatingPageElement
implements IArea, ICoordinate

This class can be used to place HTML Area on a page.

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
HtmlArea(java.lang.String text, float x, float y, float width, float height)
          Creates a new instance of the HtmlArea class.
HtmlArea(java.lang.String text, float x, float y, java.net.URI baseHref, float width, float height)
          Creates a new instance of HtmlArea class.
HtmlArea(java.net.URI uri, float x, float y, float width, float height)
          Creates a new instance of the HtmlArea class.
HtmlArea(java.net.URI uri, float x, float y, java.net.URI baseHref, float width, float height)
          Creates a new instance of the HtmlArea class.
 
Method Summary
protected  void drawRotated(PageWriter writer)
          Draws the label to the given PageWriter object.
 float getHeight()
          Gets the height of the HTML area.
 HtmlArea getOverflowHtmlArea()
          Returns a new HtmlArea object containing the overflow html area.
 HtmlArea getOverflowHtmlArea(float x, float y, float height)
          Returns a new HtmlArea object containing the overflow html area.
 float getRequiredHeight()
          Returns the height required to fit html file.
 float getWidth()
          Gets the width of the HTML area.
 void setHeight(float value)
          Sets the height of the HTML area.
 void setWidth(float value)
          Sets the width of the HTML area.
 
Methods inherited from class com.cete.dynamicpdf.pageelements.RotatingPageElement
draw, getAngle, getX, getY, setAngle, setX, setY
 
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
 
Methods inherited from interface com.cete.dynamicpdf.pageelements.ICoordinate
getX, getY, setX, setY
 

Constructor Detail

HtmlArea

public HtmlArea(java.net.URI uri,
                float x,
                float y,
                float width,
                float height)
Creates a new instance of the HtmlArea class.

Parameters:
uri - the URL representing physical file path of the HTML Area.
x - X coordinate of the HTML Area.
y - Y coordinate of the HTML Area.
width - Width of the HTML Area.
height - Height of the HTML Area.

HtmlArea

public HtmlArea(java.net.URI uri,
                float x,
                float y,
                java.net.URI baseHref,
                float width,
                float height)
Creates a new instance of the HtmlArea class.

Parameters:
uri - the URL representing physical file path of the HTML Area.
x - X coordinate of the HTML Area.
y - Y coordinate of the HTML Area.
baseHref - Creates a new instance of the Uri class with the specified base href URL.
width - Width of the HTML Area.
height - Height of the HTML Area.

HtmlArea

public HtmlArea(java.lang.String text,
                float x,
                float y,
                float width,
                float height)
Creates a new instance of the HtmlArea class.

Parameters:
text - the string representing Text to display in the HTML Area.
x - X coordinate of the HTML Area.
y - Y coordinate of the HTML Area.
width - Width of the HTML Area.
height - Height of the HTML Area.

HtmlArea

public HtmlArea(java.lang.String text,
                float x,
                float y,
                java.net.URI baseHref,
                float width,
                float height)
Creates a new instance of HtmlArea class.

Parameters:
text - the string representing Text to display in the HTML Area.
x - X coordinate of the HTML Area.
y - Y coordinate of the HTML Area.
baseHref - Creates a new instance of the Uri class with the specified base href URL.
width - Width of the HTML Area.
height - Height of the HTML Area.
Method Detail

getHeight

public float getHeight()
Gets the height of the HTML area.

Specified by:
getHeight in interface IArea
Overrides:
getHeight in class RotatingPageElement
Returns:
the height of the HTML area.

setHeight

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

Specified by:
setHeight in interface IArea
Overrides:
setHeight in class RotatingPageElement
Parameters:
value - the height of the HTML area.

getWidth

public float getWidth()
Gets the width of the HTML area.

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

setWidth

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

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

drawRotated

protected void drawRotated(PageWriter writer)
Draws the label to the given PageWriter object.

Specified by:
drawRotated in class RotatingPageElement
Parameters:
writer - PageWriter object to receive the label's output.
See Also:
PageWriter

getOverflowHtmlArea

public HtmlArea getOverflowHtmlArea(float x,
                                    float y,
                                    float height)
Returns a new HtmlArea object containing the overflow html area. View Example

Parameters:
x - X coordinate of the new object.
y - Y coordinate of the new object.
height - Height of the new object.

getOverflowHtmlArea

public HtmlArea getOverflowHtmlArea()
Returns a new HtmlArea object containing the overflow html area. View Example


getRequiredHeight

public float getRequiredHeight()
Returns the height required to fit html file.


DynamicPDF by ceTe Software

API Reference for DynamicPDF v10.07 for Java generated on Aug 12, 2020
© Copyright 2020, ceTe Software