mirror of https://github.com/apache/poi.git
Update docs with info on new code
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@387014 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
349e75e3bf
commit
60471580d7
|
@ -26,9 +26,16 @@ from both.
|
||||||
(from a <code>org.apache.poi.HSLFSlideShow</code>, which accepts a file or an input
|
(from a <code>org.apache.poi.HSLFSlideShow</code>, which accepts a file or an input
|
||||||
stream). Use <code>getSlides()</code> and <code>getNotes()</code> to get the slides and notes.
|
stream). Use <code>getSlides()</code> and <code>getNotes()</code> to get the slides and notes.
|
||||||
These can be queried to get their page ID (though they should be returned
|
These can be queried to get their page ID (though they should be returned
|
||||||
in the right order). You can also call <code>getTextRuns()</code> on these, to get their
|
in the right order).</p>
|
||||||
blocks of text. From the <code>TextRun</code>, you can extract the text, and check
|
<p>You can then call <code>getTextRuns()</code> on these, to get
|
||||||
what type of text it is (eg Body, Title)
|
their blocks of text. (One TextRun normally holds all the text in a
|
||||||
|
given area of the page, eg in the title bar, or in a box).
|
||||||
|
From the <code>TextRun</code>, you can extract the text, and check
|
||||||
|
what type of text it is (eg Body, Title). You can allso call
|
||||||
|
<code>getRichTextRuns()</code>, which will return the
|
||||||
|
<code>RichTextRun</code>s that make up the <code>TextRun</code>. A
|
||||||
|
<code>RichTextRun</code> is made up of a sequence of text, all having the
|
||||||
|
same character and paragraph formatting.
|
||||||
</p>
|
</p>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
@ -53,11 +60,22 @@ what type of text it is (eg Body, Title)
|
||||||
|
|
||||||
<section><title>Changing Text</title>
|
<section><title>Changing Text</title>
|
||||||
<p>It is possible to change the text via
|
<p>It is possible to change the text via
|
||||||
<code>TextRun.setText(String)</code>. However, if the length of
|
<code>TextRun.setText(String)</code> or
|
||||||
the text is changed, things will break because PowerPoint has
|
<code>RichTextRun.setText(String)</code>. It is not yet possible
|
||||||
internal file references in byte offsets. We currently update all
|
to add additional TextRuns or RichTextRuns.</p>
|
||||||
of these byte references that we know about when writing out, but
|
<p>When calling <code>TextRun.setText(String)</code>, all
|
||||||
there are a few more still to be found.
|
the text will end up with the same formatting. When calling
|
||||||
|
<code>RichTextRun.setText(String)</code>, the text will retain
|
||||||
|
the old formatting of that <code>RichTextRun</code>.
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section><title>Adding Slides</title>
|
||||||
|
<p>You may add new slides by calling
|
||||||
|
<code>SlideShow.createSlide()</code>, which will add a new slide
|
||||||
|
to the end of the SlideShow. It is not currently possible to
|
||||||
|
re-order slides, nor to add new text to slides (currently only
|
||||||
|
adding Escher objects to new slides is supported).
|
||||||
</p>
|
</p>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
@ -72,12 +90,28 @@ what type of text it is (eg Body, Title)
|
||||||
Base class of all records. Also provides the main record generation
|
Base class of all records. Also provides the main record generation
|
||||||
code, which will build up a tree of records for a file.
|
code, which will build up a tree of records for a file.
|
||||||
</li>
|
</li>
|
||||||
<li><code>org.apache.poi.hslf.usermode.SlideShow</code>
|
<li><code>org.apache.poi.hslf.usermodel.SlideShow</code>
|
||||||
Builds up model entries from the records, and presents a user facing
|
Builds up model entries from the records, and presents a user facing
|
||||||
view of the file
|
view of the file
|
||||||
|
</li>
|
||||||
|
<li><code>org.apache.poi.hslf.model.Slide</code>
|
||||||
|
A user facing view of a Slide in a slidesow. Allows you to get at the
|
||||||
|
Text of the slide, and at any drawing objects on it.
|
||||||
|
</li>
|
||||||
|
<li><code>org.apache.poi.hslf.model.TextRun</code>
|
||||||
|
Holds all the Text in a given area of the Slide, and will
|
||||||
|
contain one or more <code>RichTextRun</code>s.
|
||||||
|
</li>
|
||||||
|
<li><code>org.apache.poi.hslf.usermodel.RichTextRun</code>
|
||||||
|
Holds a run of text, all having the same character and
|
||||||
|
paragraph stylings. It is possible to modify text, and/or text stylings.
|
||||||
</li>
|
</li>
|
||||||
<li><code>org.apache.poi.hslf.extractor.PowerPointExtractor</code>
|
<li><code>org.apache.poi.hslf.extractor.PowerPointExtractor</code>
|
||||||
Uses the model code to allow extraction of text from files
|
Uses the model code to allow extraction of text from files
|
||||||
|
</li>
|
||||||
|
<li><code>org.apache.poi.extractor.QuickButCruddyTextExtractor</code>
|
||||||
|
Uses the record code to extract all the text from files very fast,
|
||||||
|
but including deleted text (and other bits of Crud).
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
</section>
|
</section>
|
||||||
|
|
Loading…
Reference in New Issue