ListLevel (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.ListLevel

All Implemented Interfaces:

java.lang.Cloneable
```
public class ListLevel
extends java.lang.Object
implements java.lang.Cloneable
```
Defines formatting for a list level.
You do not create objects of this class. List level objects are created automatically when a list is created. You access ListLevel objects via the ListLevelCollection collection.

Use the properties of ListLevel to specify list formatting for individual list levels.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearRunAttrs()`
`void`	`createPictureBullet()` Creates picture bullet shape for the current list level.
`void`	`deletePictureBullet()` Deletes picture bullet for the current list level.
`boolean`	`equals(ListLevel level)` Compares with the specified ListLevel.
`java.lang.Object`	`fetchInheritedRunAttr(int key)`
`int`	`getAlignment()` Gets the justification of the actual number of the list item.
`java.lang.String`	`getCustomNumberStyleFormat()` Gets the custom number style format for this list level.
`java.lang.Object`	`getDirectRunAttr(int key)`
`static java.lang.String`	`getEffectiveValue(int index, int numberStyle, java.lang.String customNumberStyleFormat)`
`Font`	`getFont()` Specifies character formatting used for the list label.
`ImageData`	`getImageData()` Returns image data of the picture bullet shape for the current list level.
`Style`	`getLinkedStyle()` Gets the paragraph style that is linked to this list level.
`java.lang.String`	`getNumberFormat()` Gets the number format for the list level.
`double`	`getNumberPosition()` Gets the position (in points) of the number or bullet for the list level.
`int`	`getNumberStyle()` Gets the number style for this list level.
`int`	`getRestartAfterLevel()` Gets the list level that must appear before the specified list level restarts numbering.
`int`	`getStartAt()` Gets the starting number for this list level.
`double`	`getTabPosition()` Gets the tab position (in points) for the list level.
`double`	`getTextPosition()` Gets the position (in points) for the second line of wrapping text for the list level.
`int`	`getTrailingCharacter()` Gets the character inserted after the number for the list level.
`int`	`hashCode()`
`boolean`	`isLegal()` True if the level turns all inherited numbers to Arabic, false if it preserves their number style.
`void`	`isLegal(boolean value)` True if the level turns all inherited numbers to Arabic, false if it preserves their number style.
`protected java.lang.Object`	`memberwiseClone()`
`void`	`removeRunAttr(int key)`
`void`	`setAlignment(int value)` Sets the justification of the actual number of the list item.
`void`	`setLinkedStyle(Style value)` Sets the paragraph style that is linked to this list level.
`void`	`setNumberFormat(java.lang.String value)` Sets the number format for the list level.
`void`	`setNumberPosition(double value)` Sets the position (in points) of the number or bullet for the list level.
`void`	`setNumberStyle(int value)` Sets the number style for this list level.
`void`	`setRestartAfterLevel(int value)` Sets the list level that must appear before the specified list level restarts numbering.
`void`	`setRunAttr(int key, java.lang.Object value)`
`void`	`setStartAt(int value)` Sets the starting number for this list level.
`void`	`setTabPosition(double value)` Sets the tab position (in points) for the list level.
`void`	`setTextPosition(double value)` Sets the position (in points) for the second line of wrapping text for the list level.
`void`	`setTrailingCharacter(int value)` Sets the character inserted after the number for the list level.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createPictureBullet
```
public void createPictureBullet()
                         throws java.lang.Exception
```
    Creates picture bullet shape for the current list level. Please note, NumberStyle will be set to Bullet and NumberFormat to "\xF0B7" to properly display picture bullet. Red cross image will be set as picture bullet image upon creating. To change it please use getImageData().
    
    Throws:
    
    java.lang.Exception
  - deletePictureBullet
```
public void deletePictureBullet()
```
    Deletes picture bullet for the current list level. Default bullet will be shown after deleting.
  - getEffectiveValue
```
public static java.lang.String getEffectiveValue(int index,
                                                 int numberStyle,
                                                 java.lang.String customNumberStyleFormat)
```
  - equals
```
public boolean equals(ListLevel level)
```
    Compares with the specified ListLevel.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getStartAt
```
public int getStartAt()
```
    Gets the starting number for this list level.
    Default value is 1.
    
    Returns:
    
    The starting number for this list level.
  - setStartAt
```
public void setStartAt(int value)
```
    Sets the starting number for this list level.
    Default value is 1.
    
    Parameters:
    
    value - The starting number for this list level.
  - getNumberStyle
```
public int getNumberStyle()
```
    Gets the number style for this list level.
    
    Returns:
    
    The number style for this list level. The returned value is one of NumberStyle constants.
  - setNumberStyle
```
public void setNumberStyle(int value)
```
    Sets the number style for this list level.
    
    Parameters:
    
    value - The number style for this list level. The value must be one of NumberStyle constants.
  - getCustomNumberStyleFormat
```
public java.lang.String getCustomNumberStyleFormat()
```
    Gets the custom number style format for this list level. For example: "a, ç, ĝ, ...".
    
    Returns:
    
    The custom number style format for this list level.
  - getNumberFormat
```
public java.lang.String getNumberFormat()
```
    Gets the number format for the list level.
    Among normal text characters, the string can contain placeholder characters \x0000 to \x0008 representing the numbers from the corresponding list levels.
    
    For example, the string "\x0000.\x0001)" will generate a list label that looks something like "1.5)". The number "1" is the current number from the 1st list level, the number "5" is the current number from the 2nd list level.
    
    Null is not allowed, but an empty string meaning no number is valid.
    
    Returns:
    
    The number format for the list level.
  - setNumberFormat
```
public void setNumberFormat(java.lang.String value)
```
    Sets the number format for the list level.
    Among normal text characters, the string can contain placeholder characters \x0000 to \x0008 representing the numbers from the corresponding list levels.
    
    For example, the string "\x0000.\x0001)" will generate a list label that looks something like "1.5)". The number "1" is the current number from the 1st list level, the number "5" is the current number from the 2nd list level.
    
    Null is not allowed, but an empty string meaning no number is valid.
    
    Parameters:
    
    value - The number format for the list level.
  - getAlignment
```
public int getAlignment()
```
    Gets the justification of the actual number of the list item.
    The list label is justified relative to the getNumberPosition() / setNumberPosition(double) property.
    
    Returns:
    
    The justification of the actual number of the list item. The returned value is one of ListLevelAlignment constants.
  - setAlignment
```
public void setAlignment(int value)
```
    Sets the justification of the actual number of the list item.
    The list label is justified relative to the getNumberPosition() / setNumberPosition(double) property.
    
    Parameters:
    
    value - The justification of the actual number of the list item. The value must be one of ListLevelAlignment constants.
  - isLegal
```
public boolean isLegal()
```
    True if the level turns all inherited numbers to Arabic, false if it preserves their number style.
    
    Returns:
    
    The corresponding boolean value.
  - isLegal
```
public void isLegal(boolean value)
```
    True if the level turns all inherited numbers to Arabic, false if it preserves their number style.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getRestartAfterLevel
```
public int getRestartAfterLevel()
```
    Gets the list level that must appear before the specified list level restarts numbering.
    The value of -1 means the numbering will continue.
    
    Returns:
    
    The list level that must appear before the specified list level restarts numbering.
  - setRestartAfterLevel
```
public void setRestartAfterLevel(int value)
```
    Sets the list level that must appear before the specified list level restarts numbering.
    The value of -1 means the numbering will continue.
    
    Parameters:
    
    value - The list level that must appear before the specified list level restarts numbering.
  - getTrailingCharacter
```
public int getTrailingCharacter()
```
    Gets the character inserted after the number for the list level.
    
    Returns:
    
    The character inserted after the number for the list level. The returned value is one of ListTrailingCharacter constants.
  - setTrailingCharacter
```
public void setTrailingCharacter(int value)
```
    Sets the character inserted after the number for the list level.
    
    Parameters:
    
    value - The character inserted after the number for the list level. The value must be one of ListTrailingCharacter constants.
  - getFont
```
public Font getFont()
```
    Specifies character formatting used for the list label.
    
    Returns:
    
    The corresponding Font value.
  - getTabPosition
```
public double getTabPosition()
```
    Gets the tab position (in points) for the list level.
    Has effect only when getTrailingCharacter() / setTrailingCharacter(int) is a tab.
    
    Returns:
    
    The tab position (in points) for the list level.
    
    See Also:
    
    getNumberPosition(), setNumberPosition(double), getTextPosition(), setTextPosition(double)
  - setTabPosition
```
public void setTabPosition(double value)
```
    Sets the tab position (in points) for the list level.
    Has effect only when getTrailingCharacter() / setTrailingCharacter(int) is a tab.
    
    Parameters:
    
    value - The tab position (in points) for the list level.
    
    See Also:
    
    getNumberPosition(), setNumberPosition(double), getTextPosition(), setTextPosition(double)
  - getNumberPosition
```
public double getNumberPosition()
```
    Gets the position (in points) of the number or bullet for the list level.
    getNumberPosition() / setNumberPosition(double) corresponds to LeftIndent plus FirstLineIndent of the paragraph.
    
    Returns:
    
    The position (in points) of the number or bullet for the list level.
    
    See Also:
    
    getTextPosition(), setTextPosition(double), getTabPosition(), setTabPosition(double)
  - setNumberPosition
```
public void setNumberPosition(double value)
```
    Sets the position (in points) of the number or bullet for the list level.
    getNumberPosition() / setNumberPosition(double) corresponds to LeftIndent plus FirstLineIndent of the paragraph.
    
    Parameters:
    
    value - The position (in points) of the number or bullet for the list level.
    
    See Also:
    
    getTextPosition(), setTextPosition(double), getTabPosition(), setTabPosition(double)
  - getTextPosition
```
public double getTextPosition()
```
    Gets the position (in points) for the second line of wrapping text for the list level.
    getTextPosition() / setTextPosition(double) corresponds to LeftIndent of the paragraph.
    
    Returns:
    
    The position (in points) for the second line of wrapping text for the list level.
    
    See Also:
    
    getNumberPosition(), setNumberPosition(double), getTabPosition(), setTabPosition(double)
  - setTextPosition
```
public void setTextPosition(double value)
```
    Sets the position (in points) for the second line of wrapping text for the list level.
    getTextPosition() / setTextPosition(double) corresponds to LeftIndent of the paragraph.
    
    Parameters:
    
    value - The position (in points) for the second line of wrapping text for the list level.
    
    See Also:
    
    getNumberPosition(), setNumberPosition(double), getTabPosition(), setTabPosition(double)
  - getLinkedStyle
```
public Style getLinkedStyle()
```
    Gets the paragraph style that is linked to this list level.
    This property is null when the list level is not linked to a paragraph style. This property can be set to null.
    
    Returns:
    
    The paragraph style that is linked to this list level.
  - setLinkedStyle
```
public void setLinkedStyle(Style value)
```
    Sets the paragraph style that is linked to this list level.
    This property is null when the list level is not linked to a paragraph style. This property can be set to null.
    
    Parameters:
    
    value - The paragraph style that is linked to this list level.
  - getImageData
```
public ImageData getImageData()
```
    Returns image data of the picture bullet shape for the current list level. If this level doesn't define picture bullet returns null. Before setting new image for non picture bullet shape, please use createPictureBullet() method first.
    
    Returns:
    
    Image data of the picture bullet shape for the current list level.
  - getDirectRunAttr
```
public java.lang.Object getDirectRunAttr(int key)
```
  - fetchInheritedRunAttr
```
public java.lang.Object fetchInheritedRunAttr(int key)
```
  - setRunAttr
```
public void setRunAttr(int key,
                       java.lang.Object value)
```
  - removeRunAttr
```
public void removeRunAttr(int key)
```
  - clearRunAttrs
```
public void clearRunAttrs()
```
  - memberwiseClone
```
protected java.lang.Object memberwiseClone()
```

Class ListLevel

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createPictureBullet

deletePictureBullet

getEffectiveValue

equals

hashCode

getStartAt

setStartAt

getNumberStyle

setNumberStyle

getCustomNumberStyleFormat

getNumberFormat

setNumberFormat

getAlignment

setAlignment

isLegal

isLegal

getRestartAfterLevel

setRestartAfterLevel

getTrailingCharacter

setTrailingCharacter

getFont

getTabPosition

setTabPosition

getNumberPosition

setNumberPosition

getTextPosition

setTextPosition

getLinkedStyle

setLinkedStyle

getImageData

getDirectRunAttr

fetchInheritedRunAttr

setRunAttr

removeRunAttr

clearRunAttrs

memberwiseClone