123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278 |
- /*
- * 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;
-
- // XML
- import org.xml.sax.Locator;
-
- import org.apache.fop.apps.FOPException;
- import org.apache.fop.datatypes.Length;
- import org.apache.fop.fo.Constants;
- import org.apache.fop.fo.FONode;
- import org.apache.fop.fo.PropertyList;
- import org.apache.fop.fo.ValidationException;
- import org.apache.fop.fo.expr.PropertyException;
- import org.apache.fop.fo.properties.CommonBorderPaddingBackground;
- import org.apache.fop.fo.properties.Property;
- import org.apache.fop.fo.properties.TableColLength;
- import org.apache.fop.layoutmgr.table.CollapsingBorderModel;
-
- /**
- * Class modelling the <a href="http://www.w3.org/TR/xsl/#fo_table-column">
- * <code>fo:table-column</code></a> object.
- */
- public class TableColumn extends TableFObj {
- // The value of properties relevant for fo:table-column.
- private CommonBorderPaddingBackground commonBorderPaddingBackground;
- private int columnNumber;
- private Length columnWidth;
- private int numberColumnsRepeated;
- private int numberColumnsSpanned;
- private boolean isHeader;
- // Unused but valid items, commented out for performance:
- // private int visibility;
- // End of property values
-
- private boolean implicitColumn;
- private PropertyList pList = null;
-
- /**
- * Create a TableColumn instance with the given {@link FONode}
- * as parent.
- *
- * @param parent {@link FONode} that is the parent of this object
- */
- public TableColumn(FONode parent) {
- this(parent, false);
- }
-
- /**
- * Create a TableColumn instance with the given {@link FONode}
- * as parent
- *
- * @param parent FONode that is the parent of this object
- * @param implicit true if this table-column has automatically been created (does not
- * correspond to an explicit fo:table-column in the input document)
- */
- public TableColumn(FONode parent, boolean implicit) {
- super(parent);
- this.implicitColumn = implicit;
- }
-
-
- /** {@inheritDoc} */
- public void bind(PropertyList pList) throws FOPException {
- commonBorderPaddingBackground = pList.getBorderPaddingBackgroundProps();
- columnNumber = pList.get(PR_COLUMN_NUMBER).getNumeric().getValue();
- columnWidth = pList.get(PR_COLUMN_WIDTH).getLength();
- numberColumnsRepeated = pList.get(PR_NUMBER_COLUMNS_REPEATED)
- .getNumeric().getValue();
- numberColumnsSpanned = pList.get(PR_NUMBER_COLUMNS_SPANNED)
- .getNumeric().getValue();
- super.bind(pList);
-
- if (numberColumnsRepeated <= 0) {
- TableEventProducer eventProducer = TableEventProducer.Provider.get(
- getUserAgent().getEventBroadcaster());
- eventProducer.valueMustBeBiggerGtEqOne(this,
- "number-columns-repeated", numberColumnsRepeated, getLocator());
- }
- if (numberColumnsSpanned <= 0) {
- TableEventProducer eventProducer = TableEventProducer.Provider.get(
- getUserAgent().getEventBroadcaster());
- eventProducer.valueMustBeBiggerGtEqOne(this,
- "number-columns-spanned", numberColumnsSpanned, getLocator());
- }
-
- /* check for unspecified width and replace with default of
- * proportional-column-width(1), in case of fixed table-layout
- * warn only for explicit columns
- */
- if (columnWidth.getEnum() == EN_AUTO) {
- if (!this.implicitColumn && !getTable().isAutoLayout()) {
- TableEventProducer eventProducer = TableEventProducer.Provider.get(
- getUserAgent().getEventBroadcaster());
- eventProducer.warnImplicitColumns(this, getLocator());
- }
- columnWidth = new TableColLength(1.0, this);
- }
-
- /* in case of explicit columns, from-table-column()
- * can be used on descendants of the table-cells, so
- * we need a reference to the column's property list
- * (cleared in Table.endOfNode())
- */
- if (!this.implicitColumn) {
- this.pList = pList;
- }
- isHeader = (pList.get(Constants.PR_X_HEADER_COLUMN).getEnum() == Constants.EN_TRUE);
- }
-
- /** {@inheritDoc} */
- public void startOfNode() throws FOPException {
- super.startOfNode();
- getFOEventHandler().startColumn(this);
- }
-
- void setCollapsedBorders(CollapsingBorderModel collapsingBorderModel) {
- this.collapsingBorderModel = collapsingBorderModel;
- setCollapsedBorders();
- }
-
- /** {@inheritDoc} */
- public void endOfNode() throws FOPException {
- getFOEventHandler().endColumn(this);
- }
-
- /**
- * {@inheritDoc}
- * <br>XSL Content Model: empty
- */
- protected void validateChildNode(Locator loc,
- String nsURI, String localName)
- throws ValidationException {
- if (FO_URI.equals(nsURI)) {
- invalidChildError(loc, nsURI, localName);
- }
- }
-
- /**
- * Get the {@link CommonBorderPaddingBackground} instance
- * attached to this TableColumn.
- * @return the {@link CommonBorderPaddingBackground} instance
- */
- public CommonBorderPaddingBackground getCommonBorderPaddingBackground() {
- return commonBorderPaddingBackground;
- }
-
- /**
- * Get a {@link Length} instance corresponding to the
- * <code>column-width</code> property.
- * @return the "column-width" property.
- */
- public Length getColumnWidth() {
- return columnWidth;
- }
-
- /**
- * Sets the column width.
- * @param columnWidth the column width
- */
- public void setColumnWidth(Length columnWidth) {
- this.columnWidth = columnWidth;
- }
-
- /**
- * Get the value of the <code>column-number</code> property
- * @return the "column-number" property.
- */
- public int getColumnNumber() {
- return columnNumber;
- }
-
- /**
- * Used for setting the column-number for an implicit column
- * @param columnNumber the number to set
- */
- protected void setColumnNumber(int columnNumber) {
- this.columnNumber = columnNumber;
- }
-
- /** @return value for number-columns-repeated. */
- public int getNumberColumnsRepeated() {
- return numberColumnsRepeated;
- }
-
- /** @return value for number-columns-spanned. */
- public int getNumberColumnsSpanned() {
- return numberColumnsSpanned;
- }
-
- /** {@inheritDoc} */
- public String getLocalName() {
- return "table-column";
- }
-
- /**
- * {@inheritDoc}
- * @return {@link org.apache.fop.fo.Constants#FO_TABLE_COLUMN}
- */
- public int getNameId() {
- return FO_TABLE_COLUMN;
- }
-
- /**
- * Indicates whether this table-column has been created as
- * default column for this table in case no table-columns
- * have been defined.
- * Note that this only used to provide better
- * user feedback (see ColumnSetup).
- * @return true if this table-column has been created as default column
- */
- public boolean isImplicitColumn() {
- return implicitColumn;
- }
-
- /** {@inheritDoc} */
- public String toString() {
- StringBuffer sb = new StringBuffer("fo:table-column");
- sb.append(" column-number=").append(getColumnNumber());
- if (getNumberColumnsRepeated() > 1) {
- sb.append(" number-columns-repeated=")
- .append(getNumberColumnsRepeated());
- }
- if (getNumberColumnsSpanned() > 1) {
- sb.append(" number-columns-spanned=")
- .append(getNumberColumnsSpanned());
- }
- sb.append(" column-width=").append(((Property)getColumnWidth()).getString());
- return sb.toString();
- }
-
- /**
- * Retrieve a property value through its Id; used by
- * from-table-column() function
- *
- * @param propId the id for the property to retrieve
- * @return the requested Property
- * @throws PropertyException if there is a problem evaluating the property
- */
- public Property getProperty(int propId) throws PropertyException {
- return this.pList.get(propId);
- }
-
- /**
- * Clear the reference to the PropertyList (retained for
- * from-table-column())
- */
- protected void releasePropertyList() {
- this.pList = null;
- }
-
- /**
- * Returns {@code true} if this column is made of header cells.
- *
- * @return {@code true} if cells in this column are like TH cells in HTML
- */
- public boolean isHeader() {
- return isHeader;
- }
-
- }
|