public interface ICellEditDialog
Modifier and Type | Field and Description |
---|---|
static String |
DIALOG_MESSAGE
Key to specify a custom message for the to be shown in the dialog.
|
static String |
DIALOG_SHELL_ICON
Key to specify a custom shell icon of the dialog.
|
static String |
DIALOG_SHELL_LOCATION
Key to specify the location where the dialog should be shown.
|
static String |
DIALOG_SHELL_RESIZABLE
Key to specify whether the dialog should be resizable or not.
|
static String |
DIALOG_SHELL_SIZE
Key to specify the size of the dialog.
|
static String |
DIALOG_SHELL_TITLE
Key to specify a custom shell title of the dialog.
|
Modifier and Type | Method and Description |
---|---|
Object |
calculateValue(Object currentValue,
Object processValue)
In case
getEditType() returns an edit type for processing
values, this method should implemented to do that transformation. |
Object |
getCommittedValue() |
EditTypeEnum |
getEditType() |
int |
open()
Opens this dialog, creating it first if it has not yet been created.
|
void |
setDialogSettings(Map<String,Object> editDialogSettings)
Allows to customize the appearance of the dialog.
|
static final String DIALOG_SHELL_TITLE
String
.static final String DIALOG_SHELL_ICON
Image
.static final String DIALOG_SHELL_LOCATION
Point
.static final String DIALOG_SHELL_SIZE
CellEditDialog.getInitialSize()
The value needs to be a Point
.static final String DIALOG_SHELL_RESIZABLE
CellEditDialog.isResizable()
because it is called
on instantiating the dialog in the constructor of the super class. It will modify
the set shell style bits instead.
The value needs to be a Boolean
.static final String DIALOG_MESSAGE
String
.Object getCommittedValue()
EditTypeEnum getEditType()
EditTypeEnum.SET
is returned, which
will simply set the committed value to the data model. Every other
edit type will do some calculation based on the committed value and
the current value in the data model.Object calculateValue(Object currentValue, Object processValue)
getEditType()
returns an edit type for processing
values, this method should implemented to do that transformation.currentValue
- The current value for the cell before data model updateprocessValue
- The value committed to the editor that should be used for
calculation on the current value.int open()
Specified in here for convenience so we only need to check against this interface for a dialog.
void setDialogSettings(Map<String,Object> editDialogSettings)
CellEditDialogFactory
.
The map containing the settings can be registered to the IConfigRegistry
for
the key EditConfigAttributes.EDIT_DIALOG_SETTINGS
. The keys that are valid
for this map are specified below.
editDialogSettings
- Map containing the settings to customize the edit dialog
appearance.DIALOG_SHELL_TITLE
,
DIALOG_SHELL_ICON
,
DIALOG_SHELL_LOCATION
,
DIALOG_SHELL_SIZE
,
DIALOG_SHELL_RESIZABLE
,
DIALOG_MESSAGE
,
EditConfigAttributes.EDIT_DIALOG_SETTINGS
Copyright © 2013. All Rights Reserved.