Package io.keikai.model

Class ModelEvents

java.lang.Object

io.keikai.model.ModelEvents

public class ModelEvents
extends java.lang.Object

A collection of factory method that help you create ModelEvent.

Since:

3.5.0

Author:

dennis

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ON_AUTOFILTER_CHANGE
static java.lang.String	ON_BEFORE_CELL_VALUE_CHANGE
static java.lang.String	ON_CELL_CONTENT_CHANGE
static java.lang.String	ON_CHART_ADD
static java.lang.String	ON_CHART_CONTENT_CHANGE
static java.lang.String	ON_CHART_DELETE
static java.lang.String	ON_CHART_UPDATE
static java.lang.String	ON_COLUMN_DELETE
static java.lang.String	ON_COLUMN_INSERT
static java.lang.String	ON_DATA_VALIDATION_CONTENT_CHANGE
static java.lang.String	ON_DISPLAY_GRIDLINES_CHANGE
static java.lang.String	ON_FREEZE_CHANGE
static java.lang.String	ON_GROUP_CHANGE
static java.lang.String	ON_MERGE_ADD
static java.lang.String	ON_MERGE_DELETE
static java.lang.String	ON_MERGE_SYNC
static java.lang.String	ON_MODEL_DIRTY_CHANGE
static java.lang.String	ON_MODEL_FRIEND_FOCUS_DELETE
static java.lang.String	ON_MODEL_FRIEND_FOCUS_MOVE
static java.lang.String	ON_NAME_NAME_CHANGE
static java.lang.String	ON_PICTURE_ADD
static java.lang.String	ON_PICTURE_DELETE
static java.lang.String	ON_PICTURE_UPDATE
static java.lang.String	ON_PROTECT_SHEET_CHANGE
static java.lang.String	ON_RELEASE_SELECTED_CACHE
static java.lang.String	ON_ROW_COLUMN_SIZE_CHANGE
static java.lang.String	ON_ROW_DELETE
static java.lang.String	ON_ROW_INSERT
static java.lang.String	ON_SHEET_CREATE
static java.lang.String	ON_SHEET_DELETE
static java.lang.String	ON_SHEET_NAME_CHANGE
static java.lang.String	ON_SHEET_ORDER_CHANGE
static java.lang.String	ON_SHEET_SELECT
static java.lang.String	ON_SHEET_VISIBLE_CHANGE
static java.lang.String	PARAM_BOOK	the effected book
static java.lang.String	PARAM_CUSTOM_DATA	the custom data, e.g. notify custom event
static java.lang.String	PARAM_ENABLED	the enable state, e.g enable display gridlines
static java.lang.String	PARAM_INDEX	the index, e.g the deleted sheet index
static java.lang.String	PARAM_NAME	The Name in the table or sheet.
static java.lang.String	PARAM_OBJECT_ID	the object, e.g. notify chart, picture, validation change
static java.lang.String	PARAM_OLD_INDEX	the old index, e.g old sheet index when reorder the sheet
static java.lang.String	PARAM_OLD_NAME	the old name, e.g old sheet name when rename the sheet
static java.lang.String	PARAM_REGION	the effected region
static java.lang.String	PARAM_SHEET	the effected sheet

Constructor Summary

Constructors

Constructor	Description
ModelEvents()

Method Summary

Modifier and Type	Method	Description
static java.util.Map	createDataMap(java.lang.Object... data)	A utility method that help you create data map, e.g. createDataMap(ModelEvents.PARAM_CUSTOM_DATA, data)
static ModelEvent	createModelEvent(java.lang.String name, SBook book)
static ModelEvent	createModelEvent(java.lang.String name, SBook book, SSheet sheet, java.util.Map data)
static ModelEvent	createModelEvent(java.lang.String name, SBook book, java.util.Map data)	Create a model event.
static ModelEvent	createModelEvent(java.lang.String name, SSheet sheet)
static ModelEvent	createModelEvent(java.lang.String name, SSheet sheet, CellRegion region)
static ModelEvent	createModelEvent(java.lang.String name, SSheet sheet, CellRegion region, java.util.Map data)
static ModelEvent	createModelEvent(java.lang.String name, SSheet sheet, java.util.Map data)
static boolean	isCustomEvent(ModelEvent event)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ON_BEFORE_CELL_VALUE_CHANGE

public static final java.lang.String ON_BEFORE_CELL_VALUE_CHANGE

See Also:

Constant Field Values

ON_CELL_CONTENT_CHANGE

public static final java.lang.String ON_CELL_CONTENT_CHANGE

See Also:

Constant Field Values

ON_CHART_CONTENT_CHANGE

public static final java.lang.String ON_CHART_CONTENT_CHANGE

See Also:

Constant Field Values

ON_DATA_VALIDATION_CONTENT_CHANGE

public static final java.lang.String ON_DATA_VALIDATION_CONTENT_CHANGE

See Also:

Constant Field Values

ON_ROW_COLUMN_SIZE_CHANGE

public static final java.lang.String ON_ROW_COLUMN_SIZE_CHANGE

See Also:

Constant Field Values

ON_AUTOFILTER_CHANGE

public static final java.lang.String ON_AUTOFILTER_CHANGE

See Also:

Constant Field Values

ON_FREEZE_CHANGE

public static final java.lang.String ON_FREEZE_CHANGE

See Also:

Constant Field Values

ON_GROUP_CHANGE

public static final java.lang.String ON_GROUP_CHANGE

See Also:

Constant Field Values

ON_SHEET_CREATE

public static final java.lang.String ON_SHEET_CREATE

See Also:

Constant Field Values

ON_SHEET_NAME_CHANGE

public static final java.lang.String ON_SHEET_NAME_CHANGE

See Also:

Constant Field Values

ON_SHEET_ORDER_CHANGE

public static final java.lang.String ON_SHEET_ORDER_CHANGE

See Also:

Constant Field Values

ON_SHEET_DELETE

public static final java.lang.String ON_SHEET_DELETE

See Also:

Constant Field Values

ON_SHEET_VISIBLE_CHANGE

public static final java.lang.String ON_SHEET_VISIBLE_CHANGE

See Also:

Constant Field Values

ON_SHEET_SELECT

public static final java.lang.String ON_SHEET_SELECT

See Also:

Constant Field Values

ON_PICTURE_ADD

public static final java.lang.String ON_PICTURE_ADD

See Also:

Constant Field Values

ON_PICTURE_UPDATE

public static final java.lang.String ON_PICTURE_UPDATE

See Also:

Constant Field Values

ON_PICTURE_DELETE

public static final java.lang.String ON_PICTURE_DELETE

See Also:

Constant Field Values

ON_CHART_ADD

public static final java.lang.String ON_CHART_ADD

See Also:

Constant Field Values

ON_CHART_UPDATE

public static final java.lang.String ON_CHART_UPDATE

See Also:

Constant Field Values

ON_CHART_DELETE

public static final java.lang.String ON_CHART_DELETE

See Also:

Constant Field Values

ON_MERGE_ADD

public static final java.lang.String ON_MERGE_ADD

See Also:

Constant Field Values

ON_MERGE_DELETE

public static final java.lang.String ON_MERGE_DELETE

See Also:

Constant Field Values

ON_MERGE_SYNC

public static final java.lang.String ON_MERGE_SYNC

See Also:

Constant Field Values

ON_DISPLAY_GRIDLINES_CHANGE

public static final java.lang.String ON_DISPLAY_GRIDLINES_CHANGE

See Also:

Constant Field Values

ON_PROTECT_SHEET_CHANGE

public static final java.lang.String ON_PROTECT_SHEET_CHANGE

See Also:

Constant Field Values

ON_ROW_INSERT

public static final java.lang.String ON_ROW_INSERT

See Also:

Constant Field Values

ON_ROW_DELETE

public static final java.lang.String ON_ROW_DELETE

See Also:

Constant Field Values

ON_COLUMN_INSERT

public static final java.lang.String ON_COLUMN_INSERT

See Also:

Constant Field Values

ON_COLUMN_DELETE

public static final java.lang.String ON_COLUMN_DELETE

See Also:

Constant Field Values

ON_NAME_NAME_CHANGE

public static final java.lang.String ON_NAME_NAME_CHANGE

See Also:

Constant Field Values

ON_MODEL_FRIEND_FOCUS_DELETE

public static final java.lang.String ON_MODEL_FRIEND_FOCUS_DELETE

See Also:

Constant Field Values

ON_MODEL_FRIEND_FOCUS_MOVE

public static final java.lang.String ON_MODEL_FRIEND_FOCUS_MOVE

See Also:

Constant Field Values

ON_MODEL_DIRTY_CHANGE

public static final java.lang.String ON_MODEL_DIRTY_CHANGE

See Also:

Constant Field Values

ON_RELEASE_SELECTED_CACHE

public static final java.lang.String ON_RELEASE_SELECTED_CACHE

See Also:

Constant Field Values

PARAM_BOOK

public static final java.lang.String PARAM_BOOK

the effected book

See Also:

Constant Field Values

PARAM_SHEET

public static final java.lang.String PARAM_SHEET

the effected sheet

See Also:

Constant Field Values

PARAM_REGION

public static final java.lang.String PARAM_REGION

the effected region

See Also:

Constant Field Values

PARAM_OBJECT_ID

public static final java.lang.String PARAM_OBJECT_ID

the object, e.g. notify chart, picture, validation change

See Also:

Constant Field Values

PARAM_CUSTOM_DATA

public static final java.lang.String PARAM_CUSTOM_DATA

the custom data, e.g. notify custom event

See Also:

Constant Field Values

PARAM_INDEX

public static final java.lang.String PARAM_INDEX

the index, e.g the deleted sheet index

See Also:

Constant Field Values

PARAM_OLD_NAME

public static final java.lang.String PARAM_OLD_NAME

the old name, e.g old sheet name when rename the sheet

See Also:

Constant Field Values

PARAM_OLD_INDEX

public static final java.lang.String PARAM_OLD_INDEX

the old index, e.g old sheet index when reorder the sheet

See Also:

Constant Field Values

PARAM_ENABLED

public static final java.lang.String PARAM_ENABLED

the enable state, e.g enable display gridlines

See Also:

Constant Field Values

PARAM_NAME

public static final java.lang.String PARAM_NAME

The Name in the table or sheet.

Since:

3.8.0

See Also:

Constant Field Values

Constructor Detail

ModelEvents

public ModelEvents()

Method Detail

createModelEvent

public static ModelEvent createModelEvent(java.lang.String name,
                                          SBook book)

createModelEvent

public static ModelEvent createModelEvent(java.lang.String name,
                                          SBook book,
                                          java.util.Map data)

Create a model event.

Parameters:

name - event name, can be one constant of ModelEvents

book - the book where the event happens

data - event-related data

Returns:

a model event

createModelEvent

public static ModelEvent createModelEvent(java.lang.String name,
                                          SSheet sheet)

See Also:

createModelEvent(String, SBook, Map)

createModelEvent

public static ModelEvent createModelEvent(java.lang.String name,
                                          SSheet sheet,
                                          java.util.Map data)

See Also:

createModelEvent(String, SBook, Map)

createModelEvent

public static ModelEvent createModelEvent(java.lang.String name,
                                          SSheet sheet,
                                          CellRegion region)

See Also:

createModelEvent(String, SBook, Map)

createModelEvent

public static ModelEvent createModelEvent(java.lang.String name,
                                          SBook book,
                                          SSheet sheet,
                                          java.util.Map data)

createModelEvent

public static ModelEvent createModelEvent(java.lang.String name,
                                          SSheet sheet,
                                          CellRegion region,
                                          java.util.Map data)

See Also:

createModelEvent(String, SBook, Map)

createDataMap

public static java.util.Map createDataMap(java.lang.Object... data)

A utility method that help you create data map, e.g. createDataMap(ModelEvents.PARAM_CUSTOM_DATA, data)

Parameters:

data -

Returns:

a map that contains the data you pass in

isCustomEvent

public static boolean isCustomEvent(ModelEvent event)