NumberPercentageStyleElement.java

  1. /**
  2.  * **********************************************************************
  3.  *
  4.  * <p>DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
  5.  *
  6.  * <p>Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
  7.  *
  8.  * <p>Use is subject to license terms.
  9.  *
  10.  * <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
  11.  * except in compliance with the License. You may obtain a copy of the License at
  12.  * http://www.apache.org/licenses/LICENSE-2.0. You can also obtain a copy of the License at
  13.  * http://odftoolkit.org/docs/license.txt
  14.  *
  15.  * <p>Unless required by applicable law or agreed to in writing, software distributed under the
  16.  * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  17.  * express or implied.
  18.  *
  19.  * <p>See the License for the specific language governing permissions and limitations under the
  20.  * License.
  21.  *
  22.  * <p>**********************************************************************
  23.  */

  25. /*
  26.  * This file is automatically generated.
  27.  * Don't edit manually.
  28.  */
  29. package org.odftoolkit.odfdom.dom.element.number;

  31. import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
  32. import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
  33. import org.odftoolkit.odfdom.dom.attribute.number.NumberCountryAttribute;
  34. import org.odftoolkit.odfdom.dom.attribute.number.NumberLanguageAttribute;
  35. import org.odftoolkit.odfdom.dom.attribute.number.NumberRfcLanguageTagAttribute;
  36. import org.odftoolkit.odfdom.dom.attribute.number.NumberScriptAttribute;
  37. import org.odftoolkit.odfdom.dom.attribute.number.NumberTitleAttribute;
  38. import org.odftoolkit.odfdom.dom.attribute.number.NumberTransliterationCountryAttribute;
  39. import org.odftoolkit.odfdom.dom.attribute.number.NumberTransliterationFormatAttribute;
  40. import org.odftoolkit.odfdom.dom.attribute.number.NumberTransliterationLanguageAttribute;
  41. import org.odftoolkit.odfdom.dom.attribute.number.NumberTransliterationStyleAttribute;
  42. import org.odftoolkit.odfdom.dom.attribute.style.StyleDisplayNameAttribute;
  43. import org.odftoolkit.odfdom.dom.attribute.style.StyleNameAttribute;
  44. import org.odftoolkit.odfdom.dom.attribute.style.StyleVolatileAttribute;
  45. import org.odftoolkit.odfdom.dom.element.style.StyleMapElement;
  46. import org.odftoolkit.odfdom.dom.element.style.StyleTextPropertiesElement;
  47. import org.odftoolkit.odfdom.pkg.ElementVisitor;
  48. import org.odftoolkit.odfdom.pkg.OdfFileDom;
  49. import org.odftoolkit.odfdom.pkg.OdfName;

  51. /** DOM implementation of OpenDocument element {@odf.element number:percentage-style}. */
  52. public abstract class NumberPercentageStyleElement extends DataStyleElement {

  54.   public static final OdfName ELEMENT_NAME =
  55.       OdfName.newName(OdfDocumentNamespace.NUMBER, "percentage-style");

  57.   /**
  58.    * Create the instance of <code>NumberPercentageStyleElement</code>
  59.    *
  60.    * @param ownerDoc The type is <code>OdfFileDom</code>
  61.    */
  62.   public NumberPercentageStyleElement(OdfFileDom ownerDoc) {
  63.     super(ownerDoc, ELEMENT_NAME);
  64.   }

  66.   /**
  67.    * Get the element name
  68.    *
  69.    * @return return <code>OdfName</code> the name of element {@odf.element number:percentage-style}.
  70.    */
  71.   @Override
  72.   public OdfName getOdfName() {
  73.     return ELEMENT_NAME;
  74.   }

  76.   /**
  77.    * Receives the value of the ODFDOM attribute representation <code>NumberCountryAttribute</code> ,
  78.    * See {@odf.attribute number:country}
  79.    *
  80.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  81.    *     and no default value defined.
  82.    */
  83.   public String getNumberCountryAttribute() {
  84.     NumberCountryAttribute attr =
  85.         (NumberCountryAttribute) getOdfAttribute(OdfDocumentNamespace.NUMBER, "country");
  86.     if (attr != null) {
  87.       return String.valueOf(attr.getValue());
  88.     }
  89.     return null;
  90.   }

  92.   /**
  93.    * Sets the value of ODFDOM attribute representation <code>NumberCountryAttribute</code> , See
  94.    * {@odf.attribute number:country}
  95.    *
  96.    * @param numberCountryValue The type is <code>String</code>
  97.    */
  98.   public void setNumberCountryAttribute(String numberCountryValue) {
  99.     NumberCountryAttribute attr = new NumberCountryAttribute((OdfFileDom) this.ownerDocument);
  100.     setOdfAttribute(attr);
  101.     attr.setValue(numberCountryValue);
  102.   }

  104.   /**
  105.    * Receives the value of the ODFDOM attribute representation <code>NumberLanguageAttribute</code>
  106.    * , See {@odf.attribute number:language}
  107.    *
  108.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  109.    *     and no default value defined.
  110.    */
  111.   public String getNumberLanguageAttribute() {
  112.     NumberLanguageAttribute attr =
  113.         (NumberLanguageAttribute) getOdfAttribute(OdfDocumentNamespace.NUMBER, "language");
  114.     if (attr != null) {
  115.       return String.valueOf(attr.getValue());
  116.     }
  117.     return null;
  118.   }

  120.   /**
  121.    * Sets the value of ODFDOM attribute representation <code>NumberLanguageAttribute</code> , See
  122.    * {@odf.attribute number:language}
  123.    *
  124.    * @param numberLanguageValue The type is <code>String</code>
  125.    */
  126.   public void setNumberLanguageAttribute(String numberLanguageValue) {
  127.     NumberLanguageAttribute attr = new NumberLanguageAttribute((OdfFileDom) this.ownerDocument);
  128.     setOdfAttribute(attr);
  129.     attr.setValue(numberLanguageValue);
  130.   }

  132.   /**
  133.    * Receives the value of the ODFDOM attribute representation <code>NumberRfcLanguageTagAttribute
  134.    * </code> , See {@odf.attribute number:rfc-language-tag}
  135.    *
  136.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  137.    *     and no default value defined.
  138.    */
  139.   public String getNumberRfcLanguageTagAttribute() {
  140.     NumberRfcLanguageTagAttribute attr =
  141.         (NumberRfcLanguageTagAttribute)
  142.             getOdfAttribute(OdfDocumentNamespace.NUMBER, "rfc-language-tag");
  143.     if (attr != null) {
  144.       return String.valueOf(attr.getValue());
  145.     }
  146.     return null;
  147.   }

  149.   /**
  150.    * Sets the value of ODFDOM attribute representation <code>NumberRfcLanguageTagAttribute</code> ,
  151.    * See {@odf.attribute number:rfc-language-tag}
  152.    *
  153.    * @param numberRfcLanguageTagValue The type is <code>String</code>
  154.    */
  155.   public void setNumberRfcLanguageTagAttribute(String numberRfcLanguageTagValue) {
  156.     NumberRfcLanguageTagAttribute attr =
  157.         new NumberRfcLanguageTagAttribute((OdfFileDom) this.ownerDocument);
  158.     setOdfAttribute(attr);
  159.     attr.setValue(numberRfcLanguageTagValue);
  160.   }

  162.   /**
  163.    * Receives the value of the ODFDOM attribute representation <code>NumberScriptAttribute</code> ,
  164.    * See {@odf.attribute number:script}
  165.    *
  166.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  167.    *     and no default value defined.
  168.    */
  169.   public String getNumberScriptAttribute() {
  170.     NumberScriptAttribute attr =
  171.         (NumberScriptAttribute) getOdfAttribute(OdfDocumentNamespace.NUMBER, "script");
  172.     if (attr != null) {
  173.       return String.valueOf(attr.getValue());
  174.     }
  175.     return null;
  176.   }

  178.   /**
  179.    * Sets the value of ODFDOM attribute representation <code>NumberScriptAttribute</code> , See
  180.    * {@odf.attribute number:script}
  181.    *
  182.    * @param numberScriptValue The type is <code>String</code>
  183.    */
  184.   public void setNumberScriptAttribute(String numberScriptValue) {
  185.     NumberScriptAttribute attr = new NumberScriptAttribute((OdfFileDom) this.ownerDocument);
  186.     setOdfAttribute(attr);
  187.     attr.setValue(numberScriptValue);
  188.   }

  190.   /**
  191.    * Receives the value of the ODFDOM attribute representation <code>NumberTitleAttribute</code> ,
  192.    * See {@odf.attribute number:title}
  193.    *
  194.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  195.    *     and no default value defined.
  196.    */
  197.   public String getNumberTitleAttribute() {
  198.     NumberTitleAttribute attr =
  199.         (NumberTitleAttribute) getOdfAttribute(OdfDocumentNamespace.NUMBER, "title");
  200.     if (attr != null) {
  201.       return String.valueOf(attr.getValue());
  202.     }
  203.     return null;
  204.   }

  206.   /**
  207.    * Sets the value of ODFDOM attribute representation <code>NumberTitleAttribute</code> , See
  208.    * {@odf.attribute number:title}
  209.    *
  210.    * @param numberTitleValue The type is <code>String</code>
  211.    */
  212.   public void setNumberTitleAttribute(String numberTitleValue) {
  213.     NumberTitleAttribute attr = new NumberTitleAttribute((OdfFileDom) this.ownerDocument);
  214.     setOdfAttribute(attr);
  215.     attr.setValue(numberTitleValue);
  216.   }

  218.   /**
  219.    * Receives the value of the ODFDOM attribute representation <code>
  220.    * NumberTransliterationCountryAttribute</code> , See {@odf.attribute
  221.    * number:transliteration-country}
  222.    *
  223.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  224.    *     and no default value defined.
  225.    */
  226.   public String getNumberTransliterationCountryAttribute() {
  227.     NumberTransliterationCountryAttribute attr =
  228.         (NumberTransliterationCountryAttribute)
  229.             getOdfAttribute(OdfDocumentNamespace.NUMBER, "transliteration-country");
  230.     if (attr != null) {
  231.       return String.valueOf(attr.getValue());
  232.     }
  233.     return null;
  234.   }

  236.   /**
  237.    * Sets the value of ODFDOM attribute representation <code>NumberTransliterationCountryAttribute
  238.    * </code> , See {@odf.attribute number:transliteration-country}
  239.    *
  240.    * @param numberTransliterationCountryValue The type is <code>String</code>
  241.    */
  242.   public void setNumberTransliterationCountryAttribute(String numberTransliterationCountryValue) {
  243.     NumberTransliterationCountryAttribute attr =
  244.         new NumberTransliterationCountryAttribute((OdfFileDom) this.ownerDocument);
  245.     setOdfAttribute(attr);
  246.     attr.setValue(numberTransliterationCountryValue);
  247.   }

  249.   /**
  250.    * Receives the value of the ODFDOM attribute representation <code>
  251.    * NumberTransliterationFormatAttribute</code> , See {@odf.attribute
  252.    * number:transliteration-format}
  253.    *
  254.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  255.    *     and no default value defined.
  256.    */
  257.   public String getNumberTransliterationFormatAttribute() {
  258.     NumberTransliterationFormatAttribute attr =
  259.         (NumberTransliterationFormatAttribute)
  260.             getOdfAttribute(OdfDocumentNamespace.NUMBER, "transliteration-format");
  261.     if (attr != null) {
  262.       return String.valueOf(attr.getValue());
  263.     }
  264.     return NumberTransliterationFormatAttribute.DEFAULT_VALUE;
  265.   }

  267.   /**
  268.    * Sets the value of ODFDOM attribute representation <code>NumberTransliterationFormatAttribute
  269.    * </code> , See {@odf.attribute number:transliteration-format}
  270.    *
  271.    * @param numberTransliterationFormatValue The type is <code>String</code>
  272.    */
  273.   public void setNumberTransliterationFormatAttribute(String numberTransliterationFormatValue) {
  274.     NumberTransliterationFormatAttribute attr =
  275.         new NumberTransliterationFormatAttribute((OdfFileDom) this.ownerDocument);
  276.     setOdfAttribute(attr);
  277.     attr.setValue(numberTransliterationFormatValue);
  278.   }

  280.   /**
  281.    * Receives the value of the ODFDOM attribute representation <code>
  282.    * NumberTransliterationLanguageAttribute</code> , See {@odf.attribute
  283.    * number:transliteration-language}
  284.    *
  285.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  286.    *     and no default value defined.
  287.    */
  288.   public String getNumberTransliterationLanguageAttribute() {
  289.     NumberTransliterationLanguageAttribute attr =
  290.         (NumberTransliterationLanguageAttribute)
  291.             getOdfAttribute(OdfDocumentNamespace.NUMBER, "transliteration-language");
  292.     if (attr != null) {
  293.       return String.valueOf(attr.getValue());
  294.     }
  295.     return null;
  296.   }

  298.   /**
  299.    * Sets the value of ODFDOM attribute representation <code>NumberTransliterationLanguageAttribute
  300.    * </code> , See {@odf.attribute number:transliteration-language}
  301.    *
  302.    * @param numberTransliterationLanguageValue The type is <code>String</code>
  303.    */
  304.   public void setNumberTransliterationLanguageAttribute(String numberTransliterationLanguageValue) {
  305.     NumberTransliterationLanguageAttribute attr =
  306.         new NumberTransliterationLanguageAttribute((OdfFileDom) this.ownerDocument);
  307.     setOdfAttribute(attr);
  308.     attr.setValue(numberTransliterationLanguageValue);
  309.   }

  311.   /**
  312.    * Receives the value of the ODFDOM attribute representation <code>
  313.    * NumberTransliterationStyleAttribute</code> , See {@odf.attribute number:transliteration-style}
  314.    *
  315.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  316.    *     and no default value defined.
  317.    */
  318.   public String getNumberTransliterationStyleAttribute() {
  319.     NumberTransliterationStyleAttribute attr =
  320.         (NumberTransliterationStyleAttribute)
  321.             getOdfAttribute(OdfDocumentNamespace.NUMBER, "transliteration-style");
  322.     if (attr != null) {
  323.       return String.valueOf(attr.getValue());
  324.     }
  325.     return NumberTransliterationStyleAttribute.DEFAULT_VALUE;
  326.   }

  328.   /**
  329.    * Sets the value of ODFDOM attribute representation <code>NumberTransliterationStyleAttribute
  330.    * </code> , See {@odf.attribute number:transliteration-style}
  331.    *
  332.    * @param numberTransliterationStyleValue The type is <code>String</code>
  333.    */
  334.   public void setNumberTransliterationStyleAttribute(String numberTransliterationStyleValue) {
  335.     NumberTransliterationStyleAttribute attr =
  336.         new NumberTransliterationStyleAttribute((OdfFileDom) this.ownerDocument);
  337.     setOdfAttribute(attr);
  338.     attr.setValue(numberTransliterationStyleValue);
  339.   }

  341.   /**
  342.    * Receives the value of the ODFDOM attribute representation <code>StyleDisplayNameAttribute
  343.    * </code> , See {@odf.attribute style:display-name}
  344.    *
  345.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  346.    *     and no default value defined.
  347.    */
  348.   public String getStyleDisplayNameAttribute() {
  349.     StyleDisplayNameAttribute attr =
  350.         (StyleDisplayNameAttribute) getOdfAttribute(OdfDocumentNamespace.STYLE, "display-name");
  351.     if (attr != null) {
  352.       return String.valueOf(attr.getValue());
  353.     }
  354.     return null;
  355.   }

  357.   /**
  358.    * Sets the value of ODFDOM attribute representation <code>StyleDisplayNameAttribute</code> , See
  359.    * {@odf.attribute style:display-name}
  360.    *
  361.    * @param styleDisplayNameValue The type is <code>String</code>
  362.    */
  363.   public void setStyleDisplayNameAttribute(String styleDisplayNameValue) {
  364.     StyleDisplayNameAttribute attr = new StyleDisplayNameAttribute((OdfFileDom) this.ownerDocument);
  365.     setOdfAttribute(attr);
  366.     attr.setValue(styleDisplayNameValue);
  367.   }

  369.   /**
  370.    * Receives the value of the ODFDOM attribute representation <code>StyleNameAttribute</code> , See
  371.    * {@odf.attribute style:name}
  372.    *
  373.    * <p>Attribute is mandatory.
  374.    *
  375.    * @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
  376.    *     and no default value defined.
  377.    */
  378.   public String getStyleNameAttribute() {
  379.     StyleNameAttribute attr =
  380.         (StyleNameAttribute) getOdfAttribute(OdfDocumentNamespace.STYLE, "name");
  381.     if (attr != null) {
  382.       return String.valueOf(attr.getValue());
  383.     }
  384.     return null;
  385.   }

  387.   /**
  388.    * Sets the value of ODFDOM attribute representation <code>StyleNameAttribute</code> , See
  389.    * {@odf.attribute style:name}
  390.    *
  391.    * @param styleNameValue The type is <code>String</code>
  392.    */
  393.   public void setStyleNameAttribute(String styleNameValue) {
  394.     StyleNameAttribute attr = new StyleNameAttribute((OdfFileDom) this.ownerDocument);
  395.     setOdfAttribute(attr);
  396.     attr.setValue(styleNameValue);
  397.   }

  399.   /**
  400.    * Receives the value of the ODFDOM attribute representation <code>StyleVolatileAttribute</code> ,
  401.    * See {@odf.attribute style:volatile}
  402.    *
  403.    * @return - the <code>Boolean</code> , the value or <code>null</code>, if the attribute is not
  404.    *     set and no default value defined.
  405.    */
  406.   public Boolean getStyleVolatileAttribute() {
  407.     StyleVolatileAttribute attr =
  408.         (StyleVolatileAttribute) getOdfAttribute(OdfDocumentNamespace.STYLE, "volatile");
  409.     if (attr != null) {
  410.       return Boolean.valueOf(attr.booleanValue());
  411.     }
  412.     return null;
  413.   }

  415.   /**
  416.    * Sets the value of ODFDOM attribute representation <code>StyleVolatileAttribute</code> , See
  417.    * {@odf.attribute style:volatile}
  418.    *
  419.    * @param styleVolatileValue The type is <code>Boolean</code>
  420.    */
  421.   public void setStyleVolatileAttribute(Boolean styleVolatileValue) {
  422.     StyleVolatileAttribute attr = new StyleVolatileAttribute((OdfFileDom) this.ownerDocument);
  423.     setOdfAttribute(attr);
  424.     attr.setBooleanValue(styleVolatileValue.booleanValue());
  425.   }

  427.   /**
  428.    * Create child element {@odf.element number:number}.
  429.    *
  430.    * @return the element {@odf.element number:number}
  431.    */
  432.   public NumberNumberElement newNumberNumberElement() {
  433.     NumberNumberElement numberNumber =
  434.         ((OdfFileDom) this.ownerDocument).newOdfElement(NumberNumberElement.class);
  435.     this.appendChild(numberNumber);
  436.     return numberNumber;
  437.   }

  439.   /**
  440.    * Create child element {@odf.element number:text}.
  441.    *
  442.    * @return the element {@odf.element number:text}
  443.    */
  444.   public NumberTextElement newNumberTextElement() {
  445.     NumberTextElement numberText =
  446.         ((OdfFileDom) this.ownerDocument).newOdfElement(NumberTextElement.class);
  447.     this.appendChild(numberText);
  448.     return numberText;
  449.   }

  451.   /**
  452.    * Create child element {@odf.element style:map}.
  453.    *
  454.    * @param styleApplyStyleNameValue the <code>String</code> value of <code>
  455.    *     StyleApplyStyleNameAttribute</code>, see {@odf.attribute style:apply-style-name} at
  456.    *     specification
  457.    * @param styleConditionValue the <code>String</code> value of <code>StyleConditionAttribute
  458.    *     </code>, see {@odf.attribute style:condition} at specification
  459.    * @return the element {@odf.element style:map}
  460.    */
  461.   public StyleMapElement newStyleMapElement(
  462.       String styleApplyStyleNameValue, String styleConditionValue) {
  463.     StyleMapElement styleMap =
  464.         ((OdfFileDom) this.ownerDocument).newOdfElement(StyleMapElement.class);
  465.     styleMap.setStyleApplyStyleNameAttribute(styleApplyStyleNameValue);
  466.     styleMap.setStyleConditionAttribute(styleConditionValue);
  467.     this.appendChild(styleMap);
  468.     return styleMap;
  469.   }

  471.   /**
  472.    * Create child element {@odf.element style:text-properties}.
  473.    *
  474.    * @param textDisplayValue the <code>String</code> value of <code>TextDisplayAttribute</code>, see
  475.    *     {@odf.attribute text:display} at specification
  476.    * @return the element {@odf.element style:text-properties}
  477.    */
  478.   public StyleTextPropertiesElement newStyleTextPropertiesElement(String textDisplayValue) {
  479.     StyleTextPropertiesElement styleTextProperties =
  480.         ((OdfFileDom) this.ownerDocument).newOdfElement(StyleTextPropertiesElement.class);
  481.     styleTextProperties.setTextDisplayAttribute(textDisplayValue);
  482.     this.appendChild(styleTextProperties);
  483.     return styleTextProperties;
  484.   }

  486.   @Override
  487.   public void accept(ElementVisitor visitor) {
  488.     if (visitor instanceof DefaultElementVisitor) {
  489.       DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
  490.       defaultVisitor.visit(this);
  491.     } else {
  492.       visitor.visit(this);
  493.     }
  494.   }
  495. }
Created with JaCoCo 0.8.7.202105040129