com.aspose.words

Class List

java.lang.Object

com.aspose.words.List

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable

public class List
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable

Represents formatting of a list.

A list in a Microsoft Word document is a set of list formatting properties. Each list can have up to 9 levels and formatting properties, such as number style, start value, indent, tab position etc are defined separately for each level.

A List object always belongs to the ListCollection collection.

To create a new list, use the Add methods of the ListCollection collection.

To modify formatting of a list, use ListLevel objects found in the getListLevels() collection.

To apply or remove list formatting from a paragraph, use ListFormat.

See Also:

ListCollection, ListLevel, ListFormat

Method Summary

Modifier and Type	Method and Description
int	compareTo(List other) Compares the specified list to the current list.
boolean	equals(List list) Compares with the specified list.
boolean	equals(java.lang.Object obj)
DocumentBase	getDocument() Gets the owner document.
int	getListId() Gets the unique identifier of the list.
ListLevelCollection	getListLevels() Gets the collection of list levels for this list.
Style	getStyle() Gets the list style that this list references or defines.
int	hashCode()
boolean	hasSameTemplate(List other) Returns true if the current list and the given list are created from the same template.
boolean	isListStyleDefinition() Returns true if this list is a definition of a list style.
boolean	isListStyleReference() Returns true if this list is a reference to a list style.
boolean	isMultiLevel() Returns true when the list contains 9 levels; false when 1 level.
boolean	isRestartAtEachSection() Specifies whether list should be restarted at each section.
void	isRestartAtEachSection(boolean value) Specifies whether list should be restarted at each section.
protected java.lang.Object	memberwiseClone()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

equals

public boolean equals(List list)

Compares with the specified list.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getListId

public int getListId()

Gets the unique identifier of the list.

You do not normally need to use this property. But if you use it, you normally do so in conjunction with the ListCollection.getListByListId(int) method to find a list by its identifier.

Returns:

The unique identifier of the list.

getDocument

public DocumentBase getDocument()

Gets the owner document.

A list always has a parent document and is valid only in the context of that document.

Returns:

The owner document.

isMultiLevel

public boolean isMultiLevel()

Returns true when the list contains 9 levels; false when 1 level.

The lists that you create with Aspose.Words are always multi-level lists and contain 9 levels.

Microsoft Word 2003 and later always create multi-level lists with 9 levels. But in some documents, created with earlier versions of Microsoft Word you might encounter lists that have 1 level only.

Returns:

True when the list contains 9 levels; false when 1 level.

getListLevels

public ListLevelCollection getListLevels()

Gets the collection of list levels for this list.

Use this property to access and modify formatting individual to each level of the list.

Returns:

The collection of list levels for this list.

isRestartAtEachSection

public boolean isRestartAtEachSection()

Specifies whether list should be restarted at each section. Default value is false.

This option is supported only in RTF, DOC and DOCX document formats.

This option will be written to DOCX only if OoxmlCompliance is higher then OoxmlCompliance.ECMA_376_2006.

Returns:

The corresponding boolean value.

isRestartAtEachSection

public void isRestartAtEachSection(boolean value)

Specifies whether list should be restarted at each section. Default value is false.

This option is supported only in RTF, DOC and DOCX document formats.

This option will be written to DOCX only if OoxmlCompliance is higher then OoxmlCompliance.ECMA_376_2006.

Parameters:

value - The corresponding boolean value.

isListStyleDefinition

public boolean isListStyleDefinition()

Returns true if this list is a definition of a list style.

When this property is true, the getStyle() property returns the list style that this list defines.

By modifying properties of a list that defines a list style, you modify the properties of the list style.

A list that is a definition of a list style cannot be applied directly to paragraphs to make them numbered.

Returns:

True if this list is a definition of a list style.

See Also:

getStyle(), isListStyleReference()

isListStyleReference

public boolean isListStyleReference()

Returns true if this list is a reference to a list style.

Note, modifying properties of a list that is a reference to list style has no effect. The list formatting specified in the list style itself always takes precedence.

Returns:

True if this list is a reference to a list style.

See Also:

getStyle(), isListStyleDefinition()

getStyle

public Style getStyle()

Gets the list style that this list references or defines.

If this list is not associated with a list style, the property will return null.

A list could be a reference to a list style, in this case isListStyleReference() will be true.

A list could be a definition of a list style, in this case isListStyleDefinition() will be true. Such a list cannot be applied to paragraphs in the document directly.

Returns:

The list style that this list references or defines.

compareTo

public int compareTo(List other)

Compares the specified list to the current list.

hasSameTemplate

public boolean hasSameTemplate(List other)

Returns true if the current list and the given list are created from the same template.

memberwiseClone

protected java.lang.Object memberwiseClone()