com.cete.dynamicpdf.pageelements
Class List

java.lang.Object
  com.cete.dynamicpdf.PageElement
      com.cete.dynamicpdf.pageelements.TaggablePageElement
          com.cete.dynamicpdf.pageelements.RotatingPageElement
              com.cete.dynamicpdf.pageelements.List

All Implemented Interfaces:

IArea, ICoordinate

Direct Known Subclasses:

OrderedList, UnorderedList

public class List
extends RotatingPageElement
implements IArea

Represents the List.

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

void	drawRotated(PageWriter writer) Draws the List to the given PageWriter object.
Align	getBulletAlign() Get the Bullet's alignment in the List.
float	getBulletAreaWidth() Gets the width in which bullets will be drawn, for each ListItem of the List.
float	getBulletSize() Get bullet's size for the List .
Font	getFont() Gets the Font of the List.
float	getFontSize() Gets the font size of the List.
float	getHeight() Gets the height of the List.
float	getLeading() Gets the leading for the text of the List.
float	getLeftIndent() Gets the left indent of the List.
float	getListItemBottomMargine() Gets the bottom margin of the ListItems in the List.
ListItemList	getListItems() Gets the ListItemLists of the List.
float	getListItemTopMargine() Returns the top margin of the ListItems in the List.
float	getParagraphIndent() Gets the paragraph indent of the List.
float	getRightIndent() Gets the right indent of the whole List.
boolean	getRightToLeft() Gets a value indicating if the Text is in Right to Left language .
boolean	getStrikethrough() Gets the true if text for whole List is set as StrikeThrough.
Tag	getTag() Gets the tag of the taggable element.
int	getTagOrder() Gets the tag order of the taggable element.
TextAlign	getTextAlign() Gets the TextAlign enumeration that specifies the text alignment of the List.
Color	getTextColor() Gets the Color of the Text for whole List.
Color	getTextOutlineColor() Gets the Color of the text outline for whole List.
float	getTextOutlineWidth() Gets the the line width to use for the text outline of the list..
float	getWidth() Gets the Width of the List.
void	setBulletAlign(Align bulletAlign) Set the Bullet's alignment in the List.
void	setBulletAreaWidth(float bulletArea) Sets the width in which bullets will be drawn, for each ListItem of the List.
void	setBulletSize(float bulletSize) Sets bullet's size for the List.
void	setFont(Font font) Sets the Font of the List.
void	setFontSize(float fontSize) Sets the font size of the List.
void	setHeight(float height) Sets the height of the List.
void	setLeading(float leading) Sets the Leading for the text of the List.
void	setLeftIndent(float leftIndent) Sets the left indent of the List.
void	setListItemBottomMargin(float bottomMargin) Sets the bottom margin of the ListItems in the List.
void	setListItemTopMargin(float topMargin) Sets the top margin of the ListItems in the List.
void	setParagraphIndent(float paragraphIndent) Sets the paragraph indent of the List.
void	setRightIndent(float rightIndent) Sets the right indent of the whole List.It can be changed at individual ListItem level also.
void	setRightToLeft(boolean value) Sets a value indicating if the Text is in Right to Left language .
void	setStrikethrough(boolean strikeThrough) Sets the text of each ListItem of the List as StrikeThrough.
void	setTag(Tag tag) Sets the tag of the taggable element.
void	setTagOrder(int tagOrder) Sets the tag order of the taggable element.
void	setTextAlign(TextAlign textAlign) Sets the TextAlign enumeration that specifies the text alignment of the List.
void	setTextColor(Color textColor) Sets Color of the Text for whole List.
void	setTextOutlineColor(Color textOutlineColor) Sets Color of the text outline for whole List.
void	setTextOutlineWidth(float textOutlineWidth) Sets the line width to use for the text outline of the list..
void	setWidth(float width) Sets the Width of the List.

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

Method Detail

getHeight

public float getHeight()

Gets the height of the List.

Specified by:

getHeight in interface IArea

Overrides:

getHeight in class RotatingPageElement

Returns:

float the Height of the List.

setHeight

public void setHeight(float height)

Sets the height of the List.

Specified by:

setHeight in interface IArea

Overrides:

setHeight in class RotatingPageElement

Parameters:

height - the height of the List.

getWidth

public float getWidth()

Gets the Width of the List.

Specified by:

getWidth in interface IArea

Returns:

float the Width of the List.

setWidth

public void setWidth(float width)

Sets the Width of the List.

Specified by:

setWidth in interface IArea

Parameters:

width - the Width of the List.

drawRotated

public void drawRotated(PageWriter writer)

Draws the List to the given PageWriter object.

Specified by:

drawRotated in class RotatingPageElement

Parameters:

writer - PageWriter object to receive the List's output.

See Also:

PageWriter

getTag

public Tag getTag()

Gets the tag of the taggable element.

Overrides:

getTag in class TaggablePageElement

Returns:

Gets the tag of the taggable element.

Licensing:
This class 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 tag of the taggable element.

Overrides:

setTag in class TaggablePageElement

Parameters:

tag - the tag of the taggable element.

Licensing:
This class 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

getTagOrder

public int getTagOrder()

Gets the tag order of the taggable element.

Overrides:

getTagOrder in class TaggablePageElement

Returns:

the tag order of the taggable element.

setTagOrder

public void setTagOrder(int tagOrder)

Sets the tag order of the taggable element.

Overrides:

setTagOrder in class TaggablePageElement

Parameters:

tagOrder - the tag order of the taggable element.

getLeading

public float getLeading()

Gets the leading for the text of the List.

Returns:

float The Leading for the text of the List.

setLeading

public void setLeading(float leading)

Sets the Leading for the text of the List.

Parameters:

leading - the Leading for the text of the List.

getFontSize

public float getFontSize()

Gets the font size of the List.

Returns:

float the font size of the List.

setFontSize

public void setFontSize(float fontSize)

Sets the font size of the List.

Parameters:

fontSize - the font size of the List.

getFont

public Font getFont()

Gets the Font of the List.

Returns:

Font The font of the List.

See Also:

Font

setFont

public void setFont(Font font)

Sets the Font of the List.

Parameters:

font - the font of the List.

See Also:

Font

setRightToLeft

public void setRightToLeft(boolean value)

Sets a value indicating if the Text is in Right to Left language .

Parameters:

value - boolean true if language is specified as Right to Left.

getRightToLeft

public boolean getRightToLeft()

Gets a value indicating if the Text is in Right to Left language .

Returns:

boolean true if language is specified as Right to Left.

getTextColor

public Color getTextColor()

Gets the Color of the Text for whole List.

Returns:

Text Color.

See Also:

Color

setTextColor

public void setTextColor(Color textColor)

Sets Color of the Text for whole List.

Parameters:

textColor - Text Color.

See Also:

Color

getTextOutlineColor

public Color getTextOutlineColor()

Gets the Color of the text outline for whole List.

Returns:

Text outline Color.

See Also:

Color

setTextOutlineColor

public void setTextOutlineColor(Color textOutlineColor)

Sets Color of the text outline for whole List.

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

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

getRightIndent

public float getRightIndent()

Gets the right indent of the whole List. Each ListItem may have his own right to left Indent.

Returns:

float the right indent of the List.

See Also:

ListItem

setRightIndent

public void setRightIndent(float rightIndent)

Sets the right indent of the whole List.It can be changed at individual ListItem level also.

Parameters:

rightIndent - the right indent of the List.

getLeftIndent

public float getLeftIndent()

Gets the left indent of the List. Each ListItem may have his own right ot left Indent.

Returns:

float the left indent of the List.

setLeftIndent

public void setLeftIndent(float leftIndent)

Sets the left indent of the List. It can be changed at individual ListItem level also

Parameters:

leftIndent - the left indent of the List.

getTextAlign

public TextAlign getTextAlign()

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

Returns:

TextAlign enumeration that specifies the text alignment of the List.

See Also:

TextAlign

setTextAlign

public void setTextAlign(TextAlign textAlign)

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

Parameters:

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

See Also:

TextAlign

getBulletAlign

public Align getBulletAlign()

Get the Bullet's alignment in the List.

Returns:

Align enumeration that specifies the Bullet alignment.

See Also:

Align

setBulletAlign

public void setBulletAlign(Align bulletAlign)

Set the Bullet's alignment in the List.

Parameters:

bulletAlign - enumeration that specifies the Bullet alignment in the List.

See Also:

Align

getParagraphIndent

public float getParagraphIndent()

Gets the paragraph indent of the List.

Returns:

float the paragraph indent of the List.

setParagraphIndent

public void setParagraphIndent(float paragraphIndent)

Sets the paragraph indent of the List.

Parameters:

paragraphIndent - the paragraph indent of the List.

getBulletAreaWidth

public float getBulletAreaWidth()

Gets the width in which bullets will be drawn, for each ListItem of the List.

Returns:

float the width of the bullet area for each ListItem. *

See Also:

ListItem

setBulletAreaWidth

public void setBulletAreaWidth(float bulletArea)

Sets the width in which bullets will be drawn, for each ListItem of the List.

Parameters:

bulletArea - the width of the bullet area for each ListItem.

See Also:

ListItem

getListItems

public ListItemList getListItems()

Gets the ListItemLists of the List.

Returns:

ListItemList The ListItemList of the List.

setListItemTopMargin

public void setListItemTopMargin(float topMargin)

Sets the top margin of the ListItems in the List.

Parameters:

topMargin - the top margin of the ListItems in the List.

getListItemTopMargine

public float getListItemTopMargine()

Returns the top margin of the ListItems in the List.

Returns:

float the top margin of the ListItems in the List.

setListItemBottomMargin

public void setListItemBottomMargin(float bottomMargin)

Sets the bottom margin of the ListItems in the List.

Parameters:

bottomMargin - the bottom margin of the ListItems in the List.

getListItemBottomMargine

public float getListItemBottomMargine()

Gets the bottom margin of the ListItems in the List.

Returns:

float the bottom margin of the ListItems in the List.

setStrikethrough

public void setStrikethrough(boolean strikeThrough)

Sets the text of each ListItem of the List as StrikeThrough.

Parameters:

strikeThrough - the StrikeThrough of the List.

See Also:

ListItem

getStrikethrough

public boolean getStrikethrough()

Gets the true if text for whole List is set as StrikeThrough.

Returns:

boolean the StrikeThrough of the List.

getBulletSize

public float getBulletSize()

Get bullet's size for the List .

Returns:

float the bullet size of the List.

setBulletSize

public void setBulletSize(float bulletSize)

Sets bullet's size for the List.

Parameters:

bulletSize - the bullet size of the List.