Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
     Licensed to Plutext Pty Ltd under one or more contributor license agreements.  
     
   *  This file is part of docx4j.
  
      docx4j is licensed 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.
 
  */
 package org.docx4j.convert.out.common.writer;
 
 import java.util.List;
 import java.util.Map;
 
 
 
 /*
  *  @author Alberto Zerolo, Adam Schmideg, Jason Harrop
  *  @since 3.0.0
  *  
 */
 public abstract class AbstractTableWriter extends AbstractSimpleWriter {
 	public static final String WRITER_ID = "w:tbl";
 	
   
   protected static final int NODE_TABLE = 0;
   protected static final int NODE_TABLE_COLUMN_GROUP = 1;
   protected static final int NODE_TABLE_COLUMN = 2;
   protected static final int NODE_TABLE_HEADER = 3;
   protected static final int NODE_TABLE_HEADER_ROW = 4;
   protected static final int NODE_TABLE_HEADER_CELL = 5;
   protected static final int NODE_TABLE_BODY = 6;
   protected static final int NODE_TABLE_BODY_ROW = 7;
   protected static final int NODE_TABLE_BODY_CELL = 8;
   
   protected static final Map<StringIntegerPATTERN_PERCENTAGES = new TreeMap<StringInteger>();
   
   static {
 	  /*
 	   * These patterns cause a reset
 	  PATTERN_PERCENTAGES.put("clear", -1);
 	  PATTERN_PERCENTAGES.put("nil", -1);
 
 	   * and these can't be aproximated by a background color
 	   * so they are ignored
 	  PATTERN_PERCENTAGES.put("diagStripe", -1);
 	  PATTERN_PERCENTAGES.put("horzStripe", -1);
 	  PATTERN_PERCENTAGES.put("thinDiagStripe", -1);
 	  PATTERN_PERCENTAGES.put("thinHorzStripe", -1);
	  PATTERN_PERCENTAGES.put("thinReverseDiagStripe", -1);
	  PATTERN_PERCENTAGES.put("thinVertStripe", -1);
	  PATTERN_PERCENTAGES.put("vertStripe", -1);
	   */
	  
	  
	  // These Patterns are aproximated by a background color
	  .put("diagCross", 50);
	  .put("horzCross", 50);
	  .put("thinDiagCross", 25);
	  .put("thinHorzCross", 25);
	  .put("pct5", 5);
	  .put("pct10", 10);
	  .put("pct12", 12);
	  .put("pct15", 15);
	  .put("pct20", 20);
	  .put("pct25", 25);
	  .put("pct30", 30);
	  .put("pct35", 35);
	  .put("pct37", 37);
	  .put("pct40", 40);
	  .put("pct45", 45);
	  .put("pct50", 50);
	  .put("pct55", 55);
	  .put("pct60", 60);
	  .put("pct62", 62);
	  .put("pct65", 65);
	  .put("pct70", 70);
	  .put("pct75", 75);
	  .put("pct80", 80);
	  .put("pct85", 85);
	  .put("pct87", 87);
	  .put("pct90", 90);
	  .put("pct95", 95);
	  .put("solid", 100);
  }
	protected static class TableModelTransformState implements TransformState {
		// The last table number, in document order,
		// which we have processed. 
		// The idea is to be able to write an id (unique within the document) to each
		// table.
		int idx = 0;

Returns:
the idx
		public int getIdx() {
			return ;
		}

Parameters:
idx the idx to set
		public void incrementIdx() {
			++;
		}
	}
	  
	protected AbstractTableWriter() {
		super();
	}
	}
	public Node toNode(AbstractWmlConversionContext contextObject unmarshalledNodeNode contentTransformState transformStateDocument docthrows TransformerException {
		Node ret = null;
	    
	    table.build(contextunmarshalledNodecontent);
	    if (getLog().isDebugEnabled()) {
	        getLog().debug("Table asXML:\n" + table.debugStr());
	    }
	    
	    if (!table.getCells().isEmpty()) {
	    	ret = toNode(contexttabletransformStatedoc);
	    }
	    return ret;
	}
  protected Node toNode(AbstractWmlConversionContext contextAbstractTableWriterModel tableTransformState transformStateDocument docthrows TransformerException {
    Element tableRoot = createNode(docnull);
    List<PropertyrowProperties = new ArrayList<Property>();
    int rowPropertiesTableSize = -1;
    
    List<PropertycellProperties = new ArrayList<Property>();
    int cellPropertiesTableSize = -1;
    int cellPropertiesRowSize = -1;
    boolean inHeader = (table.getHeaderMaxRow() > -1);
	AbstractTableWriterModelRow rowModel = null;
	Element rowContainer = null;
	Element row = null;
	Element cellNode = null;
    
    createRowProperties(rowPropertiestable.getEffectiveTableStyle().getTrPr(), true);
    rowPropertiesTableSize = rowProperties.size();
    createCellProperties(cellPropertiestable.getEffectiveTableStyle().getTrPr());
    createCellProperties(cellPropertiestable.getEffectiveTableStyle().getTcPr());
	// will apply these as a default on each td, and then override
    createCellProperties(cellPropertiestable.getEffectiveTableStyle().getTblPr());
    cellPropertiesTableSize = cellProperties.size();
    
    docfrag.appendChild(tableRoot);
	applyTableStyles(contexttabletransformStatetableRoot);
	// setup column widths
    createColumns(contexttabletransformStatedoctableRoot);
	rowContainer = createNode(doctableRoot, (inHeader ?  : ));
	tableRoot.appendChild(rowContainer);
	applyTableRowContainerCustomAttributes(contexttabletransformStaterowContainerinHeader);
    for (int rowIndex = 0; rowIndex < table.getCells().size(); rowIndex++) {
			rowModel = table.getCells().get(rowIndex);
			if ((inHeader) && (rowIndex > table.getHeaderMaxRow())) {
				rowContainer = createNode(doctableRoot);
				tableRoot.appendChild(rowContainer);
				inHeader = false;
				applyTableRowContainerCustomAttributes(contexttabletransformStaterowContainerinHeader);
			}
			row = createNode(docrowContainer, (inHeader ?  : ));
			TrPr trPr = rowModel.getRowProperties();
			CTTblPrEx tblPrEx = rowModel.getRowPropertiesExceptions();
			createRowProperties(rowPropertiestrPrfalse);
			processAttributes(contextrowPropertiesrow);
			applyTableRowCustomAttributes(contexttabletransformStaterowrowIndexinHeader);
			createCellProperties(cellPropertiestrPr);
			createCellProperties(cellPropertiestblPrEx);
			cellPropertiesRowSize = cellProperties.size();
			for (AbstractTableWriterModelCell cell : rowModel.getRowContents()) {
				// process cell
				if (cell.isDummy()) {
					if (!cell.isVMerged()) {
						//Dummy-Cells resulting from vertical merged cells shouldn't be included
						cellNode = createNode(docrow, (inHeader ?  : ));
						row.appendChild(cellNode);
						applyTableCellCustomAttributes(contexttabletransformStatecellcellNodeinHeadertrue);
					}
				}
				else {
					cellNode = createNode(docrow, (inHeader ?  : ));
					row.appendChild(cellNode);
					//Apply cell style
					createCellProperties(cellPropertiescell.getTcPr());
					processAttributes(contextcellPropertiescellNode);
					applyTableCellCustomAttributes(contexttabletransformStatecellcellNodeinHeaderfalse);
					//remove properties defined on cell level
					resetProperties(cellPropertiescellPropertiesRowSize);
					// insert content into cell
					// skipping w:tc node itself, insert only its children
					if (cell.getContent() == null) {
						getLog().warn("model cell had no contents!");
else {
						getLog().debug("copying cell contents..");
								cellNode);
					}
				}
			}
			//remove properties defined on row level
			resetProperties(cellPropertiescellPropertiesTableSize);
			resetProperties(rowPropertiesrowPropertiesTableSize);
		}
		return docfrag;
  	}
  	
  	protected Element createNode(Document docElement parentint nodeType) {
  	Element ret = createNode(docnodeType);
  		if ((ret != null) && (parent != null)) {
  			parent.appendChild(ret);
  		}
  		return (ret != null ? ret : parent);
  	}
	protected void createColumns(AbstractWmlConversionContext contextAbstractTableWriterModel tableTransformState transformStateDocument docElement tableRootthrows DOMException {
		List<TblGridColgridCols = (table.getTblGrid() != null ? table.getTblGrid().getGridCol() : null);
		Element columnGroup = createNode(doctableRoot);
		Element column = null;
		applyColumnGroupCustomAttributes(contexttabletransformStatecolumnGroup);
    	if ((gridCols != null) && (!gridCols.isEmpty())) {
	    	for(int i=0; i<gridCols.size(); i++) {
		        column = createNode(doccolumnGroup);
	    		applyColumnCustomAttributes(contexttabletransformStatecolumnigridCols.get(i).getW().intValue());
	    	}
    	}
    	else {
	    	for(int i=0; i<table.getColCount(); i++) {
		        column = createNode(doccolumnGroup);
	    		applyColumnCustomAttributes(contexttabletransformStatecolumni, -1);
	    	}
    	}
	}
	protected void applyTableStyles(AbstractWmlConversionContext contextAbstractTableWriterModel tableTransformState transformStateElement tableRoot) {
	List<PropertytableProperties = null;
		// This handles:
		// - position (tblPr/tblInd)
		// - table-layout
		tableProperties = PropertyFactory.createProperties(table.getEffectiveTableStyle().getTblPr());
		// Borders, shading
		if (table.getEffectiveTableStyle().getTcPr()!=null) {
			PropertyFactory.createPropertiesTable(tablePropertiestable.getEffectiveTableStyle().getTcPr());
		}
		// vAlign fix: match Word's default of top
		if (table.getEffectiveTableStyle().getTcPr()==null
				|| table.getEffectiveTableStyle().getTcPr().getVAlign()==null) {
			tableProperties.add(new TextAlignmentVertical());
		}	
		if (!table.isDrawTableBorders()) {
			//isn't nice, but better than passing a lot of flags to the PropertyFactory
			//1. remove any borders and shading
			for (int i=tableProperties.size()-1; i>=0; i--) {
				if ((tableProperties.get(iinstanceof Shading) ||
					(tableProperties.get(iinstanceof AbstractBorder)) {
					tableProperties.remove(i);
				}
			}
			//2. apply explicit none-borders and transparent shading 
			//   (in html there might be borders and shading inherited from the class)
		}
		processAttributes(contexttablePropertiestableRoot);
		applyTableCustomAttributes(contexttabletransformStatetableRoot);
	}
	protected void appendNoneBordersAndShading(List<PropertytableProperties) {
	CTBorder ctBrdr = null;
		ctBrdr = Context.getWmlObjectFactory().createCTBorder();
		tableProperties.add(new BorderLeft(ctBrdr));
		ctBrdr = Context.getWmlObjectFactory().createCTBorder();
		tableProperties.add(new BorderRight(ctBrdr));
		ctBrdr = Context.getWmlObjectFactory().createCTBorder();
		tableProperties.add(new BorderTop(ctBrdr));
		ctBrdr = Context.getWmlObjectFactory().createCTBorder();
		tableProperties.add(new BorderBottom(ctBrdr));
		shd.setColor("auto");
		shd.setFill("auto");
		tableProperties.add(new Shading(shd));
	}
	protected void createRowProperties(List<PropertypropertiesTrPr trPrboolean includeDefaultHeight) {
	JAXBElement<CTHeighttrHeight = (trPr != null ? 
				null);
		if (trHeight != null) {
			properties.add(new TrHeight(trHeight.getValue()));
		}
	}
	protected void createCellProperties(List<PropertypropertiesTrPr trPr) {
	}
	protected void createCellProperties(List<PropertypropertiesCTTblPrBase tblPr) {
	TblBorders tblBorders = tblPr.getTblBorders();
	CTTblCellMar tblCellMargin = tblPr.getTblCellMar();
		if (tblBorders!=null) {
			if (tblBorders.getInsideH()!=null) {
				properties.add(new BorderTop(tblBorders.getTop()));
				properties.add(new BorderBottom(tblBorders.getBottom()));
			}
			if (tblBorders.getInsideV()!=null) { 
				properties.add(new BorderRight(tblBorders.getRight()));
				properties.add(new BorderLeft(tblBorders.getLeft()));
			}						
		}
		if (tblCellMargin != null) {
			if (tblCellMargin.getTop() != null)
				properties.add(new CellMarginTop(tblCellMargin.getTop()));
			if (tblCellMargin.getBottom() != null)
				properties.add(new CellMarginBottom(tblCellMargin.getBottom()));
			if (tblCellMargin.getLeft() != null)
				properties.add(new CellMarginLeft(tblCellMargin.getLeft()));
			if (tblCellMargin.getRight() != null)
				properties.add(new CellMarginRight(tblCellMargin.getRight()));
		}
	}
	protected void createCellProperties(List<PropertypropertiesTcPr tcPr) {
		if (tcPr != null) {
			PropertyFactory.createProperties(propertiestcPr);
		}
	}
	protected void createCellProperties(List<PropertypropertiesCTTblPrEx tblPrEx) {
	}
	protected JAXBElement<?> getElement(List<JAXBElement<?>> cnfStyleOrDivIdOrGridBeforeString localName) {
		JAXBElement<?> element = null;
		if ((cnfStyleOrDivIdOrGridBefore != null) && (!cnfStyleOrDivIdOrGridBefore.isEmpty())) {
			for (int i=0; i<cnfStyleOrDivIdOrGridBefore.size(); i++) {
				element = cnfStyleOrDivIdOrGridBefore.get(i);
				if (localName.equals(element.getName().getLocalPart())) {
					return element;
				}
			}
		}
		return null;
	}
	protected void processAttributes(AbstractWmlConversionContext contextList<PropertypropertiesElement element) {
	CTShd shd = null;
	int bgColor = 0xffffff; //the background color of the page is assumed as white
	int fgColor = 0; //the default color of the font is assumed as black
	int pctPattern = -1;
		for (int i=0; i<properties.size(); i++) {
			if (properties.get(iinstanceof Shading) {
				shd = (CTShd)properties.get(i).getObject();
				fgColor = extractColor(shd.getColor(), 0); 
				if ((shd.getVal() != null) &&
					("clear".equals(shd.getVal().value())) &&	
					("auto".equals(shd.getFill()))
					) {
					//This is a reset to the background color of the page, 
					//it is treated as an special case, as the background color 
					//isn't inherited
					bgColor = 0xffffff;
					pctPattern = -2;
				}
				else {
					pctPattern = (shd.getVal() != null ? extractPattern(shd.getVal().value()) : -1);
					bgColor = extractColor(shd.getFill(), bgColor);
				}
			}
		}
		if (pctPattern == -1) {
			applyAttributes(contextpropertieselement);
		}
		else {
			properties.add(createShading(fgColorbgColorpctPattern));
			applyAttributes(contextpropertieselement);
			properties.remove(properties.size() - 1);
		}
	}
	protected int extractPattern(String pattern) {
		return ((pattern != null) && 
				.get(pattern) : -1);
	}
	protected int extractColor(String valueint defaultColor) {
	int ret = defaultColor;
		if ((value != null) && (!"auto".equals(value))) {
			try {
				ret = Integer.parseInt(value, 16);
			}
			catch (NumberFormatException nfe){//noop
			}
		}
		return ret;
	}
	protected Property createShading(int fgColorint bgColorint pctFg) {
	CTShd shd = null;
	int resColor = UnitsOfMeasurement.combineColors(fgColorbgColorpctFg);
		shd = Context.getWmlObjectFactory().createCTShd();
		shd.setFill(calcHexColor(resColor));
		return new Shading(shd);
	}
	protected String calcHexColor(int value) {
	String	ret = Integer.toHexString(value).toUpperCase();
		return (ret.length() < 6 ?
				"000000".substring(0, 6 - ret.length()) + ret :
				ret);
	}
	protected void resetProperties(List<Propertypropertiesint size) {
		while (properties.size() > sizeproperties.remove(properties.size() - 1);
	}
	/*
	 *  These are the main methods the subclasses have to or should override
	 */
	protected abstract Logger getLog();
  	protected abstract Element createNode(Document docint nodeType);
	protected abstract void applyAttributes(AbstractWmlConversionContext contextList<PropertypropertiesElement element);
	  
	protected void applyTableCustomAttributes(AbstractWmlConversionContext contextAbstractTableWriterModel tableTransformState transformStateElement tableRoot) {
	}
	protected void applyColumnGroupCustomAttributes(AbstractWmlConversionContext contextAbstractTableWriterModel tableTransformState transformStateElement columnGroup) {
	}
	protected void applyColumnCustomAttributes(AbstractWmlConversionContext contextAbstractTableWriterModel tableTransformState transformStateElement columnint columnIndexint columnWidth) {
	}
  	protected void applyTableRowContainerCustomAttributes(AbstractWmlConversionContext contextAbstractTableWriterModel tableTransformState transformStateElement rowContainerboolean isHeader) {
  	}
    
  	protected void applyTableRowCustomAttributes(AbstractWmlConversionContext contextAbstractTableWriterModel tableTransformState transformStateElement rowint rowIndexboolean isHeader) {  		
  	}
  	
  	protected void applyTableCellCustomAttributes(AbstractWmlConversionContext contextAbstractTableWriterModel tableTransformState transformStateAbstractTableWriterModelCell tableCellElement cellNodeboolean isHeaderboolean isDummyCell) {
  	}
New to GrepCode? Check out our FAQ X