Difference between revisions of "Documentation/DevGuide/Text/Iterating over Text"

Revision as of 13:17, 5 September 2008

The second interface of com.sun.star.text.Text is XEnumerationAccess. A Text service enumerates all paragraphs in a text and returns objects which support com.sun.star.text.Paragraph. This includes tables, because writer sees tables as specialized paragraphs that support the com.sun.star.text.TextTable service.

Paragraphs also have an com.sun.star.container.XEnumerationAccess of their own. They can enumerate every single text portion that they contain. A text portion is a text range containing a uniform piece of information that appears within the text flow. An ordinary paragraph, formatted in a uniform manner and containing nothing but a string, enumerates just a single text portion. In a paragraph that has specially formatted words or other contents, the text portion enumeration returns one com.sun.star.text.TextPortion service for each differently formatted string, and for every other text content. Text portions include the service com.sun.star.text.TextRange and have the properties listed below:

Possible Values for TextPortionType are:

The text portion enumeration of a paragraph does not supply contents which do belong to the paragraph, but do not fuse together with the text flow. These could be text frames, graphic objects, embedded objects or drawing shapes anchored at the paragraph, characters or as character. The TextPortionType "TextContent" indicate if there is a content anchored at a character or as a character. If you have a TextContent portion type, you know that there are shape objects anchored at a character or as a character.

This last group of data contained in a text, Paragraphs and TextPortions in writer support the interface com.sun.star.container.XContentEnumerationAccess. This interface tells which text contents other than the text flow contents exist, and supplies them as an com.sun.star.container.XEnumeration:

 sequence< string > getAvailableServiceNames()
 com::sun::star::container::XEnumeration createContentEnumeration( [in] string aServiceName)

The XContentEnumerationAccess of the paragraph lists the shape objects anchored at the paragraph while the XContentEnumerationAccess of a text portion lists the shape objects anchored at a character or as a character.

Template:Documentation/Note

The enumeration access to text through paragraphs and text portions is used if every single paragraph in a text needs to be touched. The application area for this enumeration are export filters, that uses this enumeration to go over the whole document, writing out the paragraphs to the target file. The following code snippet centers all paragraphs in a text.

 /** This method demonstrates how to iterate over paragraphs */
 protected void ParagraphExample () {
     try {
         // The service 'com.sun.star.text.Text' supports the XEnumerationAccess interface to
         // provide an enumeration
         // of the paragraphs contained by the text the service refers to. 
         
         // Here, we access this interface
         XEnumerationAccess xParaAccess = (XEnumerationAccess) UnoRuntime.queryInterface(
             XEnumerationAccess.class, mxDocText);
         // Call the XEnumerationAccess's only method to access the actual Enumeration
         XEnumeration xParaEnum = xParaAccess.createEnumeration();
         
         // While there are paragraphs, do things to them
         while (xParaEnum.hasMoreElements()) {
             // Get a reference to the next paragraphs XServiceInfo interface. TextTables
             // are also part of this
             // enumeration access, so we ask the element if it is a TextTable, if it
             // doesn't support the
             // com.sun.star.text.TextTable service, then it is safe to assume that it
             // really is a paragraph
             XServiceInfo xInfo = (XServiceInfo) UnoRuntime.queryInterface(
                 XServiceInfo.class, xParaEnum.nextElement());
             if (!xInfo.supportsService("com.sun.star.text.TextTable")) {
                 // Access the paragraph's property set...the properties in this
                 // property set are listed
                 // in: com.sun.star.style.ParagraphProperties
                 XPropertySet xSet = (XPropertySet) UnoRuntime.queryInterface(
                     XPropertySet.class, xInfo);
                 // Set the justification to be center justified
                 xSet.setPropertyValue("ParaAdjust", com.sun.star.style.ParagraphAdjust.CENTER);
             }
         }
     } catch (Exception e) {
         e.printStackTrace (System.out);
     }
 }