org.odftoolkit.simple.text.list

Interface ListDecorator

All Known Implementing Classes:

BulletDecorator, BulletDecoratorBase, DiscDecorator, ImageDecorator, NumberDecorator, NumberDecoratorBase, NumberedAlphaLowerDecorator, NumberedAlphaUpperDecorator, NumberedGreekLowerDecorator, NumberedRomanLowerDecorator, NumberedRomanUpperDecorator, OutLineDecorator, SquareDecorator

public interface ListDecorator

ListDecorator is a decorator which decides how to decorate a List and its ListItems.

Every list, including sub lists, may have a list style which is applied to its list items and sub lists. ListDecorator holds this style and decides the appearance of a list. List style is applied by invoking decorateList(List), while list item style is applied by invoking decorateListItem(ListItem).

A ListDecorator specified for a sub list overrides the ListDecorator specified for the list in which the sub list is contained.

Since:

0.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ListDecorator.ListType The supported list types till now.

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.

Method Detail

decorateList

void decorateList(List list)

Decorate the specifies list, of which style is set.

Parameters:

list - the List is decorated.

decorateListItem

void decorateListItem(ListItem item)

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

Parameters:

item - the ListItem is decorated.

getListType

ListDecorator.ListType getListType()

Get the ListType of this ListDecorator.

Returns:

the ListType of this ListDecorator.