DynamicPDF by ceTe Software

com.cete.dynamicpdf.pageelements
Class OrderedList

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.OrderedList
All Implemented Interfaces:
IArea, ICoordinate

public class OrderedList
extends List

This class can be used to Create OrderedList.

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

The following are different kinds of NumberingStyle.

Numbering StyleDescription
NUMERICNumeric. Arabic numbers are used: 1, 2, 3, etc. .
ROMAN_LOWERCASE.Lower Case Roman Numerals. Lower case roman numerals are used: i, ii, iii, etc.
ROMAN_UPPERCASEUpper Case Roman Numerals. Upper case roman numerals are used: I, II, III, etc. .
ALPHABETIC_LOWERCASELower Latin Letters. Lower case Latin letters are used: a, b, c, etc. After z, aa is used followed by ab, ac, ect. .
ALPHABETIC_UPPERCASELower Latin Letters. Lower case Latin letters are used: A, B, C, etc. After Z, AA is used followed by AB, AC, ect. .

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
OrderedList(float x, float y, float width, float height)
          Creating new Instance of the OrderedList.
OrderedList(float x, float y, float width, float height, Font font, float fontSize)
          Creating new Instance of the OrderedList.
OrderedList(float x, float y, float width, float height, Font font, float fontSize, NumberingStyle nStyle)
          Creating new Instance of the OrderedList.
 
Method Summary
 java.lang.String getBulletPrefix()
          Gets the Prefix String of the Bullets.
 java.lang.String getBulletSuffix()
          Gets the Suffix String of the Bullets.
 NumberingStyle getBulletType()
          Gets the NumberingStyle of the Bullet.
 OrderedList getOverFlowList()
          Gets a OrderedList object containing the List Text.
 OrderedList getOverFlowList(float x, float y)
          Gets a OrderedList object containing the List Text.
 float getRequiredHeight()
          Gets the height required to fit all of the text supplied.
 void setBulletPrefix(java.lang.String prefix)
          Sets the Prefix String of the Bullets.
 void setBulletSuffix(java.lang.String suffix)
          Sets the Suffix String of the Bullets.
 
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

OrderedList

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

Creating new Instance of the OrderedList.

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

OrderedList

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

Creating new Instance of the OrderedList.

Parameters:
x - X coordinate of the OrderedList.
y - X coordinate of the OrderedList.
width - Width of the OrderedList.
height - height of the OrderedList.
font - Font of the OrderedList.
fontSize - FontSize of the OrderedList.
See Also:
Font, OrderedList

OrderedList

public OrderedList(float x,
                   float y,
                   float width,
                   float height,
                   Font font,
                   float fontSize,
                   NumberingStyle nStyle)

Creating new Instance of the OrderedList.

Parameters:
x - X coordinate of the OrderedList.
y - X coordinate of the OrderedList.
width - Width of the OrderedList.
height - height of the OrderedList.
font - Font of the OrderedList.
fontSize - FontSize of the OrderedList.
nStyle - NumberingStyle of the OrderedList.
See Also:
Font, NumberingStyle, OrderedList
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 OrderedList getOverFlowList()
Gets a OrderedList object containing the List Text. View Example

Returns:
a OrderedList object.

getOverFlowList

public OrderedList getOverFlowList(float x,
                                   float y)
Gets a OrderedList object containing the List Text. View Example

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

setBulletPrefix

public void setBulletPrefix(java.lang.String prefix)

Sets the Prefix String of the Bullets.

Parameters:
prefix - the Prefix String of the Bullets.

setBulletSuffix

public void setBulletSuffix(java.lang.String suffix)

Sets the Suffix String of the Bullets.

Parameters:
suffix - the suffix String of the Bullets.

getBulletPrefix

public java.lang.String getBulletPrefix()

Gets the Prefix String of the Bullets.

Returns:
String the Prefix String of the Bullets

getBulletSuffix

public java.lang.String getBulletSuffix()

Gets the Suffix String of the Bullets.

Returns:
String the Suffix String of the Bullets

getBulletType

public NumberingStyle getBulletType()

Gets the NumberingStyle of the Bullet.

Returns:
NumberingStyle the NumberingStyle of the Bullet.

DynamicPDF by ceTe Software

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