org.apache.fop.layoutmgr.table.TableContentPosition 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: TableContentPosition.java 1733431 2016-03-03 09:40:50Z gadams $ */
package org.apache.fop.layoutmgr.table;
import java.util.List;
import org.apache.fop.fo.flow.table.EffRow;
import org.apache.fop.fo.flow.table.TablePart;
import org.apache.fop.layoutmgr.LayoutManager;
import org.apache.fop.layoutmgr.Position;
/**
* This class represents a Position specific to TableContentLayoutManager. Used for normal
* content cases.
*/
class TableContentPosition extends Position {
/** The position is the first of the row group. */
public static final int FIRST_IN_ROWGROUP = 1;
/** The position is the last of the row group. */
public static final int LAST_IN_ROWGROUP = 2;
/** the list of CellParts making up this position */
protected List cellParts;
/** effective row this position belongs to */
private EffRow row;
/** flags for the position */
protected int flags;
private EffRow newPageRow;
/**
* Creates a new TableContentPosition.
* @param lm applicable layout manager
* @param cellParts the list of CellPart instances
* @param row effective row this position belongs to
*/
protected TableContentPosition(LayoutManager lm, List cellParts,
EffRow row) {
super(lm);
this.cellParts = cellParts;
this.row = row;
this.newPageRow = row;
}
/**
* Sets the row corresponding to this position if it starts a new page. In which case,
* if the delay mechanism is on, this is the delayed row that starts the page, and not
* the current row being extended.
*
* @param newPageRow the row that will start the page if this position is the first
* one on that page
*/
void setNewPageRow(EffRow newPageRow) {
this.newPageRow = newPageRow;
}
EffRow getNewPageRow() {
return newPageRow;
}
EffRow getRow() {
return row;
}
TablePart getTablePart() {
return ((CellPart) cellParts.get(0)).pgu.getTablePart();
}
/**
* Returns a flag for this GridUnit.
* @param which the requested flag
* @return the value of the flag
*/
public boolean getFlag(int which) {
return (flags & (1 << which)) != 0;
}
/**
* Sets a flag on a GridUnit.
* @param which the flag to set
* @param value the new value for the flag
*/
public void setFlag(int which, boolean value) {
if (value) {
flags |= (1 << which); //set flag
} else {
flags &= ~(1 << which); //clear flag
}
}
/** {@inheritDoc} */
public boolean generatesAreas() {
return true;
}
/** {@inheritDoc} */
public String toString() {
StringBuffer sb = new StringBuffer("TableContentPosition:");
sb.append(getIndex());
sb.append("[");
sb.append(row.getIndex()).append("/");
sb.append(getFlag(FIRST_IN_ROWGROUP) ? "F" : "-");
sb.append(getFlag(LAST_IN_ROWGROUP) ? "L" : "-").append("]");
sb.append("(");
sb.append(cellParts);
sb.append(")");
return sb.toString();
}
public Position getPosition() {
return this;
}
}