public class RtfList extends RtfElement implements RtfExtendedElement
Modifier and Type | Field and Description |
---|---|
private java.util.ArrayList |
items
The subitems of this RtfList
|
private static byte[] |
LIST
Constant for the list
|
private static byte[] |
LIST_HYBRID
Constant for the hybrid list
|
static byte[] |
LIST_ID
Constant for the list id
|
static byte[] |
LIST_LEVEL_NUMBER
Constant for the list level value
|
private static byte[] |
LIST_NAME
Constant for the name of this list
|
static byte[] |
LIST_NUMBER
Constant for the list number
|
static byte[] |
LIST_NUMBER_END
Constant for the old list number end
|
private static byte[] |
LIST_RESTARTHDN
Constant to indicate if the list restarts at each section.
|
private static byte[] |
LIST_SIMPLE
Constant for the simple list
|
private static byte[] |
LIST_STYLEID
Constant for the identifier of the style of this list.
|
private static byte[] |
LIST_STYLENAME
Constant for the identifier of the style of this list.
|
private static byte[] |
LIST_TEMPLATE_ID
Constant for the list template id
|
static byte[] |
LIST_TEXT
Constant for the old list text
|
static int |
LIST_TYPE_HYBRID
List type of listhybrid
|
static int |
LIST_TYPE_NORMAL
List type of NORMAL - no control word
|
static int |
LIST_TYPE_SIMPLE
List type of listsimple
|
private int |
listID
The list id
|
private java.util.ArrayList |
listLevels
The RtfList lists managed by this RtfListTable
|
private int |
listNumber
The list number of this RtfList
|
private int |
listType
This RtfList type
|
private java.lang.String |
name
The name of the list if it exists
|
private RtfList |
parentList
The parent list if there is one.
|
static byte[] |
TAB
Constant for a tab character
|
document, inHeader, inTable
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
Constructor and Description |
---|
RtfList()
Constructs an empty RtfList object.
|
RtfList(RtfDocument doc)
Constructs an empty RtfList object.
|
RtfList(RtfDocument doc,
List list)
Constructs a new RtfList for the specified List.
|
Modifier and Type | Method and Description |
---|---|
protected void |
correctIndentation()
Correct the indentation of this RtfList by adding left/first line indentation
from the parent RtfList.
|
protected void |
createDefaultLevels()
Create a default set of listlevels
|
int |
getID()
Get the list ID number
|
RtfListLevel |
getListLevel(int index) |
int |
getListNumber()
Gets the id of this list
|
int |
getListType() |
java.lang.String |
getName() |
RtfList |
getParentList() |
void |
setDocument(RtfDocument doc)
Set the document.
|
void |
setID(int id)
Set the list ID number
|
void |
setInHeader(boolean inHeader)
Sets whether this RtfList is in a header.
|
void |
setInTable(boolean inTable)
Sets whether this RtfList is in a table.
|
void |
setListNumber(int listNumber)
Sets the id of this list
|
void |
setListType(int listType) |
void |
setName(java.lang.String name) |
void |
setParentList(RtfList parentList) |
void |
writeContent(java.io.OutputStream result)
Writes the content of the RtfList
|
void |
writeDefinition(java.io.OutputStream result)
Writes the definition part of this list level
|
protected void |
writeListNumbers(java.io.OutputStream result)
Writes only the list number and list level number.
|
protected void |
writeListTextBlock(java.io.OutputStream result,
int itemNr,
RtfListLevel listLevel) |
intToByteArray, isInTable, setRtfDocument
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setRtfDocument
public static final byte[] LIST_NUMBER
private static final byte[] LIST
public static final byte[] LIST_ID
private static final byte[] LIST_TEMPLATE_ID
private static final byte[] LIST_SIMPLE
private static final byte[] LIST_HYBRID
private static final byte[] LIST_RESTARTHDN
private static final byte[] LIST_NAME
private static final byte[] LIST_STYLEID
private static final byte[] LIST_STYLENAME
public static final byte[] LIST_LEVEL_NUMBER
public static final byte[] LIST_TEXT
public static final byte[] LIST_NUMBER_END
public static final byte[] TAB
private java.util.ArrayList items
private RtfList parentList
private int listID
public static final int LIST_TYPE_NORMAL
public static final int LIST_TYPE_SIMPLE
public static final int LIST_TYPE_HYBRID
private int listType
private java.lang.String name
private int listNumber
private java.util.ArrayList listLevels
public RtfList()
public RtfList(RtfDocument doc)
doc
- The RtfDocument this RtfList belongs topublic RtfList(RtfDocument doc, List list)
doc
- The RtfDocument this RtfList belongs tolist
- The List this RtfList is based onpublic void setDocument(RtfDocument doc)
doc
- The RtfDocumentpublic void writeDefinition(java.io.OutputStream result) throws java.io.IOException
writeDefinition
in interface RtfExtendedElement
result
- java.io.IOException
public void writeContent(java.io.OutputStream result) throws java.io.IOException
writeContent
in interface RtfBasicElement
writeContent
in class RtfElement
result
- The OutputStream
to write the content tojava.io.IOException
protected void writeListTextBlock(java.io.OutputStream result, int itemNr, RtfListLevel listLevel) throws java.io.IOException
result
- itemNr
- listLevel
- java.io.IOException
protected void writeListNumbers(java.io.OutputStream result) throws java.io.IOException
result
- The OutputStream
to write tojava.io.IOException
- On i/o errors.protected void createDefaultLevels()
public int getListNumber()
public void setListNumber(int listNumber)
listNumber
- The list number to set.public void setInTable(boolean inTable)
setInTable
in interface RtfBasicElement
setInTable
in class RtfElement
inTable
- True
if this RtfList is in a table, false
otherwisepublic void setInHeader(boolean inHeader)
setInHeader
in interface RtfBasicElement
setInHeader
in class RtfElement
inHeader
- True
if this RtfList is in a header, false
otherwiseprotected void correctIndentation()
public void setID(int id)
id
- public int getID()
public int getListType()
LIST_TYPE_NORMAL
,
LIST_TYPE_SIMPLE
,
LIST_TYPE_HYBRID
public void setListType(int listType) throws java.security.InvalidParameterException
listType
- the listType to setjava.security.InvalidParameterException
LIST_TYPE_NORMAL
,
LIST_TYPE_SIMPLE
,
LIST_TYPE_HYBRID
public RtfList getParentList()
public void setParentList(RtfList parentList)
parentList
- the parentList to setpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- the name to setpublic RtfListLevel getListLevel(int index)