List

Overview

List is a class in Aspose.Words FOSS for Java. Inherits from: Comparable<List>, Cloneable.

The List class models a document list, exposing its identifier, level collection, style, and methods to compare list templates or check multi‑level status.

Edition status of its 20 listed members (a property and its accessor methods are listed separately, overloads once): 20 not yet exercised by a verified example.

This class declares 14 methods for List objects in Java programs. Available methods include: compareTo, equals, getDocument, getListId, getListLevels, getStyle, hasSameTemplate, hashCode, isListStyleDefinition, isListStyleReference, isMultiLevel, isRestartAtEachSection. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: document, listId, listLevels, listStyleDefinition, listStyleReference, multiLevel, and 2 more.

Properties

NameTypeAccessDescription
listIdintReadGets the unique identifier of the list.
documentDocumentBaseReadGets the owner document.
multiLevelbooleanReadReturns true when the list contains 9 levels; false when 1 level.
listLevelsListLevelCollectionReadGets the collection of list levels for this list.
restartAtEachSectionbooleanRead/WriteSpecifies whether list should be restarted at each section.
listStyleDefinitionbooleanReadReturns true if this list is a definition of a list style.
listStyleReferencebooleanReadReturns true if this list is a reference to a list style.
styleStyleReadGets the list style that this list references or defines.

Methods

SignatureDescription
equals(list: List) → booleanCompares with the specified list.
equals(obj: Object) → booleanDetermines whether the specified object is equal in value to the current object.
hashCode() → intCalculates hash code for this list object.
getListId() → intGets the unique identifier of the list.
getDocument() → DocumentBaseGets the owner document.
isMultiLevel() → booleanReturns true when the list contains 9 levels; false when 1 level.
getListLevels() → ListLevelCollectionGets the collection of list levels for this list.
isRestartAtEachSection() → booleanSpecifies whether list should be restarted at each section.
isRestartAtEachSection(value: boolean)Calls isRestartAtEachSection(value) on this List instance.
isListStyleDefinition() → booleanReturns true if this list is a definition of a list style.
isListStyleReference() → booleanReturns true if this list is a reference to a list style.
getStyle() → StyleGets the list style that this list references or defines.
compareTo(other: List) → intCompares the specified list to the current list.
hasSameTemplate(other: List) → booleanReturns true if the current list and the given list are created from the same template.

See Also