IMDetailScriptAction (ontimize-core 5.6.0 API)

java.lang.Object
- com.ontimize.gui.InteractionManager
- - com.ontimize.scripting.gui.IMDetailScriptAction

All Implemented Interfaces:

DataNavigationListener, Freeable, ValueChangeListener, IDetailScriptAction, IScriptMessages, EventListener
```
public class IMDetailScriptAction
extends InteractionManager
implements IDetailScriptAction, IScriptMessages
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IMDetailScriptAction.LanguageComboCellRenderer
- Nested classes/interfaces inherited from class com.ontimize.gui.InteractionManager
  InteractionManager.DeleteFieldsListener, InteractionManager.InteractionManagerAction, InteractionManager.PrintingThread

Nested Classes
Modifier and Type	Class and Description
`static class`	`IMDetailScriptAction.LanguageComboCellRenderer`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEPT_BUTTON`
`static String`	`ACTION_LISTENER_RADIO_BUTTON`
`static String`	`ACTION_PERFORMED_RADIO_BUTTON`
`static String`	`BUTTON_ACTION_RADIO_BUTTON`
`static String[]`	`buttonActionGroup`
`static String`	`BUTTONS_COMBO_NAME`
`static String`	`CANCEL_ACTION_BUTTON`
`static String`	`CLOSE_BUTTON`
`static String`	`DATA_FIELD_RADIO_BUTTON`
`static String`	`DATA_FIELDS_COMBO_NAME`
`static String[]`	`dataFieldActionGroup`
`static String`	`ENTITY_ACTION_RADIO_BUTTON`
`static String`	`ENTITY_DATA_CHANGE_LISTENER_RADIO_BUTTON`
`static String`	`ENTITY_DATA_CHANGE_METHOD_RADIO_BUTTON`
`static String`	`ENTITY_METHOD_COMBO_NAME`
`static String`	`ENTITY_METHOD_RADIO_BUTTON`
`static String`	`ENTITY_NAME_COMBO_NAME`
`static String[]`	`entityActionGroup`
`static String[]`	`entityMethodGroup`
`static String`	`FORM_ACTION_RADIO_BUTTON`
`static String[]`	`formActionGroup`
`protected JDialog`	`formDialog`
`static String`	`IM_ACTION_RADIO_BUTTON`
`static String`	`IM_ACTIONS_COMBO_NAME`
`static String[]`	`imanagerActionGroup`
`static String`	`INSERT_SCRIPT_BUTTON`
`protected boolean`	`isScriptingEventsEnabled`
`protected static Hashtable<String,String[]>`	`radioButtonGroups`
`static String`	`SAVE_SCRIPT_BUTTON`
`static String`	`SCRIPT_CODE`
`static String`	`SCRIPT_DESCRIPTION`
`static String`	`SCRIPT_KEY`
`static String`	`SCRIPT_LANGUAGE`
`static String`	`SCRIPT_SELECTION_CONTAINER_ATTR`
`static String`	`SCRIPT_TITLE`
`protected ScriptAction`	`scriptAction`
`protected static String[]`	`scriptEditFields`
`protected Form`	`scriptForm`
`protected ReferenceExtDataField`	`scriptReferenceField`
`static String`	`TRANSACTIONAL_ENTITY_DATA_CHANGE_LISTENER_RADIO_BUTTON`
`static String`	`TRANSACTIONAL_ENTITY_DATA_CHANGE_METHOD_RADIO_BUTTON`
`static String`	`VALUE_CHANGE_LISTENER_RADIO_BUTTON`
`static String`	`VALUE_CHANGE_METHOD_RADIO_BUTTON`

Fields inherited from interface com.ontimize.scripting.gui.IScriptMessages
SCRIPT_ACTION_BUTTON_KEY_NOT_SELECTED, SCRIPT_ACTION_BUTTON_OPTIONS_NOT_SELECTED, SCRIPT_ACTION_ENTITY_METHOD_NOT_SELECTED, SCRIPT_ACTION_FIELD_ATTR_NOT_SELECTED, SCRIPT_ACTION_FIELD_OPTIONS_NOT_SELECTED, SCRIPT_ACTION_IM_METHOD_NOT_SELECTED, SCRIPT_ACTION_NO_ACTION_SELECTED, SCRIPT_ACTION_NO_ENTITY_SELECTED, SCRIPT_CODE_NOT_FOUND, SCRIPT_CREATED_OK, SCRIPT_LANGUAGE_NOT_FOUND, SCRIPT_MANAGER_NOT_DEFAULT_SCRIPT_MANAGER, SCRIPT_NOT_SELECTED, SCRIPT_TITLE_NOT_FOUND, SCRIPT_VALUES_NOT_FOUND

Constructor Summary

Constructors
Constructor and Description

IMDetailScriptAction()

Constructors
Constructor and Description
`IMDetailScriptAction()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`accept()`
`protected void`	`addRadioButtonToGroup(ButtonGroup group, String buttonAttr)` Add the radio a radio button to a group
`protected void`	`cancel()`
`protected void`	`close()`
`protected void`	`configureButtonsCombo()`
`protected void`	`configureComboValues()` Insert the valid values in the TextComboDataField elements
`protected void`	`configureDataFieldsCombo()`
`protected void`	`configureEntityActionParameters(ScriptAction scriptAction)` Configure all the parameters of an entity script
`protected void`	`configureEntityActionsCombo()`
`protected void`	`configureEntityNamesCombo()`
`protected void`	`configureFormActionParameters(ScriptAction scriptAction)` Configure all the parameters of a form action in the `ScriptAction` object
`protected void`	`configureInteractionManagerActionsCombo()`
`protected void`	`configureScriptLanguagesCombo()`
`protected void`	`configureScriptReferenceComboField()`
`protected void`	`configureScriptValues()`
`protected void`	`createNewScript()`
`ScriptAction`	`createScriptActionWithFormData()`
`protected Script`	`createScriptFromFormValues(DefaultScriptManager defaultScriptManager)`
`protected Script`	`createScriptFromReferenceField(DefaultScriptManager defaultScriptManager)`
`protected void`	`enabledFields(Object radioButtonAttr, Object oSelected)` Enable or disable all the fields associated with a radio button
`Object[]`	`getAbstractButtons()`
`protected String`	`getComponentAttr(ScriptAction action)`
`ScriptAction`	`getScriptAction()`
`protected boolean`	`isEntityScriptAction()` Check if the selected action is an entity action or not
`protected boolean`	`isFormScriptAction()` Check if the selected action is a form action or not
`protected boolean`	`isRadioButtonSelected(String attr)`
`void`	`registerInteractionManager(Form form, IFormManager formManager)` Registers the InteractionManager as form event listener.
`protected void`	`saveScript()`
`void`	`setInitialState()` Establishes the initial state of the managed form, and sets the form states in QueryInsert mode that implies that by default the query button and the insert button will be enables.
`void`	`setInsertMode(boolean defaultServerAction)`
`void`	`setScriptAction(ScriptAction action)`
`void`	`setScriptForm(Form form)` Set
`void`	`setUpdateMode()` Sets the mode of the form in Update.

Methods inherited from class com.ontimize.gui.InteractionManager
addInteractionManagerModeListener, checkBirthday, cloneInteractionManager, dataChanged, dataWillChange, finalize, fireInteractionManagerModeChanged, free, getActionHandler, getCheckModifiedDataChangeEvent, getCurrentMode, getDataChangedEventProcessing, getDefaultActiveFocus, getFieldValues, getImageValues, getModifiedFieldAttributes, getTableValues, getTemplateFields, getTemplateImages, getTemplateTables, injectAnnotatedFields, isValueChangeListenerEnabled, loadActionHandler, print, registerFormKeyBindings, registerRuleEngineFor, removeInteractionManagerModeListener, setCheckModifiedDataChangeEvent, setDataChangedEventProcessing, setDefaultFocusEnabled, setInsertMode, setQueryInsertMode, setQueryMode, setUpdateMethodVersion, setValueChangedEventListener, setValueChangeEventListenerEnabled, setWarningBirthdayMessage, valueChanged

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ACCEPT_BUTTON
```
public static final String ACCEPT_BUTTON
```
    See Also:
    Constant Field Values
  - CANCEL_ACTION_BUTTON
```
public static final String CANCEL_ACTION_BUTTON
```
    See Also:
    Constant Field Values
  - CLOSE_BUTTON
```
public static final String CLOSE_BUTTON
```
    See Also:
    Constant Field Values
  - INSERT_SCRIPT_BUTTON
```
public static final String INSERT_SCRIPT_BUTTON
```
    See Also:
    Constant Field Values
  - SAVE_SCRIPT_BUTTON
```
public static final String SAVE_SCRIPT_BUTTON
```
    See Also:
    Constant Field Values
  - BUTTONS_COMBO_NAME
```
public static final String BUTTONS_COMBO_NAME
```
    See Also:
    Constant Field Values
  - DATA_FIELDS_COMBO_NAME
```
public static final String DATA_FIELDS_COMBO_NAME
```
    See Also:
    Constant Field Values
  - ENTITY_METHOD_COMBO_NAME
```
public static final String ENTITY_METHOD_COMBO_NAME
```
    See Also:
    Constant Field Values
  - IM_ACTIONS_COMBO_NAME
```
public static final String IM_ACTIONS_COMBO_NAME
```
    See Also:
    Constant Field Values
  - FORM_ACTION_RADIO_BUTTON
```
public static final String FORM_ACTION_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - ENTITY_ACTION_RADIO_BUTTON
```
public static final String ENTITY_ACTION_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - BUTTON_ACTION_RADIO_BUTTON
```
public static final String BUTTON_ACTION_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - DATA_FIELD_RADIO_BUTTON
```
public static final String DATA_FIELD_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - IM_ACTION_RADIO_BUTTON
```
public static final String IM_ACTION_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - ENTITY_DATA_CHANGE_LISTENER_RADIO_BUTTON
```
public static final String ENTITY_DATA_CHANGE_LISTENER_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - TRANSACTIONAL_ENTITY_DATA_CHANGE_LISTENER_RADIO_BUTTON
```
public static final String TRANSACTIONAL_ENTITY_DATA_CHANGE_LISTENER_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - ENTITY_DATA_CHANGE_METHOD_RADIO_BUTTON
```
public static final String ENTITY_DATA_CHANGE_METHOD_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - TRANSACTIONAL_ENTITY_DATA_CHANGE_METHOD_RADIO_BUTTON
```
public static final String TRANSACTIONAL_ENTITY_DATA_CHANGE_METHOD_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - ENTITY_METHOD_RADIO_BUTTON
```
public static final String ENTITY_METHOD_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - ENTITY_NAME_COMBO_NAME
```
public static final String ENTITY_NAME_COMBO_NAME
```
    See Also:
    Constant Field Values
  - ACTION_LISTENER_RADIO_BUTTON
```
public static final String ACTION_LISTENER_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - ACTION_PERFORMED_RADIO_BUTTON
```
public static final String ACTION_PERFORMED_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - VALUE_CHANGE_LISTENER_RADIO_BUTTON
```
public static final String VALUE_CHANGE_LISTENER_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - VALUE_CHANGE_METHOD_RADIO_BUTTON
```
public static final String VALUE_CHANGE_METHOD_RADIO_BUTTON
```
    See Also:
    Constant Field Values
  - SCRIPT_SELECTION_CONTAINER_ATTR
```
public static final String SCRIPT_SELECTION_CONTAINER_ATTR
```
    See Also:
    Constant Field Values
  - SCRIPT_TITLE
```
public static final String SCRIPT_TITLE
```
    See Also:
    Constant Field Values
  - SCRIPT_LANGUAGE
```
public static final String SCRIPT_LANGUAGE
```
    See Also:
    Constant Field Values
  - SCRIPT_DESCRIPTION
```
public static final String SCRIPT_DESCRIPTION
```
    See Also:
    Constant Field Values
  - SCRIPT_CODE
```
public static final String SCRIPT_CODE
```
    See Also:
    Constant Field Values
  - SCRIPT_KEY
```
public static final String SCRIPT_KEY
```
    See Also:
    Constant Field Values
  - buttonActionGroup
```
public static String[] buttonActionGroup
```
  - dataFieldActionGroup
```
public static String[] dataFieldActionGroup
```
  - imanagerActionGroup
```
public static String[] imanagerActionGroup
```
  - formActionGroup
```
public static String[] formActionGroup
```
  - entityActionGroup
```
public static String[] entityActionGroup
```
  - entityMethodGroup
```
public static String[] entityMethodGroup
```
  - radioButtonGroups
```
protected static Hashtable<String,String[]> radioButtonGroups
```
  - scriptAction
```
protected ScriptAction scriptAction
```
  - scriptReferenceField
```
protected ReferenceExtDataField scriptReferenceField
```
  - scriptEditFields
```
protected static String[] scriptEditFields
```
  - isScriptingEventsEnabled
```
protected boolean isScriptingEventsEnabled
```
  - formDialog
```
protected JDialog formDialog
```
  - scriptForm
```
protected Form scriptForm
```
- Constructor Detail
  - IMDetailScriptAction
```
public IMDetailScriptAction()
```
- Method Detail
  - registerInteractionManager
```
public void registerInteractionManager(Form form,
                              IFormManager formManager)
```
    Description copied from class: InteractionManager
    Registers the InteractionManager as form event listener. This method is called automatically from the IFormManager when a Form is loaded. If new listeners wants to be added to some objects of the managed form, this must be done by overwriting this method.
    In this basic implementation of the method, only the form and the form manager are assigned and stored by the InteractionManager in order to have references to these classes later. A basic way of overwriting this must call the super.registerInteractionManager(form, FormsManager)
    This method links a key stroke to the standard buttons:
    - F7 query
    - F9 insert
    - F11 update
    - F12 delete
    Overrides:
    
    registerInteractionManager in class InteractionManager
    
    Parameters:
    form - - the form to be associated with this manager
    formManager - - the form manager that rules the association
  - configureScriptReferenceComboField
```
protected void configureScriptReferenceComboField()
```
  - configureScriptValues
```
protected void configureScriptValues()
```
  - accept
```
protected void accept()
```
  - cancel
```
protected void cancel()
```
  - close
```
protected void close()
```
  - createScriptFromFormValues
```
protected Script createScriptFromFormValues(DefaultScriptManager defaultScriptManager)
                                     throws Exception
```
    Throws:
    
    Exception
  - createNewScript
```
protected void createNewScript()
```
  - saveScript
```
protected void saveScript()
```
  - enabledFields
```
protected void enabledFields(Object radioButtonAttr,
                 Object oSelected)
```
    Enable or disable all the fields associated with a radio button
    
    Parameters:
    radioButtonAttr - Attribute of the radio button that has changed
    oSelected - It is true if the radio button is selected and the fields must be enabled
  - addRadioButtonToGroup
```
protected void addRadioButtonToGroup(ButtonGroup group,
                         String buttonAttr)
```
    Add the radio a radio button to a group
    
    Parameters:
    group - Radio buttons group
    buttonAttr - Attribute of the new radio button to add to the group
  - setInitialState
```
public void setInitialState()
```
    Description copied from class: InteractionManager
    
    Establishes the initial state of the managed form, and sets the form states in QueryInsert mode that implies that by default the query button and the insert button will be enables. Other buttons of the form will not be enabled by default, so they have to be activated overwriting this method.
    
    Overrides:
    
    setInitialState in class InteractionManager
  - setUpdateMode
```
public void setUpdateMode()
```
    Description copied from class: InteractionManager
    
    Sets the mode of the form in Update. The fields are enabled and allows modifications. The update button is enabled.
    
    Overrides:
    
    setUpdateMode in class InteractionManager
  - setScriptForm
```
public void setScriptForm(Form form)
```
    Set
    
    Specified by:
    
    setScriptForm in interface IDetailScriptAction
    
    Parameters:
    form -
  - configureComboValues
```
protected void configureComboValues()
```
    Insert the valid values in the TextComboDataField elements
  - configureScriptLanguagesCombo
```
protected void configureScriptLanguagesCombo()
```
  - configureEntityActionsCombo
```
protected void configureEntityActionsCombo()
```
  - configureEntityNamesCombo
```
protected void configureEntityNamesCombo()
```
  - configureInteractionManagerActionsCombo
```
protected void configureInteractionManagerActionsCombo()
```
  - configureDataFieldsCombo
```
protected void configureDataFieldsCombo()
```
  - getAbstractButtons
```
public Object[] getAbstractButtons()
```
  - configureButtonsCombo
```
protected void configureButtonsCombo()
```
  - isRadioButtonSelected
```
protected boolean isRadioButtonSelected(String attr)
```
  - getScriptAction
```
public ScriptAction getScriptAction()
```
    Specified by:
    
    getScriptAction in interface IDetailScriptAction
  - createScriptFromReferenceField
```
protected Script createScriptFromReferenceField(DefaultScriptManager defaultScriptManager)
                                         throws Exception
```
    Throws:
    
    Exception
  - createScriptActionWithFormData
```
public ScriptAction createScriptActionWithFormData()
                                            throws Exception
```
    Throws:
    
    Exception
  - isFormScriptAction
```
protected boolean isFormScriptAction()
```
    Check if the selected action is a form action or not
    
    Returns:
    true if the selected action is a form action, false in other case
  - isEntityScriptAction
```
protected boolean isEntityScriptAction()
```
    Check if the selected action is an entity action or not
    
    Returns:
    true if the selected action is an entity action, false in other case
  - configureFormActionParameters
```
protected void configureFormActionParameters(ScriptAction scriptAction)
                                      throws Exception
```
    Configure all the parameters of a form action in the ScriptAction object
    
    Parameters:
    scriptAction -
    
    Throws:
    
    Exception
  - configureEntityActionParameters
```
protected void configureEntityActionParameters(ScriptAction scriptAction)
                                        throws Exception
```
    Configure all the parameters of an entity script
    
    Parameters:
    scriptAction - Object to configure. This object has to contain the entity name, and the action in which the script must be executed
    
    Throws:
    
    Exception
  - setInsertMode
```
public void setInsertMode(boolean defaultServerAction)
```
    Specified by:
    
    setInsertMode in interface IDetailScriptAction
  - getComponentAttr
```
protected String getComponentAttr(ScriptAction action)
```
  - setScriptAction
```
public void setScriptAction(ScriptAction action)
```
    Specified by:
    
    setScriptAction in interface IDetailScriptAction

Class IMDetailScriptAction

Nested Class Summary

Nested classes/interfaces inherited from class com.ontimize.gui.InteractionManager

Field Summary

Fields inherited from class com.ontimize.gui.InteractionManager

Fields inherited from interface com.ontimize.scripting.gui.IScriptMessages

Constructor Summary

Method Summary

Methods inherited from class com.ontimize.gui.InteractionManager

Methods inherited from class java.lang.Object

Field Detail

ACCEPT_BUTTON

CANCEL_ACTION_BUTTON

CLOSE_BUTTON

INSERT_SCRIPT_BUTTON

SAVE_SCRIPT_BUTTON

BUTTONS_COMBO_NAME

DATA_FIELDS_COMBO_NAME

ENTITY_METHOD_COMBO_NAME

IM_ACTIONS_COMBO_NAME

FORM_ACTION_RADIO_BUTTON

ENTITY_ACTION_RADIO_BUTTON

BUTTON_ACTION_RADIO_BUTTON

DATA_FIELD_RADIO_BUTTON

IM_ACTION_RADIO_BUTTON

ENTITY_DATA_CHANGE_LISTENER_RADIO_BUTTON

TRANSACTIONAL_ENTITY_DATA_CHANGE_LISTENER_RADIO_BUTTON

ENTITY_DATA_CHANGE_METHOD_RADIO_BUTTON

TRANSACTIONAL_ENTITY_DATA_CHANGE_METHOD_RADIO_BUTTON

ENTITY_METHOD_RADIO_BUTTON

ENTITY_NAME_COMBO_NAME

ACTION_LISTENER_RADIO_BUTTON

ACTION_PERFORMED_RADIO_BUTTON

VALUE_CHANGE_LISTENER_RADIO_BUTTON

VALUE_CHANGE_METHOD_RADIO_BUTTON

SCRIPT_SELECTION_CONTAINER_ATTR

SCRIPT_TITLE

SCRIPT_LANGUAGE

SCRIPT_DESCRIPTION

SCRIPT_CODE

SCRIPT_KEY

buttonActionGroup

dataFieldActionGroup

imanagerActionGroup

formActionGroup

entityActionGroup

entityMethodGroup

radioButtonGroups

scriptAction

scriptReferenceField

scriptEditFields

isScriptingEventsEnabled

formDialog

scriptForm

Constructor Detail

IMDetailScriptAction

Method Detail

registerInteractionManager

configureScriptReferenceComboField

configureScriptValues

accept

cancel

close

createScriptFromFormValues

createNewScript

saveScript

enabledFields

addRadioButtonToGroup

setInitialState

setUpdateMode

setScriptForm

configureComboValues

configureScriptLanguagesCombo

configureEntityActionsCombo

configureEntityNamesCombo

configureInteractionManagerActionsCombo

configureDataFieldsCombo

getAbstractButtons

configureButtonsCombo

isRadioButtonSelected