org.odftoolkit.odfdom.dom.element.draw.DrawLayerElement Maven / Gradle / Ivy
Show all versions of odfdom-java Show documentation
/**
* **********************************************************************
*
* 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.draw;
import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.attribute.draw.DrawDisplayAttribute;
import org.odftoolkit.odfdom.dom.attribute.draw.DrawNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.draw.DrawProtectedAttribute;
import org.odftoolkit.odfdom.dom.element.svg.SvgDescElement;
import org.odftoolkit.odfdom.dom.element.svg.SvgTitleElement;
import org.odftoolkit.odfdom.pkg.ElementVisitor;
import org.odftoolkit.odfdom.pkg.OdfElement;
import org.odftoolkit.odfdom.pkg.OdfFileDom;
import org.odftoolkit.odfdom.pkg.OdfName;
/** DOM implementation of OpenDocument element {@odf.element draw:layer}. */
public class DrawLayerElement extends OdfElement {
public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.DRAW, "layer");
/**
* Create the instance of DrawLayerElement
*
* @param ownerDoc The type is OdfFileDom
*/
public DrawLayerElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME);
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element draw:layer}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation DrawDisplayAttribute ,
* See {@odf.attribute draw:display}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getDrawDisplayAttribute() {
DrawDisplayAttribute attr =
(DrawDisplayAttribute) getOdfAttribute(OdfDocumentNamespace.DRAW, "display");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return DrawDisplayAttribute.DEFAULT_VALUE;
}
/**
* Sets the value of ODFDOM attribute representation DrawDisplayAttribute , See
* {@odf.attribute draw:display}
*
* @param drawDisplayValue The type is String
*/
public void setDrawDisplayAttribute(String drawDisplayValue) {
DrawDisplayAttribute attr = new DrawDisplayAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(drawDisplayValue);
}
/**
* Receives the value of the ODFDOM attribute representation DrawNameAttribute , See
* {@odf.attribute draw:name}
*
*
Attribute is mandatory.
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getDrawNameAttribute() {
DrawNameAttribute attr = (DrawNameAttribute) getOdfAttribute(OdfDocumentNamespace.DRAW, "name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation DrawNameAttribute , See
* {@odf.attribute draw:name}
*
* @param drawNameValue The type is String
*/
public void setDrawNameAttribute(String drawNameValue) {
DrawNameAttribute attr = new DrawNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(drawNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation DrawProtectedAttribute ,
* See {@odf.attribute draw:protected}
*
* @return - the Boolean , the value or null, if the attribute is not
* set and no default value defined.
*/
public Boolean getDrawProtectedAttribute() {
DrawProtectedAttribute attr =
(DrawProtectedAttribute) getOdfAttribute(OdfDocumentNamespace.DRAW, "protected");
if (attr != null && !attr.getValue().isEmpty()) {
return Boolean.valueOf(attr.booleanValue());
}
return Boolean.valueOf(DrawProtectedAttribute.DEFAULT_VALUE);
}
/**
* Sets the value of ODFDOM attribute representation DrawProtectedAttribute , See
* {@odf.attribute draw:protected}
*
* @param drawProtectedValue The type is Boolean
*/
public void setDrawProtectedAttribute(Boolean drawProtectedValue) {
DrawProtectedAttribute attr = new DrawProtectedAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setBooleanValue(drawProtectedValue.booleanValue());
}
/**
* Create child element {@odf.element svg:desc}.
*
*
Child element was added in ODF 1.1
*
* @return the element {@odf.element svg:desc}
*/
public SvgDescElement newSvgDescElement() {
SvgDescElement svgDesc = ((OdfFileDom) this.ownerDocument).newOdfElement(SvgDescElement.class);
this.appendChild(svgDesc);
return svgDesc;
}
/**
* Create child element {@odf.element svg:title}.
*
*
Child element was added in ODF 1.1
*
* @return the element {@odf.element svg:title}
*/
public SvgTitleElement newSvgTitleElement() {
SvgTitleElement svgTitle =
((OdfFileDom) this.ownerDocument).newOdfElement(SvgTitleElement.class);
this.appendChild(svgTitle);
return svgTitle;
}
/**
* 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);
}
}
}