org.esa.snap.ui.tooladapter.dialogs

Class AbstractAdapterEditor

java.lang.Object

org.esa.snap.ui.AbstractDialog

org.esa.snap.ui.ModalDialog

org.esa.snap.ui.tooladapter.dialogs.AbstractAdapterEditor

Direct Known Subclasses:

ToolAdapterEditorDialog, ToolAdapterTabbedEditorDialog

public abstract class AbstractAdapterEditor
extends ModalDialog

A dialog window used to edit an operator, or to create a new operator. It shows details of an operator such as: descriptor details (name, alias, label, version, copyright, authors, description), system variables, preprocessing tool, product writer, tool location, operator working directory, command line template content, tool output patterns and parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected BindingContext	bindingContext
protected AppContext	context
protected int	controlHeight
protected JTextField	customMenuLocation
protected int	formWidth
static String	helpID
protected Logger	logger
protected static int	MAX_4K_HEIGHT
protected static int	MAX_4K_WIDTH
protected static String	MESSAGE_REQUIRED
protected static int	MIN_HEIGHT
protected static int	MIN_TABBED_HEIGHT
protected static int	MIN_TABBED_WIDTH
protected static int	MIN_WIDTH
protected int	newNameIndex
protected ToolAdapterOperatorDescriptor	newOperatorDescriptor
protected ToolAdapterOperatorDescriptor	oldOperatorDescriptor
protected boolean	operatorIsNew
protected OperatorParametersTable	paramsTable
protected PropertyContainer	propertyContainer
protected JRadioButton	rbMenuNew
protected JTextArea	templateContent

Fields inherited from class org.esa.snap.ui.ModalDialog

ID_OK_APPLY_CANCEL, ID_OK_APPLY_CANCEL_HELP, ID_OK_CANCEL, ID_OK_CANCEL_HELP, ID_YES_NO, ID_YES_NO_HELP

Fields inherited from class org.esa.snap.ui.AbstractDialog

ID_APPLY, ID_CANCEL, ID_CLOSE, ID_HELP, ID_NO, ID_OK, ID_OTHER, ID_RESET, ID_YES

Constructor Summary

Constructors

Constructor and Description
AbstractAdapterEditor(AppContext appContext, JDialog parent, ToolAdapterOperatorDescriptor operatorDescriptor, boolean operatorIsNew) Constructs a new window for editing the operator
AbstractAdapterEditor(AppContext appContext, JDialog parent, ToolAdapterOperatorDescriptor operatorDescriptor, int newNameIndex) Constructs a new window for editing the operator

Method Summary

Modifier and Type	Method and Description
protected void	addComboField(JPanel parent, String labelText, String propertyName, List<String> values, boolean sortValues, boolean isRequired)
protected void	addTextField(JPanel parent, TextFieldEditor textEditor, String labelText, String propertyName, boolean isRequired)
protected void	addValidatedTextField(JPanel parent, TextFieldEditor textEditor, String labelText, String propertyName, String validatorRegex)
protected JComponent	createCheckboxComponent(String memberName, JComponent toogleComponentEnabled, Boolean value)
protected abstract JPanel	createDescriptorPanel()
static AbstractAdapterEditor	createEditorDialog(AppContext appContext, JDialog parent, ToolAdapterOperatorDescriptor operatorDescriptor, boolean operatorIsNew)
static AbstractAdapterEditor	createEditorDialog(AppContext appContext, JDialog parent, ToolAdapterOperatorDescriptor operatorDescriptor, int newNameIndex)
protected abstract JComponent	createMainPanel()
protected abstract JPanel	createParametersPanel()
protected abstract JPanel	createPatternsPanel()
protected abstract JPanel	createPreProcessingPanel()
protected JTextArea	createTemplateEditorField()
protected abstract JPanel	createToolInfoPanel()
protected abstract JPanel	createVariablesPanel()
protected List<String>	getAutocompleteEntries()
protected List<String>	getAvailableMenuOptions(org.openide.filesystems.FileObject current)
protected void	onOK() Called if the "OK" button has been clicked.
protected void	onOther() Called if a non-standard button has been clicked.
protected boolean	resolveTemplateProductCount(String templateContent)
protected boolean	shouldValidate()
int	show() Shows the dialog.
protected boolean	verifyUserInput() Called in order to perform input validation.

Methods inherited from class org.esa.snap.ui.ModalDialog

close

Methods inherited from class org.esa.snap.ui.AbstractDialog

center, collectButtons, getButton, getButtonID, getButtonMask, getButtonPanel, getContent, getHelpID, getJDialog, getParent, getQualifiedPropertyName, getTitle, hide, onApply, onCancel, onClose, onHelp, onNo, onReset, onYes, registerButton, setButtonID, setContent, setContent, setHelpID, setTitle, showErrorDialog, showInformationDialog, showWarningDialog

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_REQUIRED

protected static final String MESSAGE_REQUIRED

See Also:

Constant Field Values

MIN_WIDTH

protected static final int MIN_WIDTH

See Also:

Constant Field Values

MIN_HEIGHT

protected static final int MIN_HEIGHT

See Also:

Constant Field Values

MIN_TABBED_WIDTH

protected static final int MIN_TABBED_WIDTH

See Also:

Constant Field Values

MIN_TABBED_HEIGHT

protected static final int MIN_TABBED_HEIGHT

See Also:

Constant Field Values

MAX_4K_WIDTH

protected static int MAX_4K_WIDTH

MAX_4K_HEIGHT

protected static int MAX_4K_HEIGHT

oldOperatorDescriptor

protected ToolAdapterOperatorDescriptor oldOperatorDescriptor

newOperatorDescriptor

protected ToolAdapterOperatorDescriptor newOperatorDescriptor

operatorIsNew

protected boolean operatorIsNew

newNameIndex

protected int newNameIndex

propertyContainer

protected PropertyContainer propertyContainer

bindingContext

protected BindingContext bindingContext

templateContent

protected JTextArea templateContent

paramsTable

protected OperatorParametersTable paramsTable

context

protected AppContext context

logger

protected Logger logger

customMenuLocation

protected JTextField customMenuLocation

rbMenuNew

protected JRadioButton rbMenuNew

helpID

public static final String helpID

See Also:

Constant Field Values

formWidth

protected int formWidth

controlHeight

protected int controlHeight

Constructor Detail

AbstractAdapterEditor

public AbstractAdapterEditor(AppContext appContext,
                             JDialog parent,
                             ToolAdapterOperatorDescriptor operatorDescriptor,
                             boolean operatorIsNew)

Constructs a new window for editing the operator

Parameters:

appContext - the application context

operatorDescriptor - the descriptor of the operator to be edited

operatorIsNew - true if the operator was not previously registered (so it is a new operator) and false if the operator was registered and the editing operation is requested

AbstractAdapterEditor

public AbstractAdapterEditor(AppContext appContext,
                             JDialog parent,
                             ToolAdapterOperatorDescriptor operatorDescriptor,
                             int newNameIndex)

Constructs a new window for editing the operator

Parameters:

appContext - the application context

operatorDescriptor - the descriptor of the operator to be edited

newNameIndex - an integer value representing the suffix for the new operator name; if this value is less than 1, the editing operation of the current operator is executed; if the value is equal to or greater than 1, the operator is duplicated and the index value is used to compute the name of the new operator

Method Detail

createEditorDialog

public static AbstractAdapterEditor createEditorDialog(AppContext appContext,
                                                       JDialog parent,
                                                       ToolAdapterOperatorDescriptor operatorDescriptor,
                                                       boolean operatorIsNew)

createEditorDialog

public static AbstractAdapterEditor createEditorDialog(AppContext appContext,
                                                       JDialog parent,
                                                       ToolAdapterOperatorDescriptor operatorDescriptor,
                                                       int newNameIndex)

createMainPanel

protected abstract JComponent createMainPanel()

createDescriptorPanel

protected abstract JPanel createDescriptorPanel()

createVariablesPanel

protected abstract JPanel createVariablesPanel()

createPreProcessingPanel

protected abstract JPanel createPreProcessingPanel()

createToolInfoPanel

protected abstract JPanel createToolInfoPanel()

createPatternsPanel

protected abstract JPanel createPatternsPanel()

createParametersPanel

protected abstract JPanel createParametersPanel()

shouldValidate

protected boolean shouldValidate()

verifyUserInput

protected boolean verifyUserInput()

Description copied from class: AbstractDialog

Called in order to perform input validation.

Overrides:

verifyUserInput in class AbstractDialog

Returns:

true if and only if the validation was successful.

onOK

protected void onOK()

Description copied from class: AbstractDialog

Called if the "OK" button has been clicked. The default implementation calls AbstractDialog.hide(). Clients should override this method to implement meaningful behaviour.

Overrides:

onOK in class AbstractDialog

show

public int show()

Description copied from class: AbstractDialog

Shows the dialog. Overrides shall call super.show() at the end.

Overrides:

show in class AbstractDialog

Returns:

the identifier of the last button pressed or zero if this is a modeless dialog.

onOther

protected void onOther()

Description copied from class: AbstractDialog

Called if a non-standard button has been clicked. The default implementation calls AbstractDialog.hide(). Clients should override this method to implement meaningful behaviour.

Overrides:

onOther in class AbstractDialog

createCheckboxComponent

protected JComponent createCheckboxComponent(String memberName,
                                             JComponent toogleComponentEnabled,
                                             Boolean value)

addValidatedTextField

protected void addValidatedTextField(JPanel parent,
                                     TextFieldEditor textEditor,
                                     String labelText,
                                     String propertyName,
                                     String validatorRegex)

addTextField

protected void addTextField(JPanel parent,
                            TextFieldEditor textEditor,
                            String labelText,
                            String propertyName,
                            boolean isRequired)

addComboField

protected void addComboField(JPanel parent,
                             String labelText,
                             String propertyName,
                             List<String> values,
                             boolean sortValues,
                             boolean isRequired)

getAvailableMenuOptions

protected List<String> getAvailableMenuOptions(org.openide.filesystems.FileObject current)

resolveTemplateProductCount

protected boolean resolveTemplateProductCount(String templateContent)

createTemplateEditorField

protected JTextArea createTemplateEditorField()

getAutocompleteEntries

protected List<String> getAutocompleteEntries()