/************************************************************************
*
* 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.chart;
import org.odftoolkit.odfdom.dom.element.OdfStylableElement;
import org.odftoolkit.odfdom.dom.element.OdfStyleableShapeElement;
import org.odftoolkit.odfdom.dom.style.OdfStyleFamily;
import org.odftoolkit.odfdom.pkg.ElementVisitor;
import org.odftoolkit.odfdom.pkg.OdfFileDom;
import org.odftoolkit.odfdom.pkg.OdfName;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.element.text.TextPElement;
import org.odftoolkit.odfdom.dom.attribute.chart.ChartLegendAlignAttribute;
import org.odftoolkit.odfdom.dom.attribute.chart.ChartLegendPositionAttribute;
import org.odftoolkit.odfdom.dom.attribute.chart.ChartStyleNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.style.StyleLegendExpansionAttribute;
import org.odftoolkit.odfdom.dom.attribute.style.StyleLegendExpansionAspectRatioAttribute;
import org.odftoolkit.odfdom.dom.attribute.svg.SvgXAttribute;
import org.odftoolkit.odfdom.dom.attribute.svg.SvgYAttribute;
/**
* DOM implementation of OpenDocument element {@odf.element chart:legend}.
*
*/
public class ChartLegendElement extends OdfStylableElement {
public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.CHART, "legend");
/**
* Create the instance of <code>ChartLegendElement</code>
*
* @param ownerDoc The type is <code>OdfFileDom</code>
*/
public ChartLegendElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME, OdfStyleFamily.Chart, OdfName.newName(OdfDocumentNamespace.CHART, "style-name"));
}
/**
* Get the element name
*
* @return return <code>OdfName</code> the name of element {@odf.element chart:legend}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation <code>ChartLegendAlignAttribute</code> , See {@odf.attribute chart:legend-align}
*
* @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set and no default value defined.
*/
public String getChartLegendAlignAttribute() {
ChartLegendAlignAttribute attr = (ChartLegendAlignAttribute) getOdfAttribute(OdfDocumentNamespace.CHART, "legend-align");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation <code>ChartLegendAlignAttribute</code> , See {@odf.attribute chart:legend-align}
*
* @param chartLegendAlignValue The type is <code>String</code>
*/
public void setChartLegendAlignAttribute(String chartLegendAlignValue) {
ChartLegendAlignAttribute attr = new ChartLegendAlignAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(chartLegendAlignValue);
}
/**
* Receives the value of the ODFDOM attribute representation <code>ChartLegendPositionAttribute</code> , See {@odf.attribute chart:legend-position}
*
* Attribute is mandatory.
*
* @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set and no default value defined.
*/
public String getChartLegendPositionAttribute() {
ChartLegendPositionAttribute attr = (ChartLegendPositionAttribute) getOdfAttribute(OdfDocumentNamespace.CHART, "legend-position");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation <code>ChartLegendPositionAttribute</code> , See {@odf.attribute chart:legend-position}
*
* @param chartLegendPositionValue The type is <code>String</code>
*/
public void setChartLegendPositionAttribute(String chartLegendPositionValue) {
ChartLegendPositionAttribute attr = new ChartLegendPositionAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(chartLegendPositionValue);
}
/**
* Receives the value of the ODFDOM attribute representation <code>ChartStyleNameAttribute</code> , See {@odf.attribute chart:style-name}
*
* @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set and no default value defined.
*/
public String getChartStyleNameAttribute() {
ChartStyleNameAttribute attr = (ChartStyleNameAttribute) getOdfAttribute(OdfDocumentNamespace.CHART, "style-name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation <code>ChartStyleNameAttribute</code> , See {@odf.attribute chart:style-name}
*
* @param chartStyleNameValue The type is <code>String</code>
*/
public void setChartStyleNameAttribute(String chartStyleNameValue) {
ChartStyleNameAttribute attr = new ChartStyleNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(chartStyleNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation <code>StyleLegendExpansionAttribute</code> , See {@odf.attribute style:legend-expansion}
*
* Attribute is mandatory.
*
* @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set and no default value defined.
*/
public String getStyleLegendExpansionAttribute() {
StyleLegendExpansionAttribute attr = (StyleLegendExpansionAttribute) getOdfAttribute(OdfDocumentNamespace.STYLE, "legend-expansion");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation <code>StyleLegendExpansionAttribute</code> , See {@odf.attribute style:legend-expansion}
*
* @param styleLegendExpansionValue The type is <code>String</code>
*/
public void setStyleLegendExpansionAttribute(String styleLegendExpansionValue) {
StyleLegendExpansionAttribute attr = new StyleLegendExpansionAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(styleLegendExpansionValue);
}
/**
* Receives the value of the ODFDOM attribute representation <code>StyleLegendExpansionAspectRatioAttribute</code> , See {@odf.attribute style:legend-expansion-aspect-ratio}
*
* @return - the <code>Double</code> , the value or <code>null</code>, if the attribute is not set and no default value defined.
*/
public Double getStyleLegendExpansionAspectRatioAttribute() {
StyleLegendExpansionAspectRatioAttribute attr = (StyleLegendExpansionAspectRatioAttribute) getOdfAttribute(OdfDocumentNamespace.STYLE, "legend-expansion-aspect-ratio");
if (attr != null) {
return Double.valueOf(attr.doubleValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation <code>StyleLegendExpansionAspectRatioAttribute</code> , See {@odf.attribute style:legend-expansion-aspect-ratio}
*
* @param styleLegendExpansionAspectRatioValue The type is <code>Double</code>
*/
public void setStyleLegendExpansionAspectRatioAttribute(Double styleLegendExpansionAspectRatioValue) {
StyleLegendExpansionAspectRatioAttribute attr = new StyleLegendExpansionAspectRatioAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setDoubleValue(styleLegendExpansionAspectRatioValue.doubleValue());
}
/**
* Receives the value of the ODFDOM attribute representation <code>SvgXAttribute</code> , See {@odf.attribute svg:x}
*
* @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set and no default value defined.
*/
public String getSvgXAttribute() {
SvgXAttribute attr = (SvgXAttribute) getOdfAttribute(OdfDocumentNamespace.SVG, "x");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation <code>SvgXAttribute</code> , See {@odf.attribute svg:x}
*
* @param svgXValue The type is <code>String</code>
*/
public void setSvgXAttribute(String svgXValue) {
SvgXAttribute attr = new SvgXAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(svgXValue);
}
/**
* Receives the value of the ODFDOM attribute representation <code>SvgYAttribute</code> , See {@odf.attribute svg:y}
*
* @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set and no default value defined.
*/
public String getSvgYAttribute() {
SvgYAttribute attr = (SvgYAttribute) getOdfAttribute(OdfDocumentNamespace.SVG, "y");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation <code>SvgYAttribute</code> , See {@odf.attribute svg:y}
*
* @param svgYValue The type is <code>String</code>
*/
public void setSvgYAttribute(String svgYValue) {
SvgYAttribute attr = new SvgYAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(svgYValue);
}
/**
* Create child element {@odf.element text:p}.
*
* Child element is new in Odf 1.2
*
* @return the element {@odf.element text:p}
*/
public TextPElement newTextPElement() {
TextPElement textP = ((OdfFileDom) this.ownerDocument).newOdfElement(TextPElement.class);
this.appendChild(textP);
return textP;
}
@Override
public void accept(ElementVisitor visitor) {
if (visitor instanceof DefaultElementVisitor) {
DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
defaultVisitor.visit(this);
} else {
visitor.visit(this);
}
}
}