org.odftoolkit.simple.text.list

Class NumberDecoratorBase

java.lang.Object

org.odftoolkit.simple.text.list.NumberDecoratorBase

All Implemented Interfaces:

ListDecorator

Direct Known Subclasses:

NumberDecorator, NumberedAlphaLowerDecorator, NumberedAlphaUpperDecorator, NumberedGreekLowerDecorator, NumberedRomanLowerDecorator, NumberedRomanUpperDecorator

public abstract class NumberDecoratorBase
extends Object
implements ListDecorator

NumberDecorator is an implementation of the ListDecorator interface, decorates a given List as number list. User can extend this class and realize their own list and list item style. For example, set a specifies list item with red color.

A NumberDecorator can be reused in the same Document.

Since:

0.4

Nested Class Summary

Nested classes/interfaces inherited from interface org.odftoolkit.simple.text.list.ListDecorator

ListDecorator.ListType

Field Summary

Fields

Modifier and Type	Field and Description
protected OdfTextListStyle	listStyle
protected OdfStyle	paragraphStyle
protected OdfOfficeAutomaticStyles	styles

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NumberDecoratorBase(Document doc, String styleName, String styleNameIntern, String numberingFormat, String suffix, String prefix) Constructor with Document.

Method Summary

Modifier and Type	Method and Description
void	decorateList(List list) Decorate the specifies list, of which style is set.
void	decorateListItem(ListItem item) Decorate the specifies item in a List, of which style is set.
ListDecorator.ListType	getListType() Get the ListType of this ListDecorator.

Methods inherited from class java.lang.Object

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

Field Detail

listStyle

protected OdfTextListStyle listStyle

paragraphStyle

protected OdfStyle paragraphStyle

styles

protected OdfOfficeAutomaticStyles styles

Constructor Detail

NumberDecoratorBase

protected NumberDecoratorBase(Document doc,
                              String styleName,
                              String styleNameIntern,
                              String numberingFormat,
                              String suffix,
                              String prefix)

Constructor with Document.

Parameters:

doc - the Document which this NumberDecorator will be used on.

styleName - style name: (i.e. NumberDecorator: NumberDecorator.DEFAULT_NAME)

styleNameIntern - intern stylename (i.e. NumberDecorator: "Numbering_20_Symbols")

numberingFormat - the numbering format (i.e. NumberDecorator: "1", sonsrt "a", "A", "i", "I", ....)

suffix - suffix after the number ("." for 1., 2., ... ")" for a) b) c) etc)

prefix - prefix before the number ("(" for (a) (b) (c) etc)

Method Detail

decorateList

public void decorateList(List list)

Description copied from interface: ListDecorator

Decorate the specifies list, of which style is set.

Specified by:

decorateList in interface ListDecorator

Parameters:

list - the List is decorated.

decorateListItem

public void decorateListItem(ListItem item)

Description copied from interface: ListDecorator

Decorate the specifies item in a List, of which style is set.

Specified by:

decorateListItem in interface ListDecorator

Parameters:

item - the ListItem is decorated.

getListType

public ListDecorator.ListType getListType()

Description copied from interface: ListDecorator

Get the ListType of this ListDecorator.

Specified by:

getListType in interface ListDecorator

Returns:

the ListType of this ListDecorator.