com.spire.doc.documents
Class ListLevel

java.lang.Object
  extended by com.spire.doc.OwnerHolder
      extended by com.spire.doc.documents.xml.DocumentSerializable
          extended by com.spire.doc.documents.ListLevel
All Implemented Interfaces:
IDocumentSerializable

public class ListLevel
extends DocumentSerializable

Summary description for WListLevel.


Constructor Summary
ListLevel(ListStyle listStyle)
           
 
Method Summary
 ListLevel deepClone()
          Clones this instance.
 java.lang.String getBulletCharacter()
          Get/set bullet pattern
 CharacterFormat getCharacterFormat()
          Gets character format of list symbol.
 FollowCharacterType getFollowCharacter()
          Gets or Sets 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/set alignment (left, right, or centered) of the paragraph number.
 float getNumberPosition()
          Get/set number/bullet position for current listlevel.
 java.lang.String getNumberPrefix()
          Gets / set prefix pattern for numbered level.
 java.lang.String getNumberSufix()
          Gets or sets suffix pattern for numbered level.
 ParagraphFormat getParagraphFormat()
          Gets paragraph format of list level.
 ListPatternType getPatternType()
          Gets or sets list numbering type.
 int getStartAt()
          Get/set start at value.
 float getTabSpaceAfter()
          Get/set spacing after list level's number or bullet ( tab position if follow character is tab ).
 float getTextPosition()
          Returns or sets left listlevel indent
 boolean getUsePrevLevelPattern()
          When true, number generated will include previous levels (used for legal numbering).
 boolean isLegalStyleNumbering()
          Get/set ArabaicNumberFormat property ( true if the level turns all inherited numbers to arabic, false if it preserves their number format code ).
 void isLegalStyleNumbering(boolean value)
          Get/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)
          Get/set bullet pattern
 void setFollowCharacter(FollowCharacterType value)
          Gets or Sets 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)
          Get/set alignment (left, right, or centered) of the paragraph number.
 void setNumberPosition(float value)
          Get/set number/bullet position for current listlevel.
 void setNumberPrefix(java.lang.String value)
          Gets / set prefix pattern for numbered level.
 void setNumberSufix(java.lang.String value)
          Gets or sets suffix pattern for numbered level.
 void setPatternType(ListPatternType value)
          Gets or sets list numbering type.
 void setStartAt(int value)
          Get/set start at value.
 void setTabSpaceAfter(float value)
          Get/set spacing after list level's number or bullet ( tab position if follow character is tab ).
 void setTextPosition(float value)
          Returns or sets left 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)
Parameters:
listStyle -
Method Detail

getNumberAlignment

public ListNumberAlignment getNumberAlignment()
Get/set alignment (left, right, or centered) of the paragraph number.


setNumberAlignment

public void setNumberAlignment(ListNumberAlignment value)
Get/set alignment (left, right, or centered) of the paragraph number.


getStartAt

public int getStartAt()
Get/set start at value.


setStartAt

public void setStartAt(int value)
Get/set start at value.


getTabSpaceAfter

public float getTabSpaceAfter()
Get/set spacing after list level's number or bullet ( tab position if follow character is tab ).


setTabSpaceAfter

public void setTabSpaceAfter(float value)
Get/set spacing after list level's number or bullet ( tab position if follow character is tab ).


getTextPosition

public float getTextPosition()
Returns or sets left listlevel indent


setTextPosition

public void setTextPosition(float value)
Returns or sets left listlevel indent


getNumberPrefix

public java.lang.String getNumberPrefix()
Gets / set prefix pattern for numbered level.


setNumberPrefix

public void setNumberPrefix(java.lang.String value)
Gets / set prefix pattern for numbered level.


getNumberSufix

public java.lang.String getNumberSufix()
Gets or sets suffix pattern for numbered level.


setNumberSufix

public void setNumberSufix(java.lang.String value)
Gets or sets suffix pattern for numbered level.


getBulletCharacter

public java.lang.String getBulletCharacter()
Get/set bullet pattern


setBulletCharacter

public void setBulletCharacter(java.lang.String value)
Get/set bullet pattern


getPatternType

public ListPatternType getPatternType()
Gets or sets list numbering type.


setPatternType

public void setPatternType(ListPatternType value)
Gets or sets list numbering type.


getNoRestartByHigher

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


setNoRestartByHigher

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


getCharacterFormat

public CharacterFormat getCharacterFormat()
Gets character format of list symbol.


getParagraphFormat

public ParagraphFormat getParagraphFormat()
Gets paragraph format of list level.


getFollowCharacter

public FollowCharacterType getFollowCharacter()
Gets or Sets the type of character following the number text for the paragraph.


setFollowCharacter

public void setFollowCharacter(FollowCharacterType value)
Gets or Sets the type of character following the number text for the paragraph.


isLegalStyleNumbering

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


isLegalStyleNumbering

public void isLegalStyleNumbering(boolean value)
Get/set ArabaicNumberFormat property ( true if the level turns all inherited numbers to arabic, false if it preserves their number format code ).


getNumberPosition

public float getNumberPosition()
Get/set number/bullet position for current listlevel.


setNumberPosition

public void setNumberPosition(float value)
Get/set number/bullet position for current listlevel.


getUsePrevLevelPattern

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


setUsePrevLevelPattern

public void setUsePrevLevelPattern(boolean value)
When true, number generated will include previous levels (used for legal numbering).


getListItemText

public java.lang.String getListItemText(int listItemIndex,
                                        ListType listType)
Gets list symbol for specified item index

Parameters:
listItemIndex -
Returns:

deepClone

public ListLevel deepClone()
Clones this instance.

Returns: