org.odftoolkit.simple.text.list
Class ImageDecorator

java.lang.Object
  extended by org.odftoolkit.simple.text.list.ImageDecorator
All Implemented Interfaces:
ListDecorator

public class ImageDecorator
extends Object
implements ListDecorator

ImageDecorator is an implementation of the ListDecorator interface, decorates a given List as image list. Users can set an image as the list item prefix. They also can extend this class and realize their own list and list item style. For example, set a specifies list item with red color.

An ImageDecorator 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
 
Constructor Summary
ImageDecorator(Document doc, URI imageUri)
          Constructor with Document and image URI.
 
Method Summary
 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
 

Constructor Detail

ImageDecorator

public ImageDecorator(Document doc,
                      URI imageUri)
Constructor with Document and image URI.

Parameters:
doc - the Document which this ImageDecorator will be used on.
imageUri - the image location.
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.


Copyright © 2010-2011 The Apache Software Foundation. All Rights Reserved.