org.odftoolkit.odfdom.dom.element.style.StyleDefaultStyleElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of odfdom-java Show documentation
ODFDOM is an OpenDocument Format (ODF) framework. Its purpose is to provide an easy common way to create, access and manipulate ODF files, without requiring detailed knowledge of the ODF specification. It is designed to provide the ODF developer community with an easy lightwork programming API portable to any object-oriented language. The current reference implementation is written in Java.
There is a newer version: 1.0.0-BETA1
Show newest version
/**
 * **********************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * 
Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * 
Use is subject to license terms.
 *
 * 
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
 *
 * 
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.
 *
 * 
See the License for the specific language governing permissions and limitations under the
 * License.
 *
 * 
**********************************************************************
 */

/*
 * This file is automatically generated.
 * Don't edit manually.
 */
package org.odftoolkit.odfdom.dom.element.style;

import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.attribute.style.StyleFamilyAttribute;
import org.odftoolkit.odfdom.dom.element.OdfStyleBase;
import org.odftoolkit.odfdom.pkg.ElementVisitor;
import org.odftoolkit.odfdom.pkg.OdfFileDom;
import org.odftoolkit.odfdom.pkg.OdfName;

/** DOM implementation of OpenDocument element {@odf.element style:default-style}. */
public class StyleDefaultStyleElement extends OdfStyleBase {

  public static final OdfName ELEMENT_NAME =
      OdfName.newName(OdfDocumentNamespace.STYLE, "default-style");

  /**
   * Create the instance of StyleDefaultStyleElement
   *
   * @param ownerDoc The type is OdfFileDom
   */
  public StyleDefaultStyleElement(OdfFileDom ownerDoc) {
    super(ownerDoc, ELEMENT_NAME);
  }

  /**
   * Get the element name
   *
   * @return return OdfName the name of element {@odf.element style:default-style}.
   */
  public OdfName getOdfName() {
    return ELEMENT_NAME;
  }

  /**
   * Receives the value of the ODFDOM attribute representation StyleFamilyAttribute ,
   * See {@odf.attribute style:family}
   *
   * Attribute is mandatory.
   *
   * @return - the String , the value or null, if the attribute is not set
   *     and no default value defined.
   */
  public String getStyleFamilyAttribute() {
    StyleFamilyAttribute attr =
        (StyleFamilyAttribute) getOdfAttribute(OdfDocumentNamespace.STYLE, "family");
    if (attr != null) {
      return String.valueOf(attr.getValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation StyleFamilyAttribute , See
   * {@odf.attribute style:family}
   *
   * @param styleFamilyValue The type is String
   */
  public void setStyleFamilyAttribute(String styleFamilyValue) {
    StyleFamilyAttribute attr = new StyleFamilyAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setValue(styleFamilyValue);
  }

  /**
   * Create child element {@odf.element style:chart-properties}.
   *
   * @param chartSymbolTypeValue the String value of ChartSymbolTypeAttribute
   *     , see {@odf.attribute chart:symbol-type} at specification
   * @return the element {@odf.element style:chart-properties}
   */
  public StyleChartPropertiesElement newStyleChartPropertiesElement(String chartSymbolTypeValue) {
    StyleChartPropertiesElement styleChartProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleChartPropertiesElement.class);
    styleChartProperties.setChartSymbolTypeAttribute(chartSymbolTypeValue);
    this.appendChild(styleChartProperties);
    return styleChartProperties;
  }

  /**
   * Create child element {@odf.element style:drawing-page-properties}.
   *
   * @return the element {@odf.element style:drawing-page-properties}
   */
  public StyleDrawingPagePropertiesElement newStyleDrawingPagePropertiesElement() {
    StyleDrawingPagePropertiesElement styleDrawingPageProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleDrawingPagePropertiesElement.class);
    this.appendChild(styleDrawingPageProperties);
    return styleDrawingPageProperties;
  }

  /**
   * Create child element {@odf.element style:graphic-properties}.
   *
   * @return the element {@odf.element style:graphic-properties}
   */
  public StyleGraphicPropertiesElement newStyleGraphicPropertiesElement() {
    StyleGraphicPropertiesElement styleGraphicProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleGraphicPropertiesElement.class);
    this.appendChild(styleGraphicProperties);
    return styleGraphicProperties;
  }

  /**
   * Create child element {@odf.element style:paragraph-properties}.
   *
   * @return the element {@odf.element style:paragraph-properties}
   */
  public StyleParagraphPropertiesElement newStyleParagraphPropertiesElement() {
    StyleParagraphPropertiesElement styleParagraphProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleParagraphPropertiesElement.class);
    this.appendChild(styleParagraphProperties);
    return styleParagraphProperties;
  }

  /**
   * Create child element {@odf.element style:ruby-properties}.
   *
   * @return the element {@odf.element style:ruby-properties}
   */
  public StyleRubyPropertiesElement newStyleRubyPropertiesElement() {
    StyleRubyPropertiesElement styleRubyProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleRubyPropertiesElement.class);
    this.appendChild(styleRubyProperties);
    return styleRubyProperties;
  }

  /**
   * Create child element {@odf.element style:section-properties}.
   *
   * @return the element {@odf.element style:section-properties}
   */
  public StyleSectionPropertiesElement newStyleSectionPropertiesElement() {
    StyleSectionPropertiesElement styleSectionProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleSectionPropertiesElement.class);
    this.appendChild(styleSectionProperties);
    return styleSectionProperties;
  }

  /**
   * Create child element {@odf.element style:table-cell-properties}.
   *
   * @return the element {@odf.element style:table-cell-properties}
   */
  public StyleTableCellPropertiesElement newStyleTableCellPropertiesElement() {
    StyleTableCellPropertiesElement styleTableCellProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleTableCellPropertiesElement.class);
    this.appendChild(styleTableCellProperties);
    return styleTableCellProperties;
  }

  /**
   * Create child element {@odf.element style:table-column-properties}.
   *
   * @return the element {@odf.element style:table-column-properties}
   */
  public StyleTableColumnPropertiesElement newStyleTableColumnPropertiesElement() {
    StyleTableColumnPropertiesElement styleTableColumnProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleTableColumnPropertiesElement.class);
    this.appendChild(styleTableColumnProperties);
    return styleTableColumnProperties;
  }

  /**
   * Create child element {@odf.element style:table-properties}.
   *
   * @return the element {@odf.element style:table-properties}
   */
  public StyleTablePropertiesElement newStyleTablePropertiesElement() {
    StyleTablePropertiesElement styleTableProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleTablePropertiesElement.class);
    this.appendChild(styleTableProperties);
    return styleTableProperties;
  }

  /**
   * Create child element {@odf.element style:table-row-properties}.
   *
   * @return the element {@odf.element style:table-row-properties}
   */
  public StyleTableRowPropertiesElement newStyleTableRowPropertiesElement() {
    StyleTableRowPropertiesElement styleTableRowProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleTableRowPropertiesElement.class);
    this.appendChild(styleTableRowProperties);
    return styleTableRowProperties;
  }

  /**
   * Create child element {@odf.element style:text-properties}.
   *
   * @param textDisplayValue the String value of TextDisplayAttribute, see
   *     {@odf.attribute text:display} at specification
   * @return the element {@odf.element style:text-properties}
   */
  public StyleTextPropertiesElement newStyleTextPropertiesElement(String textDisplayValue) {
    StyleTextPropertiesElement styleTextProperties =
        ((OdfFileDom) this.ownerDocument).newOdfElement(StyleTextPropertiesElement.class);
    styleTextProperties.setTextDisplayAttribute(textDisplayValue);
    this.appendChild(styleTextProperties);
    return styleTextProperties;
  }

  /**
   * Accept an visitor instance to allow the visitor to do some operations. Refer to visitor design
   * pattern to get a better understanding.
   *
   * @param visitor an instance of DefaultElementVisitor
   */
  @Override
  public void accept(ElementVisitor visitor) {
    if (visitor instanceof DefaultElementVisitor) {
      DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
      defaultVisitor.visit(this);
    } else {
      visitor.visit(this);
    }
  }
}