Package com.compomics.util.io.export

Interface WorkbookStyle

All Known Implementing Classes:
DefaultStyle
public interface WorkbookStyle
This interface sets the style of a workbook export.
Author:
Marc Vaudel

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getHeaderHeight()
    Returns the height of a header row.
    org.apache.poi.ss.usermodel.CellStyle
    getHeaderStyle()
    Returns the standard cell style of a header.
    org.apache.poi.ss.usermodel.CellStyle
    getHeaderStyle(int hierarchicalDepth)
    Returns the standard cell style of a header at the given hierarchical depth.
    float
    getMainTitleRowHeight()
    Returns the row height for the main title.
    org.apache.poi.ss.usermodel.CellStyle
    getMainTitleStyle()
    Returns the cell style for the main title.
    float
    getStandardHeight()
    Returns the height of a standard line.
    org.apache.poi.ss.usermodel.CellStyle
    getStandardStyle()
    Returns the standard cell style.
    org.apache.poi.ss.usermodel.CellStyle
    getStandardStyle(int hierarchicalDepth)
    Returns the standard cell style for the given hierarchical depth.

  • Method Details

    • getMainTitleStyle

      org.apache.poi.ss.usermodel.CellStyle getMainTitleStyle()
      Returns the cell style for the main title.
      Returns:
      the cell style for the main title

    • getMainTitleRowHeight

      float getMainTitleRowHeight()
      Returns the row height for the main title.
      Returns:
      the row height for the main title

    • getStandardStyle

      org.apache.poi.ss.usermodel.CellStyle getStandardStyle()
      Returns the standard cell style.
      Returns:
      the standard cell style

    • getStandardStyle

      org.apache.poi.ss.usermodel.CellStyle getStandardStyle(int hierarchicalDepth)
      Returns the standard cell style for the given hierarchical depth. The depth is defined by the sublevel of the current cell.
      Parameters:
      hierarchicalDepth - the hierarchical depth
      Returns:
      the standard cell style for the given hierarchical depth

    • getStandardHeight

      float getStandardHeight()
      Returns the height of a standard line.
      Returns:
      the height of a standard line

    • getHeaderStyle

      org.apache.poi.ss.usermodel.CellStyle getHeaderStyle()
      Returns the standard cell style of a header.
      Returns:
      the standard cell style of a header

    • getHeaderStyle

      org.apache.poi.ss.usermodel.CellStyle getHeaderStyle(int hierarchicalDepth)
      Returns the standard cell style of a header at the given hierarchical depth. The depth is defined by the sublevel of the current cell.
      Parameters:
      hierarchicalDepth - the hierarchical depth
      Returns:
      the standard cell style for the given hierarchical depth

    • getHeaderHeight

      float getHeaderHeight()
      Returns the height of a header row.
      Returns:
      the height of a header row