OdfTextSpan.java

/**
 * **********************************************************************
 *
 * <p>DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * <p>Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * <p>Use is subject to license terms.
 *
 * <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0. You can also obtain a copy of the License at
 * http://odftoolkit.org/docs/license.txt
 *
 * <p>Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied.
 *
 * <p>See the License for the specific language governing permissions and limitations under the
 * License.
 *
 * <p>**********************************************************************
 */
package org.odftoolkit.odfdom.incubator.doc.text;

import org.odftoolkit.odfdom.dom.element.text.TextSpanElement;
import org.odftoolkit.odfdom.pkg.OdfFileDom;

/** Convenient functionality for the parent ODF OpenDocument element */
public class OdfTextSpan extends TextSpanElement {
  public OdfTextSpan(OdfFileDom ownerDoc) {
    super(ownerDoc);
  }

  /**
   * Creates a new instance of this class with the given style name. If the style name is null or
   * the null string, no style is added.
   *
   * @param ownerDoc the XML file the Span belongs to
   * @param styleName the name of the style to be applied to the span
   */
  public OdfTextSpan(OdfFileDom ownerDoc, String styleName) {
    super(ownerDoc);
    if (styleName != null && (!(styleName.equals("")))) {
      this.setStyleName(styleName);
    }
  }

  /**
   * Creates an instance of this class with the given styleName and content. If the style name is
   * null or the null string, no style is added. If the content is null or the null string, no
   * content is added.
   *
   * @param ownerDoc the owner document DOM
   * @param styleName the style:style-name value
   * @param content the span content
   */
  public OdfTextSpan(OdfFileDom ownerDoc, String styleName, String content) {
    super(ownerDoc);
    this.addStyledContent(styleName, content);
  }

  /**
   * Add the given content to the paragraph. If the content is null or the null string, no content
   * is added.
   *
   * @param content the span content
   * @return the span object
   */
  public OdfTextSpan addContent(String content) {
    if (content != null && !content.equals("")) {
      this.appendChild(this.getOwnerDocument().createTextNode(content));
    }
    return this;
  }

  /**
   * Add the given content to the paragraph. If the content is null or the null string, no content
   * is added. Embedded \n are converted to <code>&lt;text:line-break&gt;</code> elements, and
   * multiple blanks to <code>&lt;text:s</code>
   *
   * @param content the span content
   * @return the span object
   */
  public OdfTextSpan addContentWhitespace(String content) {
    if (content != null && !content.equals("")) {
      new OdfWhitespaceProcessor().append(this, content);
    }
    return this;
  }

  /**
   * Set a span to have the given styleName and add the given content. If the style name is null or
   * the null string, no style is added.
   *
   * @param styleName the style:style-name value
   * @param content the span content
   * @return the span object
   */
  public OdfTextSpan addStyledContent(String styleName, String content) {
    if (styleName != null && (!(styleName.equals("")))) {
      setStyleName(styleName);
    }
    return addContent(content);
  }

  /**
   * Set a span to have the given styleName and add the given content. If the style name is null or
   * the null string, no style is added. Embedded \n are converted to <code>&lt;text:line-break&gt;
   * </code> elements, and multiple blanks to <code>&lt;text:s</code>
   *
   * @param styleName the style:style-name value
   * @param content the span content
   * @return the span object
   */
  public OdfTextSpan addStyledContentWhitespace(String styleName, String content) {
    if (styleName != null && (!(styleName.equals("")))) {
      setStyleName(styleName);
    }
    return addContentWhitespace(content);
  }
}