public class InputSpecification
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
static int |
CONFIRM_OK_CANCEL
Input type to show a ok/cancel dialog.
|
static int |
CONFIRM_YES_NO
Input type to show a yes/no dialog.
|
static int |
INPUT_MEMO
Input type to show string memo input dialog (with text area and possibility to enter a line break)
|
static int |
INPUT_OPTION
Input type to show a select option dialog.
|
static int |
INPUT_VALUE
Input type to show string input dialog.
|
static int |
NO
Variable value for no.
|
static int |
OK
Variable value for ok.
|
static int |
YES
Variable value for yes.
|
Modifier | Constructor and Description |
---|---|
protected |
InputSpecification()
for deserialization only
|
|
InputSpecification(int type,
java.lang.String key,
java.lang.String message)
Create a new
InputSpecification |
|
InputSpecification(int type,
java.lang.String key,
java.lang.String message,
java.lang.String title)
Create a new
InputSpecification |
Modifier and Type | Method and Description |
---|---|
boolean |
applyForAllMultiEditObjects()
internal use only
|
java.lang.Object |
getDefaultOption()
Get default option (of available options, only applicable for INPUT_OPTION)
|
java.lang.String |
getKey()
Get the variable key/name.
|
java.lang.String |
getMessage()
Get the dialog message.
|
java.lang.Object[] |
getOptions()
Get available input options, only applicable for INPUT_OPTION.
|
java.lang.String |
getTitle()
Get the dialog title.
|
int |
getType()
Get input type.
|
void |
setApplyForAllMultiEditObjects(boolean applyForAllMultiEditObjects) |
void |
setDefaultOption(java.lang.Object defaultOption)
Set default option (of available options, only applicable for INPUT_OPTION)
|
void |
setOptions(java.lang.Object[] options)
Set available input options, only applicable for INPUT_OPTION.
|
public static final int CONFIRM_YES_NO
public static final int CONFIRM_OK_CANCEL
public static final int OK
public static final int YES
public static final int NO
public static final int INPUT_VALUE
public static final int INPUT_MEMO
public static final int INPUT_OPTION
protected InputSpecification()
public InputSpecification(int type, java.lang.String key, java.lang.String message)
InputSpecification
type
- Input type (CONFIRM_YES_NO, CONFIRM_OK_CANCEL, INPUT_VALUE or INPUT_OPTION)key
- Variable key (to obtain the value)message
- Dialog messagepublic InputSpecification(int type, java.lang.String key, java.lang.String message, java.lang.String title)
InputSpecification
type
- Input type (CONFIRM_YES_NO, CONFIRM_OK_CANCEL, INPUT_VALUE or INPUT_OPTION)key
- Variable key (to obtain the value)message
- Dialog messagetitle
- Dialog titlepublic int getType()
public java.lang.String getKey()
public java.lang.String getMessage()
public java.lang.String getTitle()
public java.lang.Object[] getOptions()
public void setOptions(java.lang.Object[] options)
options
- Available input optionspublic java.lang.Object getDefaultOption()
public void setDefaultOption(java.lang.Object defaultOption)
defaultOption
- Default optionpublic boolean applyForAllMultiEditObjects()
public void setApplyForAllMultiEditObjects(boolean applyForAllMultiEditObjects)
applyForAllMultiEditObjects
- false (default): One input question for every object during a multi edit.
true: The client is instructed to ask for the input only once.
You have to choose a general key for your input to work as expected, no object specific data within the key.Copyright © 2024. All rights reserved.