com.spire.doc.documents
Class ListLevel

java.lang.Object
  com.spire.doc.OwnerHolder
      com.spire.doc.documents.xml.DocumentSerializable
          com.spire.doc.documents.ListLevel

public class ListLevel
extends DocumentSerializable

Summary description for WListLevel.

Constructor Summary

ListLevel(ListStyle listStyle)
Initializes a new instance of the ListLevel class

Method Summary

void	createLayoutData(java.lang.String numStr, byte[] characterOffsets, int levelNumber) Create level layout data
ListLevel	deepClone() Clones this instance.
java.lang.String	getBulletCharacter() Get bullet pattern
CharacterFormat	getCharacterFormat() Returns character formats of list symbol.
FollowCharacterType	getFollowCharacter() Get the type of character following the number text for the paragraph.
java.lang.String	getListItemText(int listItemIndex, ListType listType) Gets list symbol for specified item index
boolean	getNoRestartByHigher() True if the level's number sequence is not restarted by higher (more significant) levels in the list.
ListNumberAlignment	getNumberAlignment() Get alignment (left, right, or centered) of the paragraph number.
float	getNumberPosition() Get number/bullet position for current listlevel.
java.lang.String	getNumberPrefix() Get prefix pattern for numbered level.
java.lang.String	getNumberSufix() Returns suffix pattern for numbered level.
ParagraphFormat	getParagraphFormat() Returns paragraph format of list level.
ListPatternType	getPatternType() Returns list numbering type.
int	getStartAt() Get start at value.
float	getTabSpaceAfter() Get spacing after list level's number or bullet ( tab position if follow character is tab ).
float	getTextPosition() Returns listlevel indent
boolean	getUsePrevLevelPattern() When true, number generated will include previous levels (used for legal numbering).
boolean	isLegalStyleNumbering() Get ArabaicNumberFormat property ( true if the level turns all inherited numbers to arabic, false if it preserves their number format code ).
void	isLegalStyleNumbering(boolean value) Set ArabaicNumberFormat property ( true if the level turns all inherited numbers to arabic, false if it preserves their number format code ).
void	setBulletCharacter(java.lang.String value) Set bullet pattern
void	setFollowCharacter(FollowCharacterType value) Set the type of character following the number text for the paragraph.
void	setNoRestartByHigher(boolean value) True if the level's number sequence is not restarted by higher (more significant) levels in the list.
void	setNumberAlignment(ListNumberAlignment value) Set alignment (left, right, or centered) of the paragraph number.
void	setNumberPosition(float value) Set number/bullet position for current listlevel.
void	setNumberPrefix(java.lang.String value) Set prefix pattern for numbered level.
void	setNumberSufix(java.lang.String value) Sets suffix pattern for numbered level.
void	setPatternType(ListPatternType value) Sets list numbering type.
void	setStartAt(int value) Set start at value.
void	setTabSpaceAfter(float value) Set spacing after list level's number or bullet ( tab position if follow character is tab ).
void	setTextPosition(float value) Setsleft listlevel indent
void	setUsePrevLevelPattern(boolean value) When true, number generated will include previous levels (used for legal numbering).

Methods inherited from class com.spire.doc.OwnerHolder

getDocument

Constructor Detail

ListLevel

public ListLevel(ListStyle listStyle)

Initializes a new instance of the ListLevel class

Parameters:

listStyle -

Method Detail

getNumberAlignment

public ListNumberAlignment getNumberAlignment()

Get alignment (left, right, or centered) of the paragraph number.

Returns:

ListNumberAlignment

setNumberAlignment

public void setNumberAlignment(ListNumberAlignment value)

Set alignment (left, right, or centered) of the paragraph number.

Parameters:

value - ListNumberAlignment

getStartAt

public int getStartAt()

Get start at value.

Returns:

int

setStartAt

public void setStartAt(int value)

Set start at value.

Parameters:

value - int

getTabSpaceAfter

public float getTabSpaceAfter()

Get spacing after list level's number or bullet ( tab position if follow character is tab ).

Returns:

float

setTabSpaceAfter

public void setTabSpaceAfter(float value)

Set spacing after list level's number or bullet ( tab position if follow character is tab ).

Parameters:

value - float

getTextPosition

public float getTextPosition()

Returns listlevel indent

Returns:

float

setTextPosition

public void setTextPosition(float value)

Setsleft listlevel indent

Parameters:

value - float

getNumberPrefix

public java.lang.String getNumberPrefix()

Get prefix pattern for numbered level.

Returns:

String

setNumberPrefix

public void setNumberPrefix(java.lang.String value)

Set prefix pattern for numbered level.

Parameters:

value - String

getNumberSufix

public java.lang.String getNumberSufix()

Returns suffix pattern for numbered level.

Returns:

the numbersubffix

setNumberSufix

public void setNumberSufix(java.lang.String value)

Sets suffix pattern for numbered level.

Parameters:

value - String

getBulletCharacter

public java.lang.String getBulletCharacter()

Get bullet pattern

Returns:

String

setBulletCharacter

public void setBulletCharacter(java.lang.String value)

Set bullet pattern

Parameters:

value -

getPatternType

public ListPatternType getPatternType()

Returns list numbering type.

Returns:

ListPatternType

setPatternType

public void setPatternType(ListPatternType value)

Sets list numbering type.

Parameters:

value - ListPatternType

getNoRestartByHigher

public boolean getNoRestartByHigher()

True if the level's number sequence is not restarted by higher (more significant) levels in the list.

Returns:

boolean

setNoRestartByHigher

public void setNoRestartByHigher(boolean value)

True if the level's number sequence is not restarted by higher (more significant) levels in the list.

Parameters:

value - boolean

getCharacterFormat

public CharacterFormat getCharacterFormat()

Returns character formats of list symbol.

Returns:

CharacterFormat

getParagraphFormat

public ParagraphFormat getParagraphFormat()

Returns paragraph format of list level.

Returns:

ParagraphFormat

getFollowCharacter

public FollowCharacterType getFollowCharacter()

Get the type of character following the number text for the paragraph.

Returns:

FollowCharacterType

setFollowCharacter

public void setFollowCharacter(FollowCharacterType value)

Set the type of character following the number text for the paragraph.

Parameters:

value - FollowCharacterType

isLegalStyleNumbering

public boolean isLegalStyleNumbering()

Get ArabaicNumberFormat property ( true if the level turns all inherited numbers to arabic, false if it preserves their number format code ).

Returns:

boolean

isLegalStyleNumbering

public void isLegalStyleNumbering(boolean value)

Set ArabaicNumberFormat property ( true if the level turns all inherited numbers to arabic, false if it preserves their number format code ).

Parameters:

value - boolean

getNumberPosition

public float getNumberPosition()

Get number/bullet position for current listlevel.

Returns:

float

setNumberPosition

public void setNumberPosition(float value)

Set number/bullet position for current listlevel.

Parameters:

value - float

getUsePrevLevelPattern

public boolean getUsePrevLevelPattern()

When true, number generated will include previous levels (used for legal numbering).

Returns:

boolean

setUsePrevLevelPattern

public void setUsePrevLevelPattern(boolean value)

When true, number generated will include previous levels (used for legal numbering).

Parameters:

value - boolean

createLayoutData

public void createLayoutData(java.lang.String numStr,
                             byte[] characterOffsets,
                             int levelNumber)

Create level layout data

Parameters:

numStr - numStr

characterOffsets - characterOffsets

levelNumber - levelNumber

getListItemText

public java.lang.String getListItemText(int listItemIndex,
                                        ListType listType)

Gets list symbol for specified item index

Parameters:

listItemIndex - listItemIndex

listType - listType

Returns:

string

deepClone

public ListLevel deepClone()

Clones this instance.

Returns:

ListLevel