ExcelParameter (Logi Report 24.3 Service Pack 1 API Index)

java.lang.Object
- jet.bean.ExcelParameter

All Implemented Interfaces:: java.io.Serializable

public class ExcelParameter
extends java.lang.Object
implements java.io.Serializable

The ExcelParameter class is used for exporting to Excel. It contains all the information for exporting report results.

To create an ExcelParameter using the constructors in this class:

                ExcelParameter()

Then you can set the value of parameters as you want.

There are four types of report layouts when exporting reports to Excel. They are:

  1."Preserve Report Formatting": You must use the method setNewExcelLayout(true).
        This method calls setBiff8(false) regardless of the previous setting.  
  2.Normal Formatting: This type is from v7 and sometimes works better for analysis even though the look of the
      report is not maintained. If you want to use this type, you must use
        setNewExcelLayout(false) and setBiff8(false).
  3.Excel 2000: You must use the method setBiff8(true).
        This method calls setNewExcelLayout(false) regardless of the previous setting. 
  4.Columned Type: If you want to use the columned type, you must set 
        "Columned" to true in report template and then use Normal Formatting when exporting reports to Excel file.

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`EXP` The suffix file name of the XLS Excel file.
`static int`	`EXPORTSHAPE` Useful constant for exporting shapes.
`static int`	`KEEPORIGIN` Useful constant for word wrap.
`static int`	`NOEXPORTSHAPE` Useful constant for exporting shapes.
`static int`	`NOWORDWRAP` Useful constant for word wrap.
`static byte`	`TYPE_FORMAT_AUTO` The exporting excel format is "Auto Format"
`static byte`	`TYPE_FORMAT_COLUMN` The exporting excel format is "column Format"
`static byte`	`TYPE_FORMAT_DATA` The exporting excel format is "Data Format"
`static byte`	`TYPE_FORMAT_REPORT` The exporting excel format is "Report Format"
`static int`	`WORDWRAPALL` Useful constant for word wrap.
`static int`	`XLSFORMAT` Specifies the Excel result as XLS format.
`static java.lang.String`	`XLSXEXP` The suffix file name of the XLSX format Excel file.
`static int`	`XLSXFORMAT` Specifies the Excel result as XLSX format.

Constructor Summary

Constructors
Constructor and Description

ExcelParameter()
Initializes a newly created ExcelParameter object so that it can hold the values used in exporting to the Excel file.

Constructors
Constructor and Description
`ExcelParameter()` Initializes a newly created `ExcelParameter` object so that it can hold the values used in exporting to the Excel file.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ExcelParameter`	`copy()` Adding the method for MailInformation can clone this object.
`boolean`	`getDisplayValueConsistently()` Get the "Display Value Consistently" option.
`boolean`	`getGenerateExcelFormula()` Get the "Generate Excel Formula" option.
`boolean`	`getOverflowToAdjacentZeroLengthTextCell()` Get the "Overflow to Adjacent Zero Length Text Cell" option.
`java.lang.String`	`getPrintPageFooter()` Gets the print page footer.
`java.lang.String`	`getPrintPageHeader()` Gets the print page header.
`int`	`getWordWrapType()` Gets the word wrap type in the parameter.
`boolean`	`isAutoFormat()` Gets the boolean value of whether to check the "Auto format" option.
`boolean`	`isBiff8()` Gets the boolean value of whether to check the "Data format" option.
`boolean`	`isColumnFormat()` Gets the boolean value of whether to check the "Column format" option.
`boolean`	`isExportShape()` Gets the boolean value of whether to export shapes.
`boolean`	`isNewExcelLayout()` Gets the boolean value of whether to check the "Preserve Report Formatting" option.
`boolean`	`isNoFileExt()`
`boolean`	`isPrintGridlines()` Gets the flag that indexes whether to print gridlines or not.
`boolean`	`isShareLabel()` Gets the boolean value of whether to set ShareLabel.
`boolean`	`isXlsFormat()` Gets the flag which specifies whether the Excel result is XLS or not.
`void`	`setBiff8(boolean biff8)` Deprecated. please use the method `setTypeFormat(byte)` to replace it Sets the "Excel 2000" option. If it is true, then option "Preserve Report Formatting" will be set to false.
`void`	`setDisplayValueConsistently(boolean b)` Set the "Display Value Consistently" option.
`void`	`setFileFormat(int format)` Sets the Excel result format.
`void`	`setGenerateExcelFormula(boolean b)` Set the "Generate Excel Formula" option.
`void`	`setNewExcelLayout(boolean isNewExcelLayout)` Deprecated. please use the method `setTypeFormat(byte)` to replace it Sets the value of whether to check the "Preserve Report Formatting" option. If it is true, isBiff8 will be set to false.
`void`	`setNoFileExt(boolean noFileExt)`
`void`	`setOverflowToAdjacentZeroLengthTextCell(boolean b)` Set the "Overflow to Adjacent Zero Length Text Cell" option.
`void`	`setParam(int param)` Sets whether to export shapes.
`void`	`setPrintGridlinesAble(boolean isPrint)` Sets the flag that indexes whether to print gridlines or not.
`void`	`setPrintPageHeaderAndFooter(java.lang.String header, java.lang.String footer)` Sets the value of Print page header and footer in Excel file.
`void`	`setShareLable(boolean shareLabel)` Deprecated. This method is not used, we export the Excel file as share format.
`void`	`setTypeFormat(byte typeFormat)` Set the exporting excel type format.
`void`	`setWordWrapType(int wordWrapType)` Sets the word wrap type.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEEPORIGIN
```
public static final int KEEPORIGIN
```
    Useful constant for word wrap. Keeps all the cell original word wrap settings in the Excel file.
    
    See Also:
    
    Constant Field Values
  - NOWORDWRAP
```
public static final int NOWORDWRAP
```
    Useful constant for word wrap. Ignores all the cell word wrap settings in the Excel file.
    
    See Also:
    
    Constant Field Values
  - WORDWRAPALL
```
public static final int WORDWRAPALL
```
    Useful constant for word wrap. Sets word wrap on for all the cells in the Excel file.
    
    See Also:
    
    Constant Field Values
  - EXPORTSHAPE
```
public static final int EXPORTSHAPE
```
    Useful constant for exporting shapes. Exports all shapes to the Excel file.
    
    See Also:
    
    Constant Field Values
  - NOEXPORTSHAPE
```
public static final int NOEXPORTSHAPE
```
    Useful constant for exporting shapes. Does not export any shapes to the Excel file.
    
    See Also:
    
    Constant Field Values
  - EXP
```
public static final java.lang.String EXP
```
    The suffix file name of the XLS Excel file.
    
    See Also:
    
    Constant Field Values
  - XLSXEXP
```
public static final java.lang.String XLSXEXP
```
    The suffix file name of the XLSX format Excel file.
    
    See Also:
    
    Constant Field Values
  - XLSFORMAT
```
public static final int XLSFORMAT
```
    Specifies the Excel result as XLS format.
    
    See Also:
    
    Constant Field Values
  - XLSXFORMAT
```
public static final int XLSXFORMAT
```
    Specifies the Excel result as XLSX format.
    
    See Also:
    
    Constant Field Values
  - TYPE_FORMAT_AUTO
```
public static final byte TYPE_FORMAT_AUTO
```
    The exporting excel format is "Auto Format"
    
    See Also:
    
    Constant Field Values
  - TYPE_FORMAT_REPORT
```
public static final byte TYPE_FORMAT_REPORT
```
    The exporting excel format is "Report Format"
    
    See Also:
    
    Constant Field Values
  - TYPE_FORMAT_COLUMN
```
public static final byte TYPE_FORMAT_COLUMN
```
    The exporting excel format is "column Format"
    
    See Also:
    
    Constant Field Values
  - TYPE_FORMAT_DATA
```
public static final byte TYPE_FORMAT_DATA
```
    The exporting excel format is "Data Format"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ExcelParameter
```
public ExcelParameter()
```
    Initializes a newly created ExcelParameter object so that it can hold the values used in exporting to the Excel file. Note that this constructor is empty. Every value is a default value.
- Method Detail
  - setTypeFormat
```
public void setTypeFormat(byte typeFormat)
```
    Set the exporting excel type format.
    
    Parameters:
    
    typeFormat - the type format, its value should be TYPE_FORMAT_AUTO, TYPE_FORMAT_COLUMN, TYPE_FORMAT_REPORT or TYPE_FORMAT_DATA Note: If this method is not invoked, the default type format is TYPE_FORMAT_COLUMN
  - setPrintPageHeaderAndFooter
```
public void setPrintPageHeaderAndFooter(java.lang.String header,
                                        java.lang.String footer)
```
    Sets the value of Print page header and footer in Excel file.
    
    Parameters:
    
    header - The Print page header in Excel file.
    
    footer - The Print page footer in Excel file.
  - getPrintPageHeader
```
public java.lang.String getPrintPageHeader()
```
    Gets the print page header.
    
    Returns:
    
    The Print page header of Excel parameter.
  - getPrintPageFooter
```
public java.lang.String getPrintPageFooter()
```
    Gets the print page footer.
    
    Returns:
    
    The Print page footer of Excel parameter.
  - setPrintGridlinesAble
```
public void setPrintGridlinesAble(boolean isPrint)
```
    Sets the flag that indexes whether to print gridlines or not.
    
    Parameters:
    
    isPrint - Prints the gridlines when it is true.
  - isPrintGridlines
```
public boolean isPrintGridlines()
```
    Gets the flag that indexes whether to print gridlines or not.
    
    Returns:
    
    true when printing gridlines
  - setWordWrapType
```
public void setWordWrapType(int wordWrapType)
```
    Sets the word wrap type. There are three types of word wrap.
```
  KEEPORIGIN
  NOWORDWRAP
  WORDWRAPALL
 
```
    Parameters:
    
    wordWrapType -
  - setParam
```
public void setParam(int param)
```
    Sets whether to export shapes. If you want to export shapes, you must select the "Default type" or "Preserve Report Formatting" option, as Excel 2000 does not support shapes.
    
    Parameters:
    
    param - When param is 1, export shapes to Excel. Any other value ignore shapes.
  - setShareLable
```
public void setShareLable(boolean shareLabel)
```
    Deprecated. This method is not used, we export the Excel file as share format.
    
    Sets whether to use share label.
    
    Parameters:
    
    shareLabel - the boolean value share value.
  - setNewExcelLayout
```
public void setNewExcelLayout(boolean isNewExcelLayout)
```
    Deprecated. please use the method setTypeFormat(byte) to replace it Sets the value of whether to check the "Preserve Report Formatting" option. If it is true, isBiff8 will be set to false.
    
    Parameters:
    
    isNewExcelLayout - the boolean value that represents the option.
  - getWordWrapType
```
public int getWordWrapType()
```
    Gets the word wrap type in the parameter.
    
    Returns:
    
    The word wrap type.
  - isExportShape
```
public boolean isExportShape()
```
    Gets the boolean value of whether to export shapes.
    
    Returns:
    
    The boolean value of export shapes.
  - isShareLabel
```
public boolean isShareLabel()
```
    Gets the boolean value of whether to set ShareLabel.
    
    Returns:
    
    The boolean value of setting share label.
  - isNewExcelLayout
```
public boolean isNewExcelLayout()
```
    Gets the boolean value of whether to check the "Preserve Report Formatting" option.
    
    Returns:
    
    The boolean value of whether to check the "Preserve Report Formatting" option.
  - isBiff8
```
public boolean isBiff8()
```
    Gets the boolean value of whether to check the "Data format" option.
    
    Returns:
    
    The boolean value of whether to check the "Data format" option.
  - setBiff8
```
public void setBiff8(boolean biff8)
```
    Deprecated. please use the method setTypeFormat(byte) to replace it Sets the "Excel 2000" option. If it is true, then option "Preserve Report Formatting" will be set to false.
    
    Parameters:
    
    biff8 -
  - isAutoFormat
```
public boolean isAutoFormat()
```
    Gets the boolean value of whether to check the "Auto format" option.
    
    Returns:
    
    The boolean value of whether to check the "Auto format" option.
  - isColumnFormat
```
public boolean isColumnFormat()
```
    Gets the boolean value of whether to check the "Column format" option.
    
    Returns:
    
    The boolean value of whether to check the "Column format" option.
  - setFileFormat
```
public void setFileFormat(int format)
```
    Sets the Excel result format.
    
    Parameters:
    
    format - it should be XLSFORMAT or XLSXFORMAT for now.
  - isXlsFormat
```
public boolean isXlsFormat()
```
    Gets the flag which specifies whether the Excel result is XLS or not.
    
    Returns:
    
    true if it is XLS format, otherwise, false.
  - setOverflowToAdjacentZeroLengthTextCell
```
public void setOverflowToAdjacentZeroLengthTextCell(boolean b)
```
    Set the "Overflow to Adjacent Zero Length Text Cell" option. When it is true, if the text in an Excel cell is so long that the cell width is not enough and the length of the text in the adjacent Excel cell is 0, the text in the first Excel cell will overflow to the second Excel cell. The default value is true.
    
    Parameters:
    
    b - the option value.
  - getOverflowToAdjacentZeroLengthTextCell
```
public boolean getOverflowToAdjacentZeroLengthTextCell()
```
    Get the "Overflow to Adjacent Zero Length Text Cell" option.
    
    Returns:
    
    the option value.
  - setDisplayValueConsistently
```
public void setDisplayValueConsistently(boolean b)
```
    Set the "Display Value Consistently" option. When it is true, the cell display value and focused value will both be the formatted value. Otherwise, only the cell display value will be the formatted value, and the focused value will be the original data. The default value is false.
    
    Parameters:
    
    b - the option value.
  - getDisplayValueConsistently
```
public boolean getDisplayValueConsistently()
```
    Get the "Display Value Consistently" option.
    
    Returns:
    
    the option value.
  - setGenerateExcelFormula
```
public void setGenerateExcelFormula(boolean b)
```
    Set the "Generate Excel Formula" option. When it is true, the Excel formula will be generated for summary fields if the corresponding conditions are met. Otherwise, the Excel formula will not be generated. The default value is true.
    
    Parameters:
    
    b - the option value.
  - getGenerateExcelFormula
```
public boolean getGenerateExcelFormula()
```
    Get the "Generate Excel Formula" option.
    
    Returns:
    
    the option value.
  - copy
```
public ExcelParameter copy()
```
    Adding the method for MailInformation can clone this object.
    
    Returns:
  - setNoFileExt
```
public void setNoFileExt(boolean noFileExt)
```
  - isNoFileExt
```
public boolean isNoFileExt()
```

Class ExcelParameter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KEEPORIGIN

NOWORDWRAP

WORDWRAPALL

EXPORTSHAPE

NOEXPORTSHAPE

EXP

XLSXEXP

XLSFORMAT

XLSXFORMAT

TYPE_FORMAT_AUTO

TYPE_FORMAT_REPORT

TYPE_FORMAT_COLUMN

TYPE_FORMAT_DATA

Constructor Detail

ExcelParameter

Method Detail

setTypeFormat

setPrintPageHeaderAndFooter

getPrintPageHeader

getPrintPageFooter

setPrintGridlinesAble

isPrintGridlines

setWordWrapType

setParam

setShareLable

setNewExcelLayout

getWordWrapType

isExportShape

isShareLabel

isNewExcelLayout

isBiff8

setBiff8

isAutoFormat

isColumnFormat

setFileFormat

isXlsFormat

setOverflowToAdjacentZeroLengthTextCell

getOverflowToAdjacentZeroLengthTextCell

setDisplayValueConsistently

getDisplayValueConsistently

setGenerateExcelFormula

getGenerateExcelFormula

copy

setNoFileExt

isNoFileExt