org.odftoolkit.odfdom.dom.element.draw.DrawFloatingFrameElement 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.DrawFrameNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.xlink.XlinkActuateAttribute;
import org.odftoolkit.odfdom.dom.attribute.xlink.XlinkHrefAttribute;
import org.odftoolkit.odfdom.dom.attribute.xlink.XlinkShowAttribute;
import org.odftoolkit.odfdom.dom.attribute.xlink.XlinkTypeAttribute;
import org.odftoolkit.odfdom.dom.attribute.xml.XmlIdAttribute;
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:floating-frame}. */
public class DrawFloatingFrameElement extends OdfElement {
public static final OdfName ELEMENT_NAME =
OdfName.newName(OdfDocumentNamespace.DRAW, "floating-frame");
/**
* Create the instance of DrawFloatingFrameElement
*
* @param ownerDoc The type is OdfFileDom
*/
public DrawFloatingFrameElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME);
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element draw:floating-frame}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation DrawFrameNameAttribute ,
* See {@odf.attribute draw:frame-name}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getDrawFrameNameAttribute() {
DrawFrameNameAttribute attr =
(DrawFrameNameAttribute) getOdfAttribute(OdfDocumentNamespace.DRAW, "frame-name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation DrawFrameNameAttribute , See
* {@odf.attribute draw:frame-name}
*
* @param drawFrameNameValue The type is String
*/
public void setDrawFrameNameAttribute(String drawFrameNameValue) {
DrawFrameNameAttribute attr = new DrawFrameNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(drawFrameNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation XlinkActuateAttribute ,
* See {@odf.attribute xlink:actuate}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getXlinkActuateAttribute() {
XlinkActuateAttribute attr =
(XlinkActuateAttribute) getOdfAttribute(OdfDocumentNamespace.XLINK, "actuate");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return XlinkActuateAttribute.DEFAULT_VALUE_ONLOAD;
}
/**
* Sets the value of ODFDOM attribute representation XlinkActuateAttribute , See
* {@odf.attribute xlink:actuate}
*
* @param xlinkActuateValue The type is String
*/
public void setXlinkActuateAttribute(String xlinkActuateValue) {
XlinkActuateAttribute attr = new XlinkActuateAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xlinkActuateValue);
}
/**
* Receives the value of the ODFDOM attribute representation XlinkHrefAttribute , See
* {@odf.attribute xlink:href}
*
*
Attribute is mandatory.
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getXlinkHrefAttribute() {
XlinkHrefAttribute attr =
(XlinkHrefAttribute) getOdfAttribute(OdfDocumentNamespace.XLINK, "href");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation XlinkHrefAttribute , See
* {@odf.attribute xlink:href}
*
* @param xlinkHrefValue The type is String
*/
public void setXlinkHrefAttribute(String xlinkHrefValue) {
XlinkHrefAttribute attr = new XlinkHrefAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xlinkHrefValue);
}
/**
* Receives the value of the ODFDOM attribute representation XlinkShowAttribute , See
* {@odf.attribute xlink:show}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getXlinkShowAttribute() {
XlinkShowAttribute attr =
(XlinkShowAttribute) getOdfAttribute(OdfDocumentNamespace.XLINK, "show");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return XlinkShowAttribute.DEFAULT_VALUE_EMBED;
}
/**
* Sets the value of ODFDOM attribute representation XlinkShowAttribute , See
* {@odf.attribute xlink:show}
*
* @param xlinkShowValue The type is String
*/
public void setXlinkShowAttribute(String xlinkShowValue) {
XlinkShowAttribute attr = new XlinkShowAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xlinkShowValue);
}
/**
* Receives the value of the ODFDOM attribute representation XlinkTypeAttribute , See
* {@odf.attribute xlink:type}
*
*
Attribute is mandatory.
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getXlinkTypeAttribute() {
XlinkTypeAttribute attr =
(XlinkTypeAttribute) getOdfAttribute(OdfDocumentNamespace.XLINK, "type");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return XlinkTypeAttribute.DEFAULT_VALUE;
}
/**
* Sets the value of ODFDOM attribute representation XlinkTypeAttribute , See
* {@odf.attribute xlink:type}
*
* @param xlinkTypeValue The type is String
*/
public void setXlinkTypeAttribute(String xlinkTypeValue) {
XlinkTypeAttribute attr = new XlinkTypeAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xlinkTypeValue);
}
/**
* Receives the value of the ODFDOM attribute representation XmlIdAttribute , See
* {@odf.attribute xml:id}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getXmlIdAttribute() {
XmlIdAttribute attr = (XmlIdAttribute) getOdfAttribute(OdfDocumentNamespace.XML, "id");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation XmlIdAttribute , See
* {@odf.attribute xml:id}
*
* @param xmlIdValue The type is String
*/
public void setXmlIdAttribute(String xmlIdValue) {
XmlIdAttribute attr = new XmlIdAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xmlIdValue);
}
/**
* 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);
}
}
}