public class Range
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected java.util.List<CHPX> |
_characters
All CharacterRuns that belong to the document this Range belongs to.
|
protected int |
_charEnd
The end index in the characterRuns list for this Range.
|
protected boolean |
_charRangeFound
Have we loaded the characterRun indexes yet.
|
protected int |
_charStart
The start index in the characterRuns list for this Range
|
protected HWPFDocumentCore |
_doc
The document this range belongs to.
|
protected int |
_end
The ending character offset of this range.
|
protected java.util.List<PAPX> |
_paragraphs
All paragraphs that belong to the document this Range belongs to.
|
protected int |
_parEnd
The end index in the paragraphs list for this Range, exclusive
|
protected boolean |
_parRangeFound
Have we loaded the paragraph indexes yet.
|
protected int |
_parStart
The start index in the paragraphs list for this Range, inclusive
|
protected int |
_sectionEnd
The end index in the sections list for this Range.
|
protected java.util.List<SEPX> |
_sections
All sections that belong to the document this Range belongs to.
|
protected int |
_sectionStart
The start index in the sections list for this Range
|
protected int |
_start
The starting character offset of this range.
|
protected java.lang.StringBuilder |
_text |
static int |
TYPE_CHARACTER
Deprecated.
POI 3.8 beta 5
|
static int |
TYPE_LISTENTRY
Deprecated.
POI 3.8 beta 5
|
static int |
TYPE_PARAGRAPH
Deprecated.
POI 3.8 beta 5
|
static int |
TYPE_SECTION
Deprecated.
POI 3.8 beta 5
|
static int |
TYPE_TABLE
Deprecated.
POI 3.8 beta 5
|
static int |
TYPE_TEXT
Deprecated.
POI 3.8 beta 5
|
static int |
TYPE_UNDEFINED
Deprecated.
POI 3.8 beta 5
|
Modifier | Constructor and Description |
---|---|
|
Range(int start,
int end,
HWPFDocumentCore doc)
Used to construct a Range from a document.
|
protected |
Range(int start,
int end,
Range parent)
Used to create Ranges that are children of other Ranges.
|
protected |
Range(Range other) |
Modifier and Type | Method and Description |
---|---|
protected void |
adjustFIB(int adjustment)
Adjust the value of the various FIB character count fields, eg
FIB.CCPText after an insert or a delete... |
void |
delete() |
CharacterRun |
getCharacterRun(int index)
Gets the character run at index.
|
protected HWPFDocumentCore |
getDocument() |
int |
getEndOffset() |
Paragraph |
getParagraph(int index)
Gets the paragraph at index.
|
Section |
getSection(int index)
Gets the section at index.
|
int |
getStartOffset() |
Table |
getTable(Paragraph paragraph)
Gets the table that starts with paragraph.
|
protected void |
initAll()
loads all of the list indexes.
|
CharacterRun |
insertAfter(java.lang.String text)
Inserts text onto the end of this range
|
CharacterRun |
insertBefore(java.lang.String text)
Inserts text into the front of this range.
|
Table |
insertTableBefore(short columns,
int rows)
Inserts a simple table into the beginning of this range.
|
int |
numCharacterRuns() |
int |
numParagraphs()
Used to get the number of paragraphs in a range.
|
int |
numSections()
Used to get the number of sections in a range.
|
void |
replaceText(java.lang.String newText,
boolean addAfter)
Replace range text with new one, adding it to the range and deleting
original text from document
|
void |
replaceText(java.lang.String pPlaceHolder,
java.lang.String pValue)
Replace (all instances of) a piece of text with another...
|
void |
replaceText(java.lang.String pPlaceHolder,
java.lang.String pValue,
int pOffset)
Replace (one instance of) a piece of text with another...
|
protected void |
reset()
resets the list indexes.
|
boolean |
sanityCheck()
Method for debug purposes.
|
static java.lang.String |
stripFields(java.lang.String text)
Removes any fields (eg macros, page markers etc) from the string.
|
java.lang.String |
text()
Gets the text that this Range contains.
|
java.lang.String |
toString() |
@Deprecated public static final int TYPE_PARAGRAPH
@Deprecated public static final int TYPE_CHARACTER
@Deprecated public static final int TYPE_SECTION
@Deprecated public static final int TYPE_TEXT
@Deprecated public static final int TYPE_LISTENTRY
@Deprecated public static final int TYPE_TABLE
@Deprecated public static final int TYPE_UNDEFINED
protected final int _start
protected int _end
protected final HWPFDocumentCore _doc
protected final java.util.List<SEPX> _sections
protected int _sectionStart
protected int _sectionEnd
protected boolean _parRangeFound
protected final java.util.List<PAPX> _paragraphs
protected int _parStart
protected int _parEnd
protected boolean _charRangeFound
protected java.util.List<CHPX> _characters
protected int _charStart
protected int _charEnd
protected java.lang.StringBuilder _text
public Range(int start, int end, HWPFDocumentCore doc)
start
- Starting character offset of the range.end
- Ending character offset of the range.doc
- The HWPFDocument the range is based on.protected Range(int start, int end, Range parent)
start
- Starting character offset of the range.end
- Ending character offset of the range.parent
- The parent this range belongs to.protected Range(Range other)
public java.lang.String text()
public static java.lang.String stripFields(java.lang.String text)
public int numSections()
public int numParagraphs()
public int numCharacterRuns()
public CharacterRun insertBefore(java.lang.String text)
text
- The text to insertpublic CharacterRun insertAfter(java.lang.String text)
text
- The text to insertpublic void delete()
public Table insertTableBefore(short columns, int rows)
columns
- The number of columnsrows
- The number of rows.public void replaceText(java.lang.String newText, boolean addAfter)
newText
- The text to be replaced withaddAfter
- if true the text will be added at the end of current
range, otherwise to the beginning@Internal public void replaceText(java.lang.String pPlaceHolder, java.lang.String pValue, int pOffset)
pPlaceHolder
- The text to be replaced (e.g., "${organization}")pValue
- The replacement text (e.g., "Apache Software Foundation")pOffset
- The offset or index where the text to be replaced begins
(relative to/within this Range
)public void replaceText(java.lang.String pPlaceHolder, java.lang.String pValue)
pPlaceHolder
- The text to be replaced (e.g., "${organization}")pValue
- The replacement text (e.g., "Apache Software Foundation")public CharacterRun getCharacterRun(int index)
index
- The index of the character run to get.public Section getSection(int index)
index
- The index of the section to get.public Paragraph getParagraph(int index)
index
- The index of the paragraph to get.public Table getTable(Paragraph paragraph)
paragraph
- The paragraph that is the first paragraph in the table.protected void initAll()
protected void reset()
protected void adjustFIB(int adjustment)
FIB.CCPText
after an insert or a delete...
Works on all CCP fields from this range onwardsadjustment
- The (signed) value that should be added to the FIB CCP fieldspublic int getStartOffset()
public int getEndOffset()
protected HWPFDocumentCore getDocument()
public java.lang.String toString()
toString
in class java.lang.Object
public boolean sanityCheck()
IllegalArgumentException
if checks fail.Copyright 2020 The Apache Software Foundation or its licensors, as applicable.