com.cete.dynamicpdf.pageelements
Class SubList

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

All Implemented Interfaces:

IListProperties

Direct Known Subclasses:

OrderedSubList, UnorderedSubList

public abstract class SubList
extends java.lang.Object
implements IListProperties

Represents the SubList that can be initialized on 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

See Also:

List

Method Summary

Align	getBulletAlign() Get the Bullet's alignment in the SubList.
float	getBulletAreaWidth() Gets the width in which bullets will be drawn, for each ListItem of the SubList.
float	getBulletSize() Get bullet's size for the SubList .
Font	getFont() Gets the Font of the SubList.
float	getFontSize() Gets the font size of the SubList.
float	getLeading() Gets the leading for the text of the SubList.
float	getLeftIndent() Gets the left indent of the SubList.
float	getListItemBottomMargine() Gets the bottom margin of the ListItems in the SubList.
ListItemList	getListItems() Gets the ListItemLists of the SubList.
float	getListItemTopMargine() Returns the top margin of the ListItems in the SubList.
float	getParagraphIndent() Gets the paragraph indent of the SubList.
float	getRightIndent() Gets the right indent of the whole SubList.
boolean	getRightToLeft() Gets a value indicating if the Text is in Right to Left language .
boolean	getStrikeThrough() Gets the true if text for whole SubList is set as StrikeThrough.
Tag	getTag() Gets the structure element of the sub list.
int	getTagOrder() Gets the structure element order of the sub list.
TextAlign	getTextAlign() Gets the TextAlign enumeration that specifies the text alignment of the SubList.
Color	getTextColor() Gets the Color of the Text for whole SubList.
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..
void	setBulletAlign(Align bulletAlign) Set the Bullet's alignment in the SubList.
void	setBulletAreaWidth(float bulletArea) Sets the width in which bullets will be drawn, for each ListItem of the SubList.
void	setBulletSize(float bulletSize) Sets bullet's size for the SubList.
void	setFont(Font font) Sets the Font of the SubList.
void	setFontSize(float fontSize) Sets the font size of the SubList.
void	setLeading(float leading) Sets the Leading for the text of the SubList.
void	setLeftIndent(float leftIndent) Sets the left indent of the SubList.
void	setListItemBottomMargin(float bottomMargin) Sets the bottom margin of the ListItems in the SubList.
void	setListItemTopMargin(float topMargin) Sets the top margin of the ListItems in the SubList.
void	setParagraphIndent(float paragraphIndent) Sets the paragraph indent of the SubList.
void	setRightIndent(float rightIndent) Sets the right indent of the whole SubList.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 SubList as StrikeThrough.
void	setTag(Tag tag) Sets the structure element of the sub list.
void	setTagOrder(int tagOrder) Sets the structure element order of the sub list.
void	setTextAlign(TextAlign textAlign) Sets the TextAlign enumeration that specifies the text alignment of the SubList.
void	setTextColor(Color textColor) Sets Color of the Text for whole SubList.
void	setTextOutlineColor(Color value) 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..

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

getLeading

public float getLeading()

Gets the leading for the text of the SubList.

Specified by:

getLeading in interface IListProperties

Returns:

float The Leading for the text of the SubList.

setLeading

public void setLeading(float leading)

Sets the Leading for the text of the SubList.

Parameters:

leading - the Leading for the text of the SubList.

getFontSize

public float getFontSize()

Gets the font size of the SubList.

Specified by:

getFontSize in interface IListProperties

Returns:

float the font size of the SubList.

setFontSize

public void setFontSize(float fontSize)

Sets the font size of the SubList.

Parameters:

fontSize - the font size of the SubList.

getFont

public Font getFont()

Gets the Font of the SubList.

Specified by:

getFont in interface IListProperties

Returns:

Font The font of the SubList.

See Also:

Font

setFont

public void setFont(Font font)

Sets the Font of the SubList.

Parameters:

font - the font of the SubList.

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 .

Specified by:

getRightToLeft in interface IListProperties

Returns:

boolean true if language is specified as Right to Left.

getTextColor

public Color getTextColor()

Gets the Color of the Text for whole SubList.

Specified by:

getTextColor in interface IListProperties

Returns:

Text Color.

See Also:

Color

setTextColor

public void setTextColor(Color textColor)

Sets Color of the Text for whole SubList.

Parameters:

textColor - Text Color.

See Also:

Color

getTextOutlineColor

public Color getTextOutlineColor()

Gets the Color of the text outline for whole List.

Specified by:

getTextOutlineColor in interface IListProperties

Returns:

Text outline Color.

See Also:

Color

setTextOutlineColor

public void setTextOutlineColor(Color value)

Sets Color of the text outline for whole List.

Parameters:

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

getRightIndent

public float getRightIndent()

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

Specified by:

getRightIndent in interface IListProperties

Returns:

float the right indent of the SubList.

See Also:

ListItem

setRightIndent

public void setRightIndent(float rightIndent)

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

Parameters:

rightIndent - the right indent of the SubList.

getLeftIndent

public float getLeftIndent()

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

Specified by:

getLeftIndent in interface IListProperties

Returns:

float the left indent of the SubList.

setLeftIndent

public void setLeftIndent(float leftIndent)

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

Parameters:

leftIndent - the left indent of the SubList.

getTextAlign

public TextAlign getTextAlign()

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

Specified by:

getTextAlign in interface IListProperties

Returns:

TextAlign enumeration that specifies the text alignment of the SubList.

See Also:

TextAlign

setTextAlign

public void setTextAlign(TextAlign textAlign)

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

Parameters:

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

See Also:

TextAlign

getBulletAlign

public Align getBulletAlign()

Get the Bullet's alignment in the SubList.

Specified by:

getBulletAlign in interface IListProperties

Returns:

Align enumeration that specifies the Bullet alignment.

See Also:

Align

setBulletAlign

public void setBulletAlign(Align bulletAlign)

Set the Bullet's alignment in the SubList.

Parameters:

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

See Also:

Align

getParagraphIndent

public float getParagraphIndent()

Gets the paragraph indent of the SubList.

Specified by:

getParagraphIndent in interface IListProperties

Returns:

float the paragraph indent of the SubList.

setParagraphIndent

public void setParagraphIndent(float paragraphIndent)

Sets the paragraph indent of the SubList.

Parameters:

paragraphIndent - the paragraph indent of the SubList.

getBulletAreaWidth

public float getBulletAreaWidth()

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

Specified by:

getBulletAreaWidth in interface IListProperties

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

Parameters:

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

See Also:

ListItem

getListItems

public ListItemList getListItems()

Gets the ListItemLists of the SubList.

Returns:

ListItemList The ListItemList of the SubList.

setListItemTopMargin

public void setListItemTopMargin(float topMargin)

Sets the top margin of the ListItems in the SubList.

Parameters:

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

getListItemTopMargine

public float getListItemTopMargine()

Returns the top margin of the ListItems in the SubList.

Specified by:

getListItemTopMargine in interface IListProperties

Returns:

float the top margin of the ListItems in the SubList.

setListItemBottomMargin

public void setListItemBottomMargin(float bottomMargin)

Sets the bottom margin of the ListItems in the SubList.

Parameters:

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

getListItemBottomMargine

public float getListItemBottomMargine()

Gets the bottom margin of the ListItems in the SubList.

Specified by:

getListItemBottomMargine in interface IListProperties

Returns:

float the bottom margin of the ListItems in the SubList.

setStrikeThrough

public void setStrikeThrough(boolean strikeThrough)

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

Parameters:

strikeThrough - the StrikeThrough of the SubList.

See Also:

ListItem

getStrikeThrough

public boolean getStrikeThrough()

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

Specified by:

getStrikeThrough in interface IListProperties

Returns:

boolean the StrikeThrough of the SubList.

getBulletSize

public float getBulletSize()

Get bullet's size for the SubList .

Specified by:

getBulletSize in interface IListProperties

Returns:

float the bullet size of the SubList.

setBulletSize

public void setBulletSize(float bulletSize)

Sets bullet's size for the SubList.

Parameters:

bulletSize - the bullet size of the SubList.

getTag

public Tag getTag()

Gets the structure element of the sub list.

Returns:

the structure element of the sub list.

setTag

public void setTag(Tag tag)

Sets the structure element of the sub list.

Parameters:

tag - the structure element of the sub list.

getTagOrder

public int getTagOrder()

Gets the structure element order of the sub list.

Returns:

the structure element order of the sub list.

setTagOrder

public void setTagOrder(int tagOrder)

Sets the structure element order of the sub list.

Parameters:

tagOrder - the structure element order of the sub list.