Make the new properties configurable with the UI like the others

eclipse-birt · Jan 7, 2025 · f1b3063 · f1b3063
1 parent bb4fe70
commit f1b3063
Show file tree

Hide file tree

Showing 9 changed files with 78 additions and 6 deletions.
diff --git a/....spudsoft.birt.emitters.excel/src/uk/co/spudsoft/birt/emitters/excel/EmitterServices.java b/....spudsoft.birt.emitters.excel/src/uk/co/spudsoft/birt/emitters/excel/EmitterServices.java
@@ -354,6 +354,12 @@ private static Object getReportDesignConfiguration(IReportContent reportContent,
 		} else if (name.equalsIgnoreCase(ExcelEmitter.FORCEAUTOCOLWIDTHS_PROP)) {
 			value = reportContent.getDesign().getReportDesign().getExcelForceAutoColWidths();
 
+		} else if (name.equalsIgnoreCase(ExcelEmitter.AUTO_COL_WIDTHS_INCLUDE_TABLE_HEADER)) {
+			value = reportContent.getDesign().getReportDesign().getExcelAutoColWidthsIncludeTableHeader();
+
+		} else if (name.equalsIgnoreCase(ExcelEmitter.AUTO_COL_WIDTHS_INCLUDE_TABLE_FOOTER)) {
+			value = reportContent.getDesign().getReportDesign().getExcelAutoColWidthsIncludeTableFooter();
+
 		} else if (name.equalsIgnoreCase(ExcelEmitter.IMAGE_SCALING_CELL_DIMENSION)) {
 			value = reportContent.getDesign().getReportDesign().getExcelImageScaling();
 

diff --git a/....co.spudsoft.birt.emitters.excel/src/uk/co/spudsoft/birt/emitters/excel/ExcelEmitter.java b/....co.spudsoft.birt.emitters.excel/src/uk/co/spudsoft/birt/emitters/excel/ExcelEmitter.java
@@ -74,10 +74,10 @@ public abstract class ExcelEmitter implements IContentEmitter {
 	public static final String FORCEAUTOCOLWIDTHS_PROP = "ExcelEmitter.ForceAutoColWidths";
 
 	/** property: ExcelEmitter.ForceAutoColWidthsIncludeTableHeader */
-	public static final String AUTO_COL_WIDTHS_HEADER = "ExcelEmitter.AutoColWidthsIncludeTableHeader";
+	public static final String AUTO_COL_WIDTHS_INCLUDE_TABLE_HEADER = "ExcelEmitter.AutoColWidthsIncludeTableHeader";
 
 	/** property: ExcelEmitter.ForceAutoColWidthsIncludeTableFooter */
-	public static final String AUTO_COL_WIDTHS_FOOTER = "ExcelEmitter.AutoColWidthsIncludeTableFooter";
+	public static final String AUTO_COL_WIDTHS_INCLUDE_TABLE_FOOTER = "ExcelEmitter.AutoColWidthsIncludeTableFooter";
 
 	/** property: ExcelEmitter.SingleSheet */
 	public static final String SINGLE_SHEET = "ExcelEmitter.SingleSheet";

diff --git a/...o.spudsoft.birt.emitters.excel/src/uk/co/spudsoft/birt/emitters/excel/README.md b/...o.spudsoft.birt.emitters.excel/src/uk/co/spudsoft/birt/emitters/excel/README.md
@@ -23,23 +23,23 @@ The following list get an overview of all supported user properties, the content
 **ExcelEmitter.AutoColWidthsIncludeTableFooter**
 
 	Content   	define if the table footer row (only one footer row is supported) is included in the column width calculation.
-					This is only used when ExcelEmitter.AutoFilter is true.
 	Location  	report
 	Data type 	boolean
 	Values    	true, the table footer row is included in the column width calculation
 	           	false, the table footer row is ignored in the column width calculation
 	Default   	false
+	Since			4.19
 	Designer  	4.19
 
 **ExcelEmitter.AutoColWidthsIncludeTableHeader**
 
 	Content   	define if the table header rows are included in the column width calculation.
-					This is only used when ExcelEmitter.AutoFilter is true.
 	Location  	report
 	Data type 	boolean
 	Values    	true, the table header rows are included in the column width calculation
 	           	false, the table header rows are ignored in the column width calculation
 	Default   	false
+	Since			4.19
 	Designer  	4.19
 
 

diff --git a/...tters.excel/src/uk/co/spudsoft/birt/emitters/excel/handlers/AbstractRealTableHandler.java b/...tters.excel/src/uk/co/spudsoft/birt/emitters/excel/handlers/AbstractRealTableHandler.java
@@ -164,12 +164,14 @@ public void endTable(HandlerState state, ITableContent table) throws BirtExcepti
 		log.debug("Details rows from ", startDetailsRow, " to ", endDetailsRow);
 
 		int autoWidthStartRow = startDetailsRow;
-		if (EmitterServices.booleanOption(state.getRenderOptions(), table, ExcelEmitter.AUTO_COL_WIDTHS_HEADER,
+		if (EmitterServices.booleanOption(state.getRenderOptions(), table,
+				ExcelEmitter.AUTO_COL_WIDTHS_INCLUDE_TABLE_HEADER,
 				false)) {
 			autoWidthStartRow = startRow;
 		}
 		int autoWidthEndRow = endDetailsRow;
-		if (EmitterServices.booleanOption(state.getRenderOptions(), table, ExcelEmitter.AUTO_COL_WIDTHS_FOOTER,
+		if (EmitterServices.booleanOption(state.getRenderOptions(), table,
+				ExcelEmitter.AUTO_COL_WIDTHS_INCLUDE_TABLE_FOOTER,
 				false)) {
 			autoWidthEndRow = state.rowNum - 1;
 		}

diff --git a/...lipse.birt.report.model/src/org/eclipse/birt/report/model/api/ReportDesignHandleImpl.java b/...lipse.birt.report.model/src/org/eclipse/birt/report/model/api/ReportDesignHandleImpl.java
@@ -1434,6 +1434,48 @@ public void setExcelForceAutoColWidths(boolean forceAutoColWidths) throws Semant
 		setBooleanProperty(EXCEL_FORCE_AUTO_COL_WIDTHS, forceAutoColWidths);
 	}
 
+	/**
+	 * Get the auto column width include header flag for the excel output
+	 *
+	 * @return include the header rows in auto columns widths calculation or not
+	 */
+	public boolean getExcelAutoColWidthsIncludeTableHeader() {
+		return getBooleanProperty(EXCEL_AUTO_COL_WIDTHS_INCLUDE_TABLE_HEADER);
+	}
+
+	/**
+	 * Set the auto column width include header flag for the excel output
+	 *
+	 * @param autoColWidthsIncludeTableHeader include header rows in auto columns widths
+	 *                                   calculation
+	 * @throws SemanticException
+	 */
+	public void setExcelAutoColWidthsIncludeTableHeader(boolean autoColWidthsIncludeTableHeader)
+			throws SemanticException {
+		setBooleanProperty(EXCEL_AUTO_COL_WIDTHS_INCLUDE_TABLE_HEADER, autoColWidthsIncludeTableHeader);
+	}
+
+	/**
+	 * Get the auto column width include footer flag for the excel output
+	 *
+	 * @return include the footer row in auto columns widths calculation or not
+	 */
+	public boolean getExcelAutoColWidthsIncludeTableFooter() {
+		return getBooleanProperty(EXCEL_AUTO_COL_WIDTHS_INCLUDE_TABLE_FOOTER);
+	}
+
+	/**
+	 * Set the auto column width include footer flag for the excel output
+	 *
+	 * @param autoColWidthsIncludeTableFooter include footer row in auto columns
+	 *                                        widths calculation
+	 * @throws SemanticException
+	 */
+	public void setExcelAutoColWidthsIncludeTableFooter(boolean autoColWidthsIncludeTableFooter)
+			throws SemanticException {
+		setBooleanProperty(EXCEL_AUTO_COL_WIDTHS_INCLUDE_TABLE_FOOTER, autoColWidthsIncludeTableFooter);
+	}
+
 	/**
 	 * Get the configuration for the excel handling of single sheet result
 	 *

diff --git a/...del/src/org/eclipse/birt/report/model/elements/interfaces/IInternalReportDesignModel.java b/...del/src/org/eclipse/birt/report/model/elements/interfaces/IInternalReportDesignModel.java
@@ -223,6 +223,16 @@ public interface IInternalReportDesignModel {
 	 */
 	String EXCEL_FORCE_AUTO_COL_WIDTHS = "excelForceAutoColWidths"; //$NON-NLS-1$
 
+	/**
+	 * Excel option, include header rows in auto column width calculation
+	 */
+	String EXCEL_AUTO_COL_WIDTHS_INCLUDE_TABLE_HEADER = "excelAutoColWidthsIncludeTableHeader"; //$NON-NLS-1$
+
+	/**
+	 * Excel option, include footer row in auto column width calculation
+	 */
+	String EXCEL_AUTO_COL_WIDTHS_INCLUDE_TABLE_FOOTER = "excelAutoColWidthsIncludeTableFooter"; //$NON-NLS-1$
+
 	/**
 	 * Excel option, create only singe sheet
 	 */

diff --git a/model/org.eclipse.birt.report.model/src/org/eclipse/birt/report/model/elements/rom.def b/model/org.eclipse.birt.report.model/src/org/eclipse/birt/report/model/elements/rom.def
@@ -1943,6 +1943,14 @@
 	  <!-- excel (Spudsoft): force the column width calculation	-->
       <Property canInherit="false" displayNameID="Element.ReportDesign.Emitter.excel.forceAutoColWidths" name="excelForceAutoColWidths" runtimeSettable="false" since="4.17" type="boolean" >
         <Default>false</Default>
+      </Property>
+	  <!-- excel (Spudsoft): include header in the column width calculation	-->
+      <Property canInherit="false" displayNameID="Element.ReportDesign.Emitter.excel.autoColWidthsIncludeHeader" name="excelAutoColWidthsIncludeTableHeader" runtimeSettable="false" since="4.19" type="boolean" >
+        <Default>false</Default>
+      </Property>
+      <!-- excel (Spudsoft): include footer in the column width calculation	-->
+      <Property canInherit="false" displayNameID="Element.ReportDesign.Emitter.excel.autoColWidthsIncludeFooter" name="excelAutoColWidthsIncludeTableFooter" runtimeSettable="false" since="4.19" type="boolean" >
+        <Default>false</Default>
       </Property>
       <!-- excel (Spudsoft): output of table as single sheet		-->
       <Property canInherit="false" displayNameID="Element.ReportDesign.Emitter.excel.singleSheet" name="excelSingleSheet" runtimeSettable="false" since="4.17" type="boolean" >

diff --git a/.../org.eclipse.birt.report.model/src/org/eclipse/birt/report/model/i18n/Messages.properties b/.../org.eclipse.birt.report.model/src/org/eclipse/birt/report/model/i18n/Messages.properties
@@ -2653,6 +2653,8 @@ Element.ReportDesign.language=Language
 Element.ReportDesign.PDFAccessible=Accessible PDF
 Element.ReportDesign.Emitter.excel=Emitter Excel configuration
 Element.ReportDesign.Emitter.excel.forceAutoColWidths=Force auto column width calculation
+Element.ReportDesign.Emitter.excel.autoColWidthsIncludeHeader=Include header rows in auto column width calculation
+Element.ReportDesign.Emitter.excel.autoColWidthsIncludeFooter=Include footer rows in auto column width calculation
 Element.ReportDesign.Emitter.excel.singleSheet=Single sheet
 Element.ReportDesign.Emitter.excel.disableGrouping=Disable grouping
 Element.ReportDesign.Emitter.excel.displayGridlines=Display grid lines

diff --git a/....eclipse.birt.report.model/src/org/eclipse/birt/report/model/writer/DesignWriterImpl.java b/....eclipse.birt.report.model/src/org/eclipse/birt/report/model/writer/DesignWriterImpl.java
@@ -128,6 +128,8 @@ protected void writeSimpleProperties(ReportDesign obj) {
 
 		property(obj, IInternalReportDesignModel.EXCEL_DISABLE_GROUPING);
 		property(obj, IInternalReportDesignModel.EXCEL_FORCE_AUTO_COL_WIDTHS);
+		property(obj, IInternalReportDesignModel.EXCEL_AUTO_COL_WIDTHS_INCLUDE_TABLE_HEADER);
+		property(obj, IInternalReportDesignModel.EXCEL_AUTO_COL_WIDTHS_INCLUDE_TABLE_FOOTER);
 		property(obj, IInternalReportDesignModel.EXCEL_SINGLE_SHEET);
 		property(obj, IInternalReportDesignModel.EXCEL_DISPLAY_GRIDLINES);
 		property(obj, IInternalReportDesignModel.EXCEL_AUTO_FILTER);