org.jopendocument.dom.StyledNode Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jOpenDocument Show documentation
Show all versions of jOpenDocument Show documentation
jOpenDocument is a free library for developers looking to use
Open Document files without OpenOffice.org.
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2013 jOpenDocument, by ILM Informatique. All rights reserved.
*
* The contents of this file are subject to the terms of the GNU
* General Public License Version 3 only ("GPL").
* You may not use this file except in compliance with the License.
* You can obtain a copy of the License at http://www.gnu.org/licenses/gpl-3.0.html
* See the License for the specific language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each file.
*
*/
package org.jopendocument.dom;
import org.jdom.Document;
import org.jdom.Element;
/**
* A node with a style.
*
* @author Sylvain CUAZ
*
* @param type of style.
* @param type of document.
*/
public abstract class StyledNode extends ODNode {
static protected final StyleDesc getStyleDesc(final Element local, final Class styleClass) {
return Style.getStyleDesc(styleClass, XMLVersion.getVersion(local));
}
static public final void setStyleName(final Element elem, final String name) {
if (name == null)
elem.removeAttribute("style-name", elem.getNamespace());
else
elem.setAttribute("style-name", name, elem.getNamespace());
}
private final StyleDesc styleClass;
/**
* Create a new instance. We used to find the {@link Style} class with reflection but this was
* slow.
*
* @param local our XML model.
* @param styleClass our class of style, cannot be null
.
*/
public StyledNode(Element local, final Class styleClass) {
this(local, getStyleDesc(local, styleClass));
}
// allow to pass StyleDesc since Style.getStyleDesc() was the longest operation of this
// constructor, and this constructor is called for every Table, Column, Row and Cell, i.e.
// up to millions of times.
protected StyledNode(Element local, final StyleDesc styleDesc) {
super(local);
if (styleDesc == null)
throw new NullPointerException("null style desc");
this.styleClass = styleDesc;
assert styleDesc.getVersion().equals(XMLVersion.getVersion(local));
assert this.styleClass.getRefElements().contains(this.getElement().getQualifiedName()) : this.getElement().getQualifiedName() + " not in " + this.styleClass;
}
// can be null if this node wasn't created from a document (eg new Paragraph())
public abstract D getODDocument();
public final StyleDesc getStyleDesc() {
return this.styleClass;
}
public final StyleDesc getStyleDesc(Class clazz) {
return Style.getStyleDesc(clazz, getODDocument().getVersion());
}
public final StyleStyleDesc getStyleStyleDesc(Class clazz) {
return Style.getStyleStyleDesc(clazz, getODDocument().getVersion());
}
public final S getStyle() {
// null avoid getting styleName if we haven't any Document
return this.getStyle(null);
}
protected final S getStyle(final String styleName) {
final D doc = this.getODDocument();
return doc == null ? null : this.getStyle(doc.getPackage(), getElement().getDocument(), styleName == null ? getStyleName() : styleName);
}
protected final S getStyle(final ODPackage pkg, final Document doc) {
return this.getStyle(pkg, doc, getStyleName());
}
protected final S getStyle(final ODPackage pkg, final Document doc, final String styleName) {
return this.styleClass.findStyleForNode(pkg, doc, this, styleName);
}
/**
* Assure that this node's style is only referenced by this. I.e. after this method returns the
* style of this node can be safely modified without affecting other nodes.
*
* @return this node's style, never null
.
*/
public final S getPrivateStyle() {
final S currentStyle = this.getStyle();
if (currentStyle != null && currentStyle.isReferencedAtMostOnce())
return currentStyle;
final S newStyle;
if (currentStyle == null)
newStyle = this.styleClass.createAutoStyle(getODDocument().getPackage());
else
newStyle = this.styleClass.getStyleClass().cast(currentStyle.dup());
this.setStyleName(newStyle.getName());
// return newStyle to avoid the costly getStyle()
assert this.getStyle().equals(newStyle);
return newStyle;
}
// some nodes have more complicated ways of finding their style (eg Cell)
protected String getStyleName() {
return this.getElement().getAttributeValue("style-name", this.getElement().getNamespace());
}
public final void setStyleName(final String name) {
setStyleName(this.getElement(), name);
}
}