com.cete.dynamicpdf.pageelements
Class ListItem

java.lang.Object
  com.cete.dynamicpdf.pageelements.ListItem

All Implemented Interfaces:

IListProperties

public class ListItem
extends java.lang.Object
implements IListProperties

Represents the ListItem.

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

Method Summary

Tag	getBodyTag() Gets the body tag.
int	getBodyTagOrder() Gets the body tag order.
Align	getBulletAlign() Gets the Align enumeration that specifies the Bullet alignment of the ListItem.
float	getBulletAreaWidth() Gets the width in which bullets will be drawn, for this ListItem.
float	getBulletSize() Gets the bullet size of the ListItem.
Tag	getBulletTag() Gets the bullets tag.
int	getBulletTagOrder() Gets the structure element order of the list item bullet.
Font	getFont() Gets the font of the ListItem.
float	getFontSize() gets the fontsize of the ListItem.
float	getLeading() Gets the leading for the text of the ListItem.
float	getLeftIndent() Gets the left indent of the ListItem.
float	getListItemBottomMargine() Gets the bottom margin of the ListItem.
Tag	getListItemTag() Gets the list item tag.
int	getListItemTagOrder() Gets the list item tag order.
float	getListItemTopMargine() Gets the top margin of the ListItem.
float	getParagraphIndent() Gets the ParagraphIndent of the ListItem.
float	getRightIndent() Gets the rightIndent of the ListItem.
boolean	getRightToLeft() Gets a value indicating if text language is RightToLeft.
boolean	getStrikeThrough() Gets the StrikeThrough value of the ListItem.
SubListList	getSubLists() Gets the SubListList of the ListItem.
Tag	getTag() Gets the structure element of the list item sublists.
int	getTagOrder() Gets the structure element order of the list item sublists.
java.lang.String	getText() Gets the Text of the ListItem.
TextAlign	getTextAlign() Gets the TextAlign enumeration that specifies the text alignment of the ListItem.
Color	getTextColor() Gets the Text Color of the ListItem.
Color	getTextOutlineColor() Gets the Color of the text outline for ListItem.
float	getTextOutlineWidth() Gets the the line width to use for the text outline of the list..
boolean	getUnderline() Gets a underline property of the ListItem.
void	setBodyTag(Tag bodyTag) Sets the body tag.
void	setBodyTagOrder(int bodyTagOrder) Sets the body tag order.
void	setBulletAlign(Align bulletAlign) Sets the Align enumeration that specifies the Bullet alignment of the ListItem.
void	setBulletAreaWidth(float bulletAreaWidth) Sets the width in which bullets will be drawn, for this ListItem.
void	setBulletSize(float bulletSize) Sets the bullet size of the ListItem.
void	setBulletTag(Tag bulletTag) Sets the bullets tag.
void	setBulletTagOrder(int bulletTagOrder) Sets the structure element order of the list item bullet.
void	setFont(Font font) Sets the font of the ListItem.
void	setFontSize(float fontSize) Sets the fontsize of the ListItem.
void	setLeading(float leading) Sets the Leading for the text of the ListItem.
void	setLeftIndent(float lIndent) Sets the left indent of the ListItem.
void	setListItemTag(Tag listItemTag) Sets the list item tag.
void	setListItemTagOrder(int listItemTagOrder) Sets the list item tag order.
void	setParagraphIndent(float paragraphIndent) Sets the ParagraphIndent of the ListItem.
void	setRightIndent(float rIndent) Sets the rightIndent of the ListItem.
void	setRightToLeft(boolean value) Sets a value indicating if text language is RightToLeft.
void	setStrikethrough(boolean strikeThrough) Sets the StrikeThrough property of the ListItem.
void	setTag(Tag tag) Sets the structure element of the list item sublists.
void	setTagOrder(int tagOrder) Gets the structure element order of the list item sublists.
void	setText(java.lang.String item) Sets the Text of the ListItem.
void	setTextAlign(TextAlign textAlign) Sets the TextAlign enumeration that specifies the text alignment of the ListItem.
void	setTextColor(Color textColor) Sets the Text Color for the ListItem.
void	setTextOutlineColor(Color textOutlineColor) Sets Color of the text outline for ListItem.
void	setTextOutlineWidth(float textOutlineWidth) Sets the line width to use for the text outline of the list..
void	setUnderline(boolean underline) Sets the underline property of the ListItem.

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.IListProperties

getBulletPrefix, getBulletSuffix, getBulletType

Method Detail

getFont

public Font getFont()

Gets the font of the ListItem.

Specified by:

getFont in interface IListProperties

Returns:

Font The font of the ListItem.

See Also:

Font

setFont

public void setFont(Font font)

Sets the font of the ListItem.

Parameters:

font - the font of the ListItem.

See Also:

Font

getFontSize

public float getFontSize()

gets the fontsize of the ListItem.

Specified by:

getFontSize in interface IListProperties

Returns:

float the font size of the ListItem.

setFontSize

public void setFontSize(float fontSize)

Sets the fontsize of the ListItem.

Parameters:

fontSize - the size of the ListItem.

setRightToLeft

public void setRightToLeft(boolean value)

Sets a value indicating if text language is RightToLeft.

Parameters:

value - boolean the RighttoLeft of the ListItem.

getRightToLeft

public boolean getRightToLeft()

Gets a value indicating if text language is RightToLeft.

Specified by:

getRightToLeft in interface IListProperties

Returns:

boolean the Right to Left of the ListItem.

getUnderline

public boolean getUnderline()

Gets a underline property of the ListItem.

Returns:

boolean The underLine property of the ListItem.

setUnderline

public void setUnderline(boolean underline)

Sets the underline property of the ListItem.

Parameters:

underline - The Underline property of the ListItem.

setStrikethrough

public void setStrikethrough(boolean strikeThrough)

Sets the StrikeThrough property of the ListItem.

Parameters:

strikeThrough - The StrikeThrough property of the ListItem.

getStrikeThrough

public boolean getStrikeThrough()

Gets the StrikeThrough value of the ListItem.

Specified by:

getStrikeThrough in interface IListProperties

Returns:

boolean the StrikeThrough value of the ListItem.

getTextColor

public Color getTextColor()

Gets the Text Color of the ListItem.

Specified by:

getTextColor in interface IListProperties

Returns:

Color for the ListItem.

See Also:

Color

setTextColor

public void setTextColor(Color textColor)

Sets the Text Color for the ListItem.

Parameters:

textColor - Color for the ListItem.

See Also:

Color

getTextOutlineColor

public Color getTextOutlineColor()

Gets the Color of the text outline for ListItem.

Specified by:

getTextOutlineColor in interface IListProperties

Returns:

Text outline Color.

See Also:

Color

setTextOutlineColor

public void setTextOutlineColor(Color textOutlineColor)

Sets Color of the text outline for ListItem.

Parameters:

textOutlineColor - Text outline Color.

See Also:

Color

getTextOutlineWidth

public float getTextOutlineWidth()

Gets the the line width to use for the text outline of the list..

Specified by:

getTextOutlineWidth in interface IListProperties

Returns:

float text outline width

setTextOutlineWidth

public void setTextOutlineWidth(float textOutlineWidth)

Sets the line width to use for the text outline of the list..

Parameters:

textOutlineWidth - Text outline width.

See Also:

Color

setText

public void setText(java.lang.String item)

Sets the Text of the ListItem.

Parameters:

item - the Text of the ListItem.

getText

public java.lang.String getText()

Gets the Text of the ListItem.

Returns:

String the Text of the ListItem.

getLeading

public float getLeading()

Gets the leading for the text of the ListItem.

Specified by:

getLeading in interface IListProperties

Returns:

float The leading for the text of the ListItem.

setLeading

public void setLeading(float leading)

Sets the Leading for the text of the ListItem.

Parameters:

leading - the Leading for the text of the ListItem.

getRightIndent

public float getRightIndent()

Gets the rightIndent of the ListItem.

Specified by:

getRightIndent in interface IListProperties

Returns:

float the rightIndent of the ListItem.

setRightIndent

public void setRightIndent(float rIndent)

Sets the rightIndent of the ListItem.

Parameters:

rIndent - the rightIndent of the ListItem.

getLeftIndent

public float getLeftIndent()

Gets the left indent of the ListItem.

Specified by:

getLeftIndent in interface IListProperties

Returns:

float the left indent of the ListItem.

setLeftIndent

public void setLeftIndent(float lIndent)

Sets the left indent of the ListItem.

Parameters:

lIndent - the left indent of the ListItem.

getBulletAlign

public Align getBulletAlign()

Gets the Align enumeration that specifies the Bullet alignment of the ListItem.

Specified by:

getBulletAlign in interface IListProperties

Returns:

Align enumeration that specifies the Bullet alignment of the ListItem.

See Also:

Align

setBulletAlign

public void setBulletAlign(Align bulletAlign)

Sets the Align enumeration that specifies the Bullet alignment of the ListItem.

Parameters:

bulletAlign - The Align enumeration that specifies the Bullet alignment of the ListItem.

See Also:

Align

getBulletAreaWidth

public float getBulletAreaWidth()

Gets the width in which bullets will be drawn, for this ListItem.

Specified by:

getBulletAreaWidth in interface IListProperties

Returns:

float the width of the bullet area .

See Also:

ListItem

setBulletAreaWidth

public void setBulletAreaWidth(float bulletAreaWidth)

Sets the width in which bullets will be drawn, for this ListItem.

Parameters:

bulletAreaWidth - the width of the bullet area.

See Also:

ListItem

getParagraphIndent

public float getParagraphIndent()

Gets the ParagraphIndent of the ListItem.

Specified by:

getParagraphIndent in interface IListProperties

Returns:

float the ParagraphIndent of the ListItem.

setParagraphIndent

public void setParagraphIndent(float paragraphIndent)

Sets the ParagraphIndent of the ListItem.

Parameters:

paragraphIndent - the ParagraphIndent of the ListItem.

getSubLists

public SubListList getSubLists()

Gets the SubListList of the ListItem.

Returns:

SubListList the SubListList of the ListItem.

setTextAlign

public void setTextAlign(TextAlign textAlign)

Sets the TextAlign enumeration that specifies the text alignment of the ListItem.

Parameters:

textAlign - TextAlign enumeration that specifies the text alignment of the ListItem.

See Also:

TextAlign

getTextAlign

public TextAlign getTextAlign()

Gets the TextAlign enumeration that specifies the text alignment of the ListItem.

Specified by:

getTextAlign in interface IListProperties

Returns:

TextAlign enumeration that specifies the text alignment of the ListItem.

See Also:

TextAlign

getListItemBottomMargine

public float getListItemBottomMargine()

Gets the bottom margin of the ListItem.

Specified by:

getListItemBottomMargine in interface IListProperties

Returns:

float the bottom margin of the ListItem.

getListItemTopMargine

public float getListItemTopMargine()

Gets the top margin of the ListItem.

Specified by:

getListItemTopMargine in interface IListProperties

Returns:

float the top margin of the ListItem.

setBulletSize

public void setBulletSize(float bulletSize)

Sets the bullet size of the ListItem.

Parameters:

bulletSize - the bullet size of the ListItem.

getBulletSize

public float getBulletSize()

Gets the bullet size of the ListItem.

Specified by:

getBulletSize in interface IListProperties

Returns:

float the bullet size of the ListItem.

getTag

public Tag getTag()

Gets the structure element of the list item sublists.

Returns:

the structure element of the list item sublists.

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

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

setTag

public void setTag(Tag tag)

Sets the structure element of the list item sublists.

Parameters:

tag - the structure element of the list item sublists.

getTagOrder

public int getTagOrder()

Gets the structure element order of the list item sublists.

Returns:

the structure element order of the list item sublists.

setTagOrder

public void setTagOrder(int tagOrder)

Gets the structure element order of the list item sublists.

Parameters:

tagOrder - the structure element order of the list item sublists.

getBulletTag

public Tag getBulletTag()

Gets the bullets tag.

Returns:

the tag.

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

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

setBulletTag

public void setBulletTag(Tag bulletTag)

Sets the bullets tag.

Parameters:

bulletTag - the tag.

getBulletTagOrder

public int getBulletTagOrder()

Gets the structure element order of the list item bullet.

Returns:

the structure element order of the list item bullet.

setBulletTagOrder

public void setBulletTagOrder(int bulletTagOrder)

Sets the structure element order of the list item bullet.

Parameters:

bulletTagOrder - the structure element order of the list item bullet.

getBodyTag

public Tag getBodyTag()

Gets the body tag.

Returns:

the body tag.

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

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

setBodyTag

public void setBodyTag(Tag bodyTag)

Sets the body tag.

Parameters:

bodyTag - the body tag.

getBodyTagOrder

public int getBodyTagOrder()

Gets the body tag order.

Returns:

the body tag order.

setBodyTagOrder

public void setBodyTagOrder(int bodyTagOrder)

Sets the body tag order.

Parameters:

bodyTagOrder - the body tag order.

getListItemTag

public Tag getListItemTag()

Gets the list item tag.

Returns:

the list item tag.

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

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

setListItemTag

public void setListItemTag(Tag listItemTag)

Sets the list item tag.

Parameters:

listItemTag - the list item tag.

getListItemTagOrder

public int getListItemTagOrder()

Gets the list item tag order.

Returns:

listItemTag the list item tag.

setListItemTagOrder

public void setListItemTagOrder(int listItemTagOrder)

Sets the list item tag order.

Parameters:

listItemTagOrder - the list item tag.