org.apache.fop.render.rtf.rtflib.rtfdoc.RtfTable Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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
*
* 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.
*/
/* $Id: RtfTable.java 1805173 2017-08-16 10:50:04Z ssteiner $ */
package org.apache.fop.render.rtf.rtflib.rtfdoc;
/*
* This file is part of the RTF library of the FOP project, which was originally
* created by Bertrand Delacretaz [email protected] and by other
* contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
* the FOP project.
*/
import java.io.IOException;
import java.io.Writer;
import org.apache.fop.apps.FOPException;
/**
* Container for RtfRow elements.
*
* This work was authored by Bertrand Delacretaz ([email protected]).
*/
public class RtfTable extends RtfContainer {
private RtfTableRow row;
private int highestRow;
private Boolean isNestedTable;
private RtfAttributes borderAttributes;
/** Added by Boris Poudérous on 07/22/2002 in order to process
* number-columns-spanned attribute */
private ITableColumnsInfo tableContext;
/** Shows the table depth necessary for nested tables */
private int nestedTableDepth;
/** Create an RTF element as a child of given container */
RtfTable(IRtfTableContainer parent, Writer w, ITableColumnsInfo tc)
throws IOException {
super((RtfContainer)parent, w);
// Line added by Boris Poudérous on 07/22/2002
tableContext = tc;
}
/** Create an RTF element as a child of given container
* Modified by Boris Poudérous in order to process 'number-columns-spanned' attribute
*/
RtfTable(IRtfTableContainer parent, Writer w, RtfAttributes attrs,
ITableColumnsInfo tc) throws IOException {
super((RtfContainer)parent, w, attrs);
// Line added by Boris Poudérous on 07/22/2002
tableContext = tc;
}
/**
* Close current row if any and start a new one
* @return new RtfTableRow
* @throws IOException for I/O problems
*/
public RtfTableRow newTableRow() throws IOException {
if (row != null) {
row.close();
}
highestRow++;
row = new RtfTableRow(this, writer, attrib, highestRow);
return row;
}
/**
* Close current row if any and start a new one
* @param attrs attributs of new RtfTableRow
* @return new RtfTableRow
* @throws IOException for I/O problems
* @throws FOPException if attributes cannot be cloned
*/
public RtfTableRow newTableRow(RtfAttributes attrs) throws IOException, FOPException {
RtfAttributes attr = null;
if (attrib != null) {
try {
attr = (RtfAttributes) attrib.clone();
} catch (CloneNotSupportedException e) {
throw new FOPException(e);
}
attr.set(attrs);
} else {
attr = attrs;
}
if (row != null) {
row.close();
}
highestRow++;
row = new RtfTableRow(this, writer, attr, highestRow);
return row;
}
/**
* Overridden to write RTF prefix code, what comes before our children
* @throws IOException for I/O problems
*/
protected void writeRtfPrefix() throws IOException {
if (isNestedTable()) {
writeControlWordNS("pard");
}
writeGroupMark(true);
}
/**
* Overridden to write RTF suffix code, what comes after our children
* @throws IOException for I/O problems
*/
protected void writeRtfSuffix() throws IOException {
writeGroupMark(false);
if (isNestedTable()) {
getRow().writeRowAndCellsDefintions();
}
}
/**
*
* @param id row to check (??)
* @return true if id is the highestRow
*/
public boolean isHighestRow(int id) {
return (highestRow == id) ? true : false;
}
/**
* Added by Boris Poudérous on 07/22/2002
* @return ITableColumnsInfo for this table
*/
public ITableColumnsInfo getITableColumnsInfo() {
return this.tableContext;
}
private RtfAttributes headerAttribs;
/**
* Added by Normand Masse
* Support for table-header attributes (used instead of table attributes)
* @param attrs attributes to be set
*/
public void setHeaderAttribs(RtfAttributes attrs) {
headerAttribs = attrs;
}
/**
*
* @return RtfAttributes of Header
*/
public RtfAttributes getHeaderAttribs() {
return headerAttribs;
}
/**
* Added by Normand Masse
* @return the table-header attributes if they are present, otherwise the
* parent's attributes are returned normally.
*/
public RtfAttributes getRtfAttributes() {
if (headerAttribs != null) {
return headerAttribs;
}
return super.getRtfAttributes();
}
/** @return true if the the table is a nested table */
public boolean isNestedTable() {
if (isNestedTable == null) {
RtfElement e = this;
while (e.parent != null) {
if (e.parent instanceof RtfTableCell) {
isNestedTable = Boolean.TRUE;
return true;
}
e = e.parent;
}
isNestedTable = Boolean.FALSE;
} else {
return isNestedTable;
}
return false;
}
/**
*
* @return Parent row table (for nested tables only)
*/
public RtfTableRow getRow() {
RtfElement e = this;
while (e.parent != null) {
if (e.parent instanceof RtfTableRow) {
return (RtfTableRow) e.parent;
}
e = e.parent;
}
return null;
}
/**
* Sets the nested table depth.
* @param nestedTableDepth the nested table depth
*/
public void setNestedTableDepth(int nestedTableDepth) {
this.nestedTableDepth = nestedTableDepth;
}
/**
* Returns the nested table depth.
* @return the nested table depth
*/
public int getNestedTableDepth() {
return this.nestedTableDepth;
}
/**
* Sets the RtfAttributes for the borders of the table.
* @param attributes Border attributes of the table.
*/
public void setBorderAttributes(RtfAttributes attributes) {
borderAttributes = attributes;
}
/**
* Returns the RtfAttributes for the borders of the table.
* @return Border attributes of the table.
*/
public RtfAttributes getBorderAttributes() {
return borderAttributes;
}
}