Package org.adempiere.impexp

Class AbstractExcelExporter

java.lang.Object
org.adempiere.impexp.AbstractExcelExporter
Direct Known Subclasses:
GridTabExcelExporter, PrintDataExcelExporter
public abstract class AbstractExcelExporter extends Object
Abstract MS Excel Format (xls) Exporter
Author:
Teo Sarca, SC ARHIPAC SERVICE SRL

  • Field Details

    • log

      protected final transient CLogger log
      Logger

    • m_workbook

      protected org.apache.poi.hssf.usermodel.HSSFWorkbook m_workbook

    • m_lang

      protected Language m_lang

    • colSuppressRepeats

      protected Boolean[] colSuppressRepeats

  • Constructor Details

    • AbstractExcelExporter

      public AbstractExcelExporter()
      Default constructor

  • Method Details

    • isFunctionRow

      public abstract boolean isFunctionRow()
      Is the current Row a Function Row
      Returns:
      true if function row

    • getColumnCount

      public abstract int getColumnCount()
      Get Columns Count
      Returns:
      number of columns

    • getRowCount

      public abstract int getRowCount()
      Get Rows Count
      Returns:
      number of rows

    • setCurrentRow

      protected abstract void setCurrentRow(int row)
      Set current row
      Parameters:
      row - row index

    • getCurrentRow

      protected abstract int getCurrentRow()
      Returns:
      current row index

    • isColumnPrinted

      public abstract boolean isColumnPrinted(int col)
      Check if column is printed (displayed)
      Parameters:
      col - column index
      Returns:
      true if is visible

    • getHeaderName

      public abstract String getHeaderName(int col)
      Get column header name
      Parameters:
      col - column index
      Returns:
      header name

    • getDisplayType

      public abstract int getDisplayType(int row, int col)
      Get cell display type (see DisplayType)
      Parameters:
      row - row index
      col - column index
      Returns:
      display type

    • getValueAt

      public abstract Object getValueAt(int row, int col)
      Get cell value
      Parameters:
      row - row index
      col - column index
      Returns:
      cell value

    • isPageBreak

      public abstract boolean isPageBreak(int row, int col)
      Check if there is a page break on given cell
      Parameters:
      row - row index
      col - column index
      Returns:
      true if there is a page break

    • isDisplayed

      public abstract boolean isDisplayed(int row, int col)
      Check if there is a display logic
      Parameters:
      row - row index
      col - column index
      Returns:
      true if there is no logic or evaluate logic specified in print item

    • getCtx

      protected Properties getCtx()

    • setFreezePane

      protected void setFreezePane(int colSplit, int rowSplit)
      Parameters:
      colSplit - column index to freeze
      rowSplit - row index to freeze

    • getLanguage

      protected Language getLanguage()
      Returns:
      Language

    • getCellFormat

      protected String getCellFormat(int row, int col)
      Parameters:
      row -
      col -
      Returns:
      Excel format pattern for cell

    • getNoOfParameter

      protected int getNoOfParameter()
      Returns:
      number of parameter

    • setNoOfParameter

      protected void setNoOfParameter(int noOfParameter)
      Parameters:
      noOfParameter -

    • createParameter

      protected void createParameter(org.apache.poi.hssf.usermodel.HSSFSheet sheet)
      Create parameter
      Parameters:
      sheet -

    • createHeaderFooter

      protected void createHeaderFooter(org.apache.poi.hssf.usermodel.HSSFSheet sheet)
      Create sheet header and footer
      Parameters:
      sheet -

    • formatPage

      protected void formatPage(org.apache.poi.hssf.usermodel.HSSFSheet sheet)
      Format sheet
      Parameters:
      sheet -

    • isCurrentRowOnly

      protected boolean isCurrentRowOnly()
      Returns:
      true if export current record only

    • setCurrentRowOnly

      protected void setCurrentRowOnly(boolean b)
      Parameters:
      b -

    • export

      protected void export(OutputStream out) throws Exception
      Export to given stream
      Parameters:
      out -
      Throws:
      Exception

    • export

      public void export(File file, Language language) throws Exception
      Export to file
      Parameters:
      file -
      language - reporting language
      Throws:
      Exception

    • export

      public void export(File file, Language language, boolean autoOpen) throws Exception
      Export to file
      Parameters:
      file -
      language - reporting language
      autoOpen - auto open file after generated
      Throws:
      Exception

    • exportToWorkbook

      public void exportToWorkbook(org.apache.poi.hssf.usermodel.HSSFWorkbook workbook, Language language) throws Exception
      Export to work book
      Parameters:
      workbook -
      language -
      Throws:
      Exception

    • isForm

      protected boolean isForm()
      Returns:
      true if it is form layout

    • isVisible

      protected boolean isVisible(int row, int col)
      Parameters:
      row -
      col -
      Returns:
      true if cell is visible

    • isSuppressNull

      protected boolean isSuppressNull(int col)
      Parameters:
      col -
      Returns:
      true if column should be hidden when it is null

    • isSetFormRowPosition

      protected boolean isSetFormRowPosition(int col)
      Parameters:
      col -
      Returns:
      true if column is use to set new row position

    • getFormCell

      protected org.apache.poi.hssf.usermodel.HSSFCell getFormCell(org.apache.poi.hssf.usermodel.HSSFRow row, int colnum)
      get cell for column. use for form layout
      Parameters:
      row -
      colnum -
      Returns:
      cell for column

    • getFormRow

      protected org.apache.poi.hssf.usermodel.HSSFRow getFormRow(org.apache.poi.hssf.usermodel.HSSFSheet sheet, int colnum)
      get row for column. use for form layout
      Parameters:
      sheet -
      colnum -
      Returns:
      row for column