From 60471580d71ec232c59ad888abd32d6c1a6f97c0 Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Sun, 19 Mar 2006 18:43:40 +0000 Subject: [PATCH] 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 --- .../content/xdocs/hslf/quick-guide.xml | 52 +++++++++++++++---- 1 file changed, 43 insertions(+), 9 deletions(-) diff --git a/src/documentation/content/xdocs/hslf/quick-guide.xml b/src/documentation/content/xdocs/hslf/quick-guide.xml index 7b7b98deda..2cd979939f 100644 --- a/src/documentation/content/xdocs/hslf/quick-guide.xml +++ b/src/documentation/content/xdocs/hslf/quick-guide.xml @@ -26,9 +26,16 @@ from both. (from a org.apache.poi.HSLFSlideShow, which accepts a file or an input stream). Use getSlides() and getNotes() to get the slides and notes. These can be queried to get their page ID (though they should be returned -in the right order). You can also call getTextRuns() on these, to get their -blocks of text. From the TextRun, you can extract the text, and check -what type of text it is (eg Body, Title) +in the right order).

+

You can then call getTextRuns() on these, to get +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 TextRun, you can extract the text, and check +what type of text it is (eg Body, Title). You can allso call +getRichTextRuns(), which will return the +RichTextRuns that make up the TextRun. A +RichTextRun is made up of a sequence of text, all having the +same character and paragraph formatting.

@@ -53,11 +60,22 @@ what type of text it is (eg Body, Title)
Changing Text

It is possible to change the text via - TextRun.setText(String). However, if the length of - the text is changed, things will break because PowerPoint has - internal file references in byte offsets. We currently update all - of these byte references that we know about when writing out, but - there are a few more still to be found. + TextRun.setText(String) or + RichTextRun.setText(String). It is not yet possible + to add additional TextRuns or RichTextRuns.

+

When calling TextRun.setText(String), all + the text will end up with the same formatting. When calling + RichTextRun.setText(String), the text will retain + the old formatting of that RichTextRun. +

+
+ +
Adding Slides +

You may add new slides by calling + SlideShow.createSlide(), 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).

@@ -72,12 +90,28 @@ what type of text it is (eg Body, Title) Base class of all records. Also provides the main record generation code, which will build up a tree of records for a file. -
  • org.apache.poi.hslf.usermode.SlideShow +
  • org.apache.poi.hslf.usermodel.SlideShow Builds up model entries from the records, and presents a user facing view of the file +
    • +
  • org.apache.poi.hslf.model.Slide + 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. +
    • +
  • org.apache.poi.hslf.model.TextRun + Holds all the Text in a given area of the Slide, and will + contain one or more RichTextRuns. +
    • +
  • org.apache.poi.hslf.usermodel.RichTextRun + Holds a run of text, all having the same character and + paragraph stylings. It is possible to modify text, and/or text stylings.
  • org.apache.poi.hslf.extractor.PowerPointExtractor Uses the model code to allow extraction of text from files +
    • +
  • org.apache.poi.extractor.QuickButCruddyTextExtractor + Uses the record code to extract all the text from files very fast, + but including deleted text (and other bits of Crud).
    • -- 2.39.5