com.alibaba.excel.write.handler

Interface CellWriteHandler

All Superinterfaces:

Handler, Order, WriteHandler

All Known Implementing Classes:

AbstractCellStyleStrategy, AbstractCellWriteHandler, AbstractColumnWidthStyleStrategy, AbstractHeadColumnWidthStyleStrategy, AbstractMergeStrategy, AbstractVerticalCellStyleStrategy, DefaultStyle, FillStyleCellWriteHandler, HorizontalCellStyleStrategy, LongestMatchColumnWidthStyleStrategy, SimpleColumnWidthStyleStrategy

public interface CellWriteHandler
extends WriteHandler

intercepts handle cell creation

Author:

Jiaju Zhuang

Method Summary

Modifier and Type	Method and Description
default void	afterCellCreate(CellWriteHandlerContext context) Called after the cell is created
default void	afterCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, org.apache.poi.ss.usermodel.Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) Called after the cell is created
default void	afterCellDataConverted(CellWriteHandlerContext context) Called after the cell data is converted
default void	afterCellDataConverted(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, WriteCellData<?> cellData, org.apache.poi.ss.usermodel.Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) Called after the cell data is converted
default void	afterCellDispose(CellWriteHandlerContext context) Called after all operations on the cell have been completed
default void	afterCellDispose(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, List<WriteCellData<?>> cellDataList, org.apache.poi.ss.usermodel.Cell cell, Head head, Integer relativeRowIndex, Boolean isHead) Called after all operations on the cell have been completed
default void	beforeCellCreate(CellWriteHandlerContext context) Called before create the cell
default void	beforeCellCreate(WriteSheetHolder writeSheetHolder, WriteTableHolder writeTableHolder, org.apache.poi.ss.usermodel.Row row, Head head, Integer columnIndex, Integer relativeRowIndex, Boolean isHead) Called before create the cell

Methods inherited from interface com.alibaba.excel.event.Handler

order

Method Detail

beforeCellCreate

default void beforeCellCreate(CellWriteHandlerContext context)

Called before create the cell

Parameters:

context -

beforeCellCreate

default void beforeCellCreate(WriteSheetHolder writeSheetHolder,
                              WriteTableHolder writeTableHolder,
                              org.apache.poi.ss.usermodel.Row row,
                              Head head,
                              Integer columnIndex,
                              Integer relativeRowIndex,
                              Boolean isHead)

Called before create the cell

Parameters:

writeSheetHolder -

writeTableHolder - Nullable.It is null without using table writes.

row -

head - Nullable.It is null in the case of fill data and without head.

columnIndex -

relativeRowIndex - Nullable.It is null in the case of fill data.

isHead - It will always be false when fill data.

afterCellCreate

default void afterCellCreate(CellWriteHandlerContext context)

Called after the cell is created

Parameters:

context -

afterCellCreate

default void afterCellCreate(WriteSheetHolder writeSheetHolder,
                             WriteTableHolder writeTableHolder,
                             org.apache.poi.ss.usermodel.Cell cell,
                             Head head,
                             Integer relativeRowIndex,
                             Boolean isHead)

Called after the cell is created

Parameters:

writeSheetHolder -

writeTableHolder - Nullable.It is null without using table writes.

cell -

head - Nullable.It is null in the case of fill data and without head.

relativeRowIndex - Nullable.It is null in the case of fill data.

isHead - It will always be false when fill data.

afterCellDataConverted

default void afterCellDataConverted(CellWriteHandlerContext context)

Called after the cell data is converted

Parameters:

context -

afterCellDataConverted

default void afterCellDataConverted(WriteSheetHolder writeSheetHolder,
                                    WriteTableHolder writeTableHolder,
                                    WriteCellData<?> cellData,
                                    org.apache.poi.ss.usermodel.Cell cell,
                                    Head head,
                                    Integer relativeRowIndex,
                                    Boolean isHead)

Called after the cell data is converted

Parameters:

writeSheetHolder -

writeTableHolder - Nullable.It is null without using table writes.

cell -

head - Nullable.It is null in the case of fill data and without head.

cellData - Nullable.It is null in the case of add header.

relativeRowIndex - Nullable.It is null in the case of fill data.

isHead - It will always be false when fill data.

afterCellDispose

default void afterCellDispose(CellWriteHandlerContext context)

Called after all operations on the cell have been completed

Parameters:

context -

afterCellDispose

default void afterCellDispose(WriteSheetHolder writeSheetHolder,
                              WriteTableHolder writeTableHolder,
                              List<WriteCellData<?>> cellDataList,
                              org.apache.poi.ss.usermodel.Cell cell,
                              Head head,
                              Integer relativeRowIndex,
                              Boolean isHead)

Called after all operations on the cell have been completed

Parameters:

writeSheetHolder -

writeTableHolder - Nullable.It is null without using table writes.

cell -

head - Nullable.It is null in the case of fill data and without head.

cellDataList - Nullable.It is null in the case of add header.There may be several when fill the data.

relativeRowIndex - Nullable.It is null in the case of fill data.

isHead - It will always be false when fill data.