TableTableColumnElement.java
/**
* **********************************************************************
*
* <p>DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
*
* <p>Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
*
* <p>Use is subject to license terms.
*
* <p>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
*
* <p>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.
*
* <p>See the License for the specific language governing permissions and limitations under the
* License.
*
* <p>**********************************************************************
*/
/*
* This file is automatically generated.
* Don't edit manually.
*/
package org.odftoolkit.odfdom.dom.element.table;
import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.attribute.table.TableDefaultCellStyleNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableNumberColumnsRepeatedAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableStyleNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableVisibilityAttribute;
import org.odftoolkit.odfdom.dom.attribute.xml.XmlIdAttribute;
import org.odftoolkit.odfdom.dom.element.OdfStylableElement;
import org.odftoolkit.odfdom.dom.style.OdfStyleFamily;
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 table:table-column}. */
public class TableTableColumnElement extends OdfStylableElement {
public static final OdfName ELEMENT_NAME =
OdfName.newName(OdfDocumentNamespace.TABLE, "table-column");
private static final String VISIBLE = "visible";
private static final String COLLAPSE = "collapse";
/**
* Create the instance of <code>TableTableColumnElement</code>
*
* @param ownerDoc The type is <code>OdfFileDom</code>
*/
public TableTableColumnElement(OdfFileDom ownerDoc) {
super(
ownerDoc,
ELEMENT_NAME,
OdfStyleFamily.TableColumn,
OdfName.newName(OdfDocumentNamespace.TABLE, "style-name"));
}
/**
* Get the element name
*
* @return return <code>OdfName</code> the name of element {@odf.element table:table-column}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation <code>
* TableDefaultCellStyleNameAttribute</code> , See {@odf.attribute table:default-cell-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 getTableDefaultCellStyleNameAttribute() {
TableDefaultCellStyleNameAttribute attr =
(TableDefaultCellStyleNameAttribute)
getOdfAttribute(OdfDocumentNamespace.TABLE, "default-cell-style-name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation <code>TableDefaultCellStyleNameAttribute
* </code> , See {@odf.attribute table:default-cell-style-name}
*
* @param tableDefaultCellStyleNameValue The type is <code>String</code>
*/
public void setTableDefaultCellStyleNameAttribute(String tableDefaultCellStyleNameValue) {
TableDefaultCellStyleNameAttribute attr =
new TableDefaultCellStyleNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(tableDefaultCellStyleNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation <code>
* TableNumberColumnsRepeatedAttribute</code> , See {@odf.attribute table:number-columns-repeated}
*
* @return - the <code>Integer</code> , the value or <code>null</code>, if the attribute is not
* set and no default value defined.
*/
public Integer getTableNumberColumnsRepeatedAttribute() {
TableNumberColumnsRepeatedAttribute attr =
(TableNumberColumnsRepeatedAttribute)
getOdfAttribute(OdfDocumentNamespace.TABLE, "number-columns-repeated");
if (attr != null) {
return Integer.valueOf(attr.intValue());
}
return Integer.valueOf(TableNumberColumnsRepeatedAttribute.DEFAULT_VALUE);
}
/**
* Sets the value of ODFDOM attribute representation <code>TableNumberColumnsRepeatedAttribute
* </code> , See {@odf.attribute table:number-columns-repeated}
*
* @param tableNumberColumnsRepeatedValue The type is <code>Integer</code>
*/
public void setTableNumberColumnsRepeatedAttribute(Integer tableNumberColumnsRepeatedValue) {
TableNumberColumnsRepeatedAttribute attr =
new TableNumberColumnsRepeatedAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setIntValue(tableNumberColumnsRepeatedValue.intValue());
}
/**
* Receives the value of the ODFDOM attribute representation <code>TableStyleNameAttribute</code>
* , See {@odf.attribute table: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 getTableStyleNameAttribute() {
TableStyleNameAttribute attr =
(TableStyleNameAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "style-name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation <code>TableStyleNameAttribute</code> , See
* {@odf.attribute table:style-name}
*
* @param tableStyleNameValue The type is <code>String</code>
*/
public void setTableStyleNameAttribute(String tableStyleNameValue) {
TableStyleNameAttribute attr = new TableStyleNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(tableStyleNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation <code>TableVisibilityAttribute</code>
* , See {@odf.attribute table:visibility}
*
* @return - the <code>String</code> , the value or <code>null</code>, if the attribute is not set
* and no default value defined.
*/
public String getTableVisibilityAttribute() {
TableVisibilityAttribute attr =
(TableVisibilityAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "visibility");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return TableVisibilityAttribute.DEFAULT_VALUE;
}
/**
* Sets the value of ODFDOM attribute representation <code>TableVisibilityAttribute</code> , See
* {@odf.attribute table:visibility}
*
* @param tableVisibilityValue The type is <code>String</code>
*/
public void setTableVisibilityAttribute(String tableVisibilityValue) {
TableVisibilityAttribute attr = new TableVisibilityAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(tableVisibilityValue);
}
/**
* Receives the value of the ODFDOM attribute representation <code>XmlIdAttribute</code> , See
* {@odf.attribute xml:id}
*
* @return - the <code>String</code> , the value or <code>null</code>, 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 <code>XmlIdAttribute</code> , See
* {@odf.attribute xml:id}
*
* @param xmlIdValue The type is <code>String</code>
*/
public void setXmlIdAttribute(String xmlIdValue) {
XmlIdAttribute attr = new XmlIdAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xmlIdValue);
}
@Override
public void accept(ElementVisitor visitor) {
if (visitor instanceof DefaultElementVisitor) {
DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
defaultVisitor.visit(this);
} else {
visitor.visit(this);
}
}
@Override
// ToDo: Move this to a intermediate class, e.g. ComponentRootElement
/** @return the component size of a heading, which is always 1 */
public int getRepetition() {
Integer repeated = getTableNumberColumnsRepeatedAttribute();
if (repeated == null) {
repeated = 1;
}
return repeated;
}
@Override
// ToDo: Move this to a intermediate class, e.g. ComponentRootElement
/** @return the component size of a heading, which is always 1 */
public boolean isRepeatable() {
return true;
}
@Override
// ToDo: Move this to a intermediate class, e.g. ComponentRootElement
/** @return the component size of a heading, which is always 1 */
public void setRepetition(int repetition) {
setTableNumberColumnsRepeatedAttribute(repetition);
}
/**
* Splitting the element at the given position into two halves
*
* @param posStart The split position. Counting is starting with zero. The start of the second
* half.
* @return the new created second element (or if posStart was less than 1 the original element)
*/
@Override
public TableTableColumnElement split(int posStart) {
TableTableColumnElement newElement = this;
// 0 would not leave anything left on the left side
if (posStart > 0) {
newElement = (TableTableColumnElement) this.cloneNode(true);
int repeated = getTableNumberColumnsRepeatedAttribute();
if (repeated > 1) {
if (posStart > 1) {
this.setTableNumberColumnsRepeatedAttribute(posStart);
} else {
this.removeAttributeNS(OdfDocumentNamespace.TABLE.getUri(), "number-columns-repeated");
}
// any higher value one for repeated write out.
// 1 is the default and has not to be written out
if (repeated - posStart > 1) {
newElement.setTableNumberColumnsRepeatedAttribute(repeated - posStart);
} else {
newElement.removeAttributeNS(
OdfDocumentNamespace.TABLE.getUri(), "number-columns-repeated");
}
}
OdfElement nextElementSibling = OdfElement.getNextSiblingElement(this);
OdfElement parent = (OdfElement) this.getParentNode();
if (nextElementSibling == null) {
parent.appendChild(newElement);
} else {
parent.insertBefore(newElement, nextElementSibling);
}
}
return newElement;
}
/** Changes the visibility of the @table:visibility attributes */
public void setVisiblity(Boolean show) {
// the default is visible ("true")
boolean isVisible = Boolean.TRUE;
if (hasAttributeNS(OdfDocumentNamespace.TABLE.getUri(), "visibility")) {
isVisible = VISIBLE.equals(getAttributeNS(OdfDocumentNamespace.TABLE.getUri(), "visibility"));
}
if (show && !isVisible || !show && isVisible) {
if (show) {
removeAttributeNS(OdfDocumentNamespace.TABLE.getUri(), "visible");
} else {
setAttributeNS(OdfDocumentNamespace.TABLE.getUri(), "table:visibility", COLLAPSE);
}
}
}
}