Package com.lowagie.text.rtf.list
Class RtfList
java.lang.Object
com.lowagie.text.rtf.RtfElement
com.lowagie.text.rtf.list.RtfList
- All Implemented Interfaces:
RtfBasicElement
,RtfExtendedElement
,com.lowagie.text.RtfElementInterface
The RtfList stores one List. It also provides the methods to write the
list declaration and the list data.
- Since:
- 2.1.3
- Version:
- $Id: RtfList.java 4065 2009-09-16 23:09:11Z psoares33 $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List
<RtfBasicElement> The subitems of this RtfListprivate static final byte[]
Constant for the listprivate static final byte[]
Constant for the hybrid liststatic final byte[]
Constant for the list idstatic final byte[]
Constant for the list level valueprivate static final byte[]
Constant for the name of this liststatic final byte[]
Constant for the list numberstatic final byte[]
Constant for the old list number endprivate static final byte[]
Constant to indicate if the list restarts at each section.private static final byte[]
Constant for the simple listprivate static final byte[]
Constant for the identifier of the style of this list.private static final byte[]
Constant for the identifier of the style of this list.private static final byte[]
Constant for the list template idstatic final byte[]
Constant for the old list textstatic final int
List type of listhybridstatic final int
List type of NORMAL - no control wordstatic final int
List type of listsimpleprivate int
The list idprivate final List
<RtfListLevel> The RtfList lists managed by this RtfListTableprivate int
The list number of this RtfListprivate int
This RtfList typeprivate String
The name of the list if it existsprivate RtfList
The parent list if there is one.static final byte[]
Constant for a tab characterFields inherited from class com.lowagie.text.rtf.RtfElement
document, inHeader, inTable
Fields inherited from interface com.lowagie.text.rtf.RtfBasicElement
CLOSE_GROUP, COMMA_DELIMITER, DELIMITER, OPEN_GROUP, TWIPS_FACTOR
-
Constructor Summary
ConstructorsConstructorDescriptionRtfList()
Constructs an empty RtfList object.RtfList
(RtfDocument doc) Constructs an empty RtfList object.RtfList
(RtfDocument doc, com.lowagie.text.List list) Constructs a new RtfList for the specified List. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Correct the indentation of this RtfList by adding left/first line indentation from the parent RtfList.protected void
Create a default set of listlevelsint
getID()
Get the list ID numbergetListLevel
(int index) int
Gets the id of this listint
getName()
void
setDocument
(RtfDocument doc) Set the document.void
setID
(int id) Set the list ID numbervoid
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 listvoid
setListType
(int listType) void
void
setParentList
(RtfList parentList) void
writeContent
(OutputStream result) Writes the content of the RtfListvoid
writeDefinition
(OutputStream result) Writes the definition part of this list levelprotected void
writeListNumbers
(OutputStream result) Writes only the list number and list level number.protected void
writeListTextBlock
(OutputStream result, int itemNr, RtfListLevel listLevel) Methods inherited from class com.lowagie.text.rtf.RtfElement
intToByteArray, isInTable, setRtfDocument
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.lowagie.text.rtf.RtfBasicElement
setRtfDocument
-
Field Details
-
LIST_NUMBER
public static final byte[] LIST_NUMBERConstant for the list number- Since:
- 2.1.3
-
LIST
private static final byte[] LISTConstant for the list -
LIST_ID
public static final byte[] LIST_IDConstant for the list id- Since:
- 2.1.3
-
LIST_TEMPLATE_ID
private static final byte[] LIST_TEMPLATE_IDConstant for the list template id -
LIST_SIMPLE
private static final byte[] LIST_SIMPLEConstant for the simple list -
LIST_HYBRID
private static final byte[] LIST_HYBRIDConstant for the hybrid list -
LIST_RESTARTHDN
private static final byte[] LIST_RESTARTHDNConstant to indicate if the list restarts at each section. Word 7 compatiblity -
LIST_NAME
private static final byte[] LIST_NAMEConstant for the name of this list -
LIST_STYLEID
private static final byte[] LIST_STYLEIDConstant for the identifier of the style of this list. Mutually exclusive with \\liststylename -
LIST_STYLENAME
private static final byte[] LIST_STYLENAMEConstant for the identifier of the style of this list. Mutually exclusive with \\liststyleid -
LIST_LEVEL_NUMBER
public static final byte[] LIST_LEVEL_NUMBERConstant for the list level value- Since:
- 2.1.3
-
LIST_TEXT
public static final byte[] LIST_TEXTConstant for the old list text- Since:
- 2.1.3
-
LIST_NUMBER_END
public static final byte[] LIST_NUMBER_ENDConstant for the old list number end- Since:
- 2.1.3
-
TAB
public static final byte[] TABConstant for a tab character- Since:
- 2.1.3
-
items
The subitems of this RtfList -
parentList
The parent list if there is one. -
listID
private int listIDThe list id -
LIST_TYPE_NORMAL
public static final int LIST_TYPE_NORMALList type of NORMAL - no control word- Since:
- 2.1.3
- See Also:
-
LIST_TYPE_SIMPLE
public static final int LIST_TYPE_SIMPLEList type of listsimple- Since:
- 2.1.3
- See Also:
-
LIST_TYPE_HYBRID
public static final int LIST_TYPE_HYBRIDList type of listhybrid- Since:
- 2.1.3
- See Also:
-
listType
private int listTypeThis RtfList type -
name
The name of the list if it exists -
listNumber
private int listNumberThe list number of this RtfList -
listLevels
The RtfList lists managed by this RtfListTable
-
-
Constructor Details
-
RtfList
public RtfList()Constructs an empty RtfList object.- Since:
- 2.1.3
-
RtfList
Constructs an empty RtfList object.- Parameters:
doc
- The RtfDocument this RtfList belongs to- Since:
- 2.1.3
-
RtfList
Constructs a new RtfList for the specified List.- Parameters:
doc
- The RtfDocument this RtfList belongs tolist
- The List this RtfList is based on- Since:
- 2.1.3
-
-
Method Details
-
setDocument
Set the document.- Parameters:
doc
- The RtfDocument- Since:
- 2.1.3
-
writeDefinition
Writes the definition part of this list level- Specified by:
writeDefinition
in interfaceRtfExtendedElement
- Parameters:
result
-- Throws:
IOException
- Since:
- 2.1.3
-
writeContent
Writes the content of the RtfList- Specified by:
writeContent
in interfaceRtfBasicElement
- Specified by:
writeContent
in classRtfElement
- Parameters:
result
- TheOutputStream
to write the content to- Throws:
IOException
- Since:
- 2.1.3
-
writeListTextBlock
protected void writeListTextBlock(OutputStream result, int itemNr, RtfListLevel listLevel) throws IOException - Parameters:
result
-itemNr
-listLevel
-- Throws:
IOException
- Since:
- 2.1.3
-
writeListNumbers
Writes only the list number and list level number.- Parameters:
result
- TheOutputStream
to write to- Throws:
IOException
- On i/o errors.- Since:
- 2.1.3
-
createDefaultLevels
protected void createDefaultLevels()Create a default set of listlevels- Since:
- 2.1.3
-
getListNumber
public int getListNumber()Gets the id of this list- Returns:
- Returns the list number.
- Since:
- 2.1.3
-
setListNumber
public void setListNumber(int listNumber) Sets the id of this list- Parameters:
listNumber
- The list number to set.- Since:
- 2.1.3
-
setInTable
public void setInTable(boolean inTable) Sets whether this RtfList is in a table. Sets the correct inTable setting for all child elements.- Specified by:
setInTable
in interfaceRtfBasicElement
- Overrides:
setInTable
in classRtfElement
- Parameters:
inTable
-True
if this RtfList is in a table,false
otherwise- Since:
- 2.1.3
-
setInHeader
public void setInHeader(boolean inHeader) Sets whether this RtfList is in a header. Sets the correct inTable setting for all child elements.- Specified by:
setInHeader
in interfaceRtfBasicElement
- Overrides:
setInHeader
in classRtfElement
- Parameters:
inHeader
-True
if this RtfList is in a header,false
otherwise- Since:
- 2.1.3
-
correctIndentation
protected void correctIndentation()Correct the indentation of this RtfList by adding left/first line indentation from the parent RtfList. Also calls correctIndentation on all child RtfLists.- Since:
- 2.1.3
-
setID
public void setID(int id) Set the list ID number- Parameters:
id
-- Since:
- 2.1.3
-
getID
public int getID()Get the list ID number- Returns:
- this list id
- Since:
- 2.1.3
-
getListType
public int getListType()- Returns:
- the listType
- Since:
- 2.1.3
- See Also:
-
setListType
- Parameters:
listType
- the listType to set- Throws:
InvalidParameterException
- Since:
- 2.1.3
- See Also:
-
getParentList
- Returns:
- the parentList
- Since:
- 2.1.3
-
setParentList
- Parameters:
parentList
- the parentList to set- Since:
- 2.1.3
-
getName
- Returns:
- the name
- Since:
- 2.1.3
-
setName
- Parameters:
name
- the name to set- Since:
- 2.1.3
-
getListLevel
- Returns:
- the list at the index
- Since:
- 2.1.3
-