DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements
Class UnorderedList

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.List
                  extended by com.cete.dynamicpdf.pageelements.UnorderedList
All Implemented Interfaces:
IArea, ICoordinate

public class UnorderedList
extends List

This class can be used to Create UnorderedList.

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
UnorderedList(float x, float y, float width, float height)
          Creating new instance of the UnorderedList.
UnorderedList(float x, float y, float width, float height, Font font, float fontSize)
          Creating new instance of the UnorderedList.
UnorderedList(float x, float y, float width, float height, Font font, float fontSize, UnorderedListStyle bullet)
          Creating new instance of the UnorderedList.
 
Method Summary
 UnorderedListStyle getBulletStyle()
          Gets the Bullet Type of the List.
 UnorderedList getOverFlowList()
          Gets a UnorderedList object containing the List Text.
 UnorderedList getOverFlowList(float x, float y)
          Gets a UnorderedList object containing the List Text.
 float getRequiredHeight()
          Gets the height required to fit all of the text supplied.
 void setBulletStyle(UnorderedListStyle bullet)
          Sets the Bullet Type of the List.
 
Methods inherited from class com.cete.dynamicpdf.pageelements.List
drawRotated, getBulletAlign, getBulletAreaWidth, getBulletSize, getFont, getFontSize, getHeight, getLeading, getLeftIndent, getListItemBottomMargine, getListItems, getListItemTopMargine, getParagraphIndent, getRightIndent, getRightToLeft, getStrikethrough, getTag, getTagOrder, getTextAlign, getTextColor, getTextOutlineColor, getTextOutlineWidth, getWidth, setBulletAlign, setBulletAreaWidth, setBulletSize, setFont, setFontSize, setHeight, setLeading, setLeftIndent, setListItemBottomMargin, setListItemTopMargin, setParagraphIndent, setRightIndent, setRightToLeft, setStrikethrough, setTag, setTagOrder, setTextAlign, setTextColor, setTextOutlineColor, setTextOutlineWidth, setWidth
 
Methods inherited from class com.cete.dynamicpdf.pageelements.RotatingPageElement
draw, getAngle, getX, getY, setAngle, setX, setY
 
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

UnorderedList

public UnorderedList(float x,
                     float y,
                     float width,
                     float height)

Creating new instance of the UnorderedList.

Parameters:
x - X coordinate of the UnorderedList.
y - Y coordinate of the UnorderedList.
width - width of the UnorderedList.
height - height of the UnorderedList.
See Also:
UnorderedList

UnorderedList

public UnorderedList(float x,
                     float y,
                     float width,
                     float height,
                     Font font,
                     float fontSize)

Creating new instance of the UnorderedList.

Parameters:
x - X coordinate of the UnorderedList.
y - Y coordinate of the UnorderedList.
width - width of the UnorderedList.
height - height of the UnorderedList.
font - Font of the UnorderedList.
fontSize - FontSize of the UnorderedList.
See Also:
Font

UnorderedList

public UnorderedList(float x,
                     float y,
                     float width,
                     float height,
                     Font font,
                     float fontSize,
                     UnorderedListStyle bullet)

Creating new instance of the UnorderedList.

Parameters:
x - X coordinate of the UnorderedList.
y - Y coordinate of the UnorderedList.
width - width of the UnorderedList.
height - height of the UnorderedList.
font - Font of the UnorderedList.
fontSize - FontSize of the UnorderedList.
bullet - UnorderedListStyle of the UnorderedList.
See Also:
Font, UnorderedListStyle, UnorderedList
Method Detail

getRequiredHeight

public float getRequiredHeight()

Gets the height required to fit all of the text supplied.

Returns:
float The required height to display all text.

getOverFlowList

public UnorderedList getOverFlowList()

Gets a UnorderedList object containing the List Text. View Example

Returns:
a UnorderedList object.

getOverFlowList

public UnorderedList getOverFlowList(float x,
                                     float y)

Gets a UnorderedList object containing the List Text. View Example

Parameters:
x - new X coordinate of the UnorderedList.
y - new Y coordinate of the UnorderedList.
Returns:
a UnorderedList object.

setBulletStyle

public void setBulletStyle(UnorderedListStyle bullet)

Sets the Bullet Type of the List.

Parameters:
bullet - the Type of the Bullet.

getBulletStyle

public UnorderedListStyle getBulletStyle()

Gets the Bullet Type of the List.

Returns:
UnorderedListStyle The Bullet Type of the List.

DynamicPDF by ceTe Software

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