123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259 |
- /*
- * 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$ */
-
- package org.apache.fop.fo.flow.table;
-
- import org.xml.sax.Locator;
-
- import org.apache.fop.apps.FOPException;
- import org.apache.fop.datatypes.Length;
- import org.apache.fop.fo.FONode;
- import org.apache.fop.fo.PropertyList;
- import org.apache.fop.fo.ValidationException;
- import org.apache.fop.fo.properties.CommonAccessibility;
- import org.apache.fop.fo.properties.CommonAccessibilityHolder;
- import org.apache.fop.fo.properties.CommonBorderPaddingBackground;
- import org.apache.fop.fo.properties.LengthRangeProperty;
-
- /**
- * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-cell">
- * <code>fo:table-cell</code></a> object.
- */
- public class TableCell extends TableFObj implements CommonAccessibilityHolder {
- // The value of properties relevant for fo:table-cell.
- private CommonAccessibility commonAccessibility;
- private CommonBorderPaddingBackground commonBorderPaddingBackground;
- private LengthRangeProperty blockProgressionDimension;
- private int columnNumber;
- private int displayAlign;
- private int emptyCells;
- private int endsRow;
- private int numberColumnsSpanned;
- private int numberRowsSpanned;
- private int startsRow;
- private Length width;
- // Unused but valid items, commented out for performance:
- // private CommonAural commonAural;
- // private CommonRelativePosition commonRelativePosition;
- // private int relativeAlign;
- // private Length height;
- // private LengthRangeProperty inlineProgressionDimension;
- // private KeepProperty keepTogether;
- // private KeepProperty keepWithNext;
- // private KeepProperty keepWithPrevious;
- // End of property values
-
- /** used for FO validation */
- private boolean blockItemFound = false;
-
- private boolean hasRetrieveTableMarker;
-
- /**
- * Create a TableCell instance with the given {@link FONode}
- * as parent.
- * @param parent {@link FONode} that is the parent of this object
- */
- public TableCell(FONode parent) {
- super(parent);
- }
-
- /**
- * {@inheritDoc}
- */
- public void bind(PropertyList pList) throws FOPException {
- super.bind(pList);
- commonAccessibility = CommonAccessibility.getInstance(pList);
- commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
- blockProgressionDimension = pList.get(PR_BLOCK_PROGRESSION_DIMENSION).getLengthRange();
- displayAlign = pList.get(PR_DISPLAY_ALIGN).getEnum();
- emptyCells = pList.get(PR_EMPTY_CELLS).getEnum();
- startsRow = pList.get(PR_STARTS_ROW).getEnum();
- // For properly computing columnNumber
- if (startsRow() && getParent().getNameId() != FO_TABLE_ROW) {
- ((TablePart) getParent()).signalNewRow();
- }
- endsRow = pList.get(PR_ENDS_ROW).getEnum();
- columnNumber = pList.get(PR_COLUMN_NUMBER).getNumeric().getValue();
- numberColumnsSpanned = pList.get(PR_NUMBER_COLUMNS_SPANNED).getNumeric().getValue();
- numberRowsSpanned = pList.get(PR_NUMBER_ROWS_SPANNED).getNumeric().getValue();
- width = pList.get(PR_WIDTH).getLength();
- }
-
- /** {@inheritDoc} */
- protected void startOfNode() throws FOPException {
- super.startOfNode();
- getFOEventHandler().startCell(this);
- }
-
- /**
- * Make sure content model satisfied, if so then tell the
- * FOEventHandler that we are at the end of the table-cell.
- * {@inheritDoc}
- */
- protected void endOfNode() throws FOPException {
- super.endOfNode();
- getFOEventHandler().endCell(this);
- }
-
- /** {@inheritDoc} */
- public void finalizeNode() throws FOPException {
-
- if (!blockItemFound) {
- missingChildElementError("marker* (%block;)+", true);
- }
- if ((startsRow() || endsRow())
- && getParent().getNameId() == FO_TABLE_ROW ) {
- TableEventProducer eventProducer = TableEventProducer.Provider.get(
- getUserAgent().getEventBroadcaster());
- eventProducer.startEndRowUnderTableRowWarning(this, getLocator());
- }
-
- }
-
- /**
- * {@inheritDoc}
- * <br>XSL Content Model: marker* (%block;)+
- */
- protected void validateChildNode(Locator loc, String nsURI, String localName)
- throws ValidationException {
- if (FO_URI.equals(nsURI)) {
- if (localName.equals("marker")) {
- if (blockItemFound) {
- nodesOutOfOrderError(loc, "fo:marker", "(%block;)");
- }
- } else if (!isBlockItem(nsURI, localName)) {
- invalidChildError(loc, nsURI, localName);
- } else {
- blockItemFound = true;
- }
- }
- }
-
- /** {@inheritDoc} */
- public boolean generatesReferenceAreas() {
- return true;
- }
-
- /** {@inheritDoc} */
- public CommonAccessibility getCommonAccessibility() {
- return commonAccessibility;
- }
-
- /**
- * Get the {@link CommonBorderPaddingBackground} instance
- * attached to this TableCell.
- * @return the {@link CommonBorderPaddingBackground} instance
- */
- public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
- return this.commonBorderPaddingBackground;
- }
-
- /**
- * Get the value for the <code>column-number</code> property.
- * @return the "column-number" property.
- */
- public int getColumnNumber() {
- return columnNumber;
- }
-
- /**
- * Get the value for the <code>empty-cells</code> property.
- * @return true if "empty-cells" is "show"
- */
- public boolean showEmptyCells() {
- return (this.emptyCells == EN_SHOW);
- }
-
- /**
- * Get the value for the <code>number-columns-spanned</code> property
- * @return the "number-columns-spanned" property.
- */
- public int getNumberColumnsSpanned() {
- return Math.max(numberColumnsSpanned, 1);
- }
-
- /**
- * Get the value for the <code>number-rows-spanned</code> property
- * @return the "number-rows-spanned" property.
- */
- public int getNumberRowsSpanned() {
- return Math.max(numberRowsSpanned, 1);
- }
-
- /**
- * Get the value for the <code>block-progression-dimension</code> property
- * @return the "block-progression-dimension" property.
- */
- public LengthRangeProperty getBlockProgressionDimension() {
- return blockProgressionDimension;
- }
-
- /**
- * Get the value for the <code>display-align</code> property
- * @return the display-align property.
- */
- public int getDisplayAlign() {
- return displayAlign;
- }
-
- /**
- * Get the value for the <code>width</code> property
- * @return the "width" property.
- */
- public Length getWidth() {
- return width;
- }
-
- /**
- * Get the value for the <code>starts-row</code> property
- * @return true if the cell starts a row.
- */
- public boolean startsRow() {
- return (startsRow == EN_TRUE);
- }
-
- /**
- * Get the value for the <code>ends-row</code> property
- * @return true if the cell ends a row.
- */
- public boolean endsRow() {
- return (endsRow == EN_TRUE);
- }
-
- /** {@inheritDoc} */
- public String getLocalName() {
- return "table-cell";
- }
-
- /**
- * {@inheritDoc}
- * @return {@link org.apache.fop.fo.Constants#FO_TABLE_CELL}
- */
- public final int getNameId() {
- return FO_TABLE_CELL;
- }
-
- public void flagAsHavingRetrieveTableMarker() {
- hasRetrieveTableMarker = true;
- }
-
- public boolean hasRetrieveTableMarker() {
- return hasRetrieveTableMarker;
- }
- }
|