org.libreoffice.ext.unohelper.common.TextDocument Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * UNOHelper
 * %%
 * Copyright (C) 2005 - 2023 The Document Foundation
 * %%
 * Licensed under the EUPL, Version 1.1 or – as soon they will be
 * approved by the European Commission - subsequent versions of the
 * EUPL (the "Licence");
 *
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 *
 * http://ec.europa.eu/idabc/eupl5
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 * #L%
 */
package org.libreoffice.ext.unohelper.common;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Pattern;

import org.libreoffice.ext.unohelper.util.UnoProperty;

import com.sun.star.container.NoSuchElementException;
import com.sun.star.container.XNamed;
import com.sun.star.text.XTextContent;
import com.sun.star.text.XTextDocument;
import com.sun.star.text.XTextRange;

/**
 * Helper for working with {@link XTextDocument}s.
 */
public class TextDocument
{
  private TextDocument()
  {
    // nothing to do
  }

  /**
   * Delete the first paragraph at the cursor position.
   *
   * @param range
   *          The cursor position.
   * @throws UnoHelperRuntimeException
   *           Paragraph can't be deleted.
   */
  public static void deleteParagraph(XTextRange range)
  {
    UnoIterator contentIter = UnoIterator.create(range, XTextContent.class);
    if (contentIter.hasNext())
    {
      // get first paragraph
      XTextContent paragraph = contentIter.next();

      if (paragraph != null)
      {
        try
        {
          // If the range has only one paragraph it can't be deleted by removeTextContent. So we
          // only overwrite the content with an empty string.
          paragraph.getAnchor().setString("");
          range.getText().removeTextContent(paragraph);
        } catch (NoSuchElementException e)
        {
          throw new UnoHelperRuntimeException(e);
        }
      }
    }
  }

  /**
   * Get the names of all the book marks in the range matching the regular expression. Also names of
   * collapsed book marks are returned. Only book marks which are fully in the range are included.
   *
   * In some special cases like tables this method may return more names than in the text range.
   *
   * @param regex
   *          A regular expression for the names of the book marks.
   * @param range
   *          The range in which we are looking for book marks.
   * @return All names of book marks in the range matching the regular expression.
   */
  public static Set getBookmarkNamesMatching(Pattern regex, XTextRange range)
  {
    HashSet found = new HashSet<>();
    HashSet started = new HashSet<>();

    UNO.forEachTextPortionInRange(range, o -> {
      try
      {
        XNamed bookmark = UNO.XNamed(UnoProperty.getProperty(o, UnoProperty.BOOKMARK));
        String name = (bookmark != null) ? bookmark.getName() : "";

        if (regex.matcher(name).matches())
        {
          if (Boolean.TRUE.equals(UnoProperty.getProperty(o, UnoProperty.IS_START)))
          {
            if (Boolean.TRUE.equals(UnoProperty.getProperty(o, UnoProperty.IS_COLLAPSED)))
            {
              found.add(name);
            } else
            {
              started.add(name);
            }
          } else if (started.contains(name))
          {
            found.add(name);
          }
        }
      } catch (UnoHelperException e)
      {
        throw new UnoHelperRuntimeException(e);
      }
    });

    return found;
  }

  /**
   * Get a list of all book marks in a text range.
   *
   * @param range
   *          The text range.
   * @return The list of book marks.
   *
   * @throws UnoHelperRuntimeException
   *           Can't access a book mark.
   */
  public static List getBookmarkByTextRange(XTextRange range)
  {
    ArrayList bookmarks = new ArrayList<>();

    UNO.forEachTextPortionInRange(range, o -> {
      try
      {
        bookmarks.add(UNO.XNamed(UnoProperty.getProperty(o, UnoProperty.BOOKMARK)));
      } catch (UnoHelperException e)
      {
        throw new UnoHelperRuntimeException(e);
      }
    });

    return bookmarks;
  }
}