Package org.apache.poi.hssf.eventusermodel

Class FormatTrackingHSSFListener

  • All Implemented Interfaces:
    HSSFListener
    public class FormatTrackingHSSFListener
extends java.lang.Object
implements HSSFListener
    A proxy HSSFListener that keeps track of the document formatting records, and provides an easy way to look up the format strings used by cells from their ids.

    • Constructor Detail

      • FormatTrackingHSSFListener

        public FormatTrackingHSSFListener​(HSSFListener childListener)
        Creates a format tracking wrapper around the given listener, using the default locale for the formats.
        Parameters:
        childListener - the listener to be wrapped

      • FormatTrackingHSSFListener

        public FormatTrackingHSSFListener​(HSSFListener childListener,
                                  java.util.Locale locale)
        Creates a format tracking wrapper around the given listener, using the given locale for the formats.
        Parameters:
        childListener - the listener to be wrapped
        locale - the locale for the formats

    • Method Detail

      • processRecord

        public void processRecord​(Record record)
        Process this record ourselves, and then pass it on to our child listener
        Specified by:
        processRecord in interface HSSFListener
        Parameters:
        record - the record to be processed

      • processRecordInternally

        public void processRecordInternally​(Record record)
        Process the record ourselves, but do not pass it on to the child Listener.
        Parameters:
        record - the record to be processed

      • formatNumberDateCell

        public java.lang.String formatNumberDateCell​(CellValueRecordInterface cell)
        Formats the given numeric of date cells contents as a String, in as close as we can to the way that Excel would do so. Uses the various format records to manage this. TODO - move this to a central class in such a way that hssf.usermodel can make use of it too
        Parameters:
        cell - the cell
        Returns:
        the given numeric of date cells contents as a String

      • getFormatString

        public java.lang.String getFormatString​(int formatIndex)
        Returns the format string, eg $##.##, for the given number format index.
        Parameters:
        formatIndex - the format index
        Returns:
        the format string

      • getFormatString

        public java.lang.String getFormatString​(CellValueRecordInterface cell)
        Returns the format string, eg $##.##, used by your cell
        Parameters:
        cell - the cell
        Returns:
        the format string

      • getFormatIndex

        public int getFormatIndex​(CellValueRecordInterface cell)
        Returns the index of the format string, used by your cell, or -1 if none found
        Parameters:
        cell - the cell
        Returns:
        the index of the format string