Package docking.options.editor
Class OptionsDialog
- java.lang.Object
-
- docking.DialogComponentProvider
-
- docking.options.editor.OptionsDialog
-
- All Implemented Interfaces:
ActionContextProvider
,StatusListener
,TaskListener
public class OptionsDialog extends DialogComponentProvider
Dialog for editing options within a tool.
-
-
Field Summary
-
Fields inherited from class docking.DialogComponentProvider
applyButton, buttonPanel, cancelButton, dismissButton, okButton, rootPanel
-
-
Constructor Summary
Constructors Constructor Description OptionsDialog(java.lang.String title, java.lang.String rootNodeName, Options[] options, OptionsEditorListener listener)
Construct a new OptionsDialog.OptionsDialog(java.lang.String title, java.lang.String rootNodeName, Options[] options, OptionsEditorListener listener, boolean showRestoreDefaultsButton)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
applyCallback()
The callback method for when the "Apply" button is pressed.protected void
cancelCallback()
The callback method for when the "Cancel" button is pressed.void
displayCategory(java.lang.String category, java.lang.String filterText)
void
dispose()
javax.swing.tree.TreePath
getSelectedPath()
protected void
okCallback()
The callback method for when the "OK" button is pressed.void
setSelectedPath(javax.swing.tree.TreePath path)
-
Methods inherited from class docking.DialogComponentProvider
addAction, addApplyButton, addButton, addCancelButton, addDismissButton, addOKButton, addWorkPanel, alertMessage, alertMessage, cancelCurrentTask, clearScheduledTask, clearStatusText, close, dialogClosed, dialogShown, dismissCallback, doInitialize, escapeCallback, executeProgressTask, getActionContext, getActions, getBackground, getBounds, getComponent, getDefaultButton, getDefaultSize, getDialogSize, getFocusComponent, getGlassPane, getHelpLocatdion, getId, getIntialLocation, getLocationOnScreen, getParent, getPreferredSize, getRemberSize, getRememberLocation, getStatusColor, getStatusLabel, getStatusText, getTaskMonitorComponent, getTaskScheduler, getTitle, getUseSharedLocation, hideTaskMonitorComponent, isApplyEnabled, isCancelEnabled, isModal, isOKEnabled, isResizeable, isRunningTask, isShowing, isTransient, isVisible, notifyContextChanged, removeAction, removeButton, removeWorkPanel, repack, setApplyEnabled, setApplyToolTip, setBackground, setCancelButtonText, setCancelEnabled, setCancelToolTip, setCursor, setDefaultButton, setDefaultSize, setDialogSize, setDismissToolTip, setFocusComponent, setGlassPane, setHelpLocation, setInitialLocation, setMinimumSize, setMinimumSize, setOkButtonText, setOkEnabled, setOkToolTip, setPreferredSize, setRememberLocation, setRememberSize, setResizable, setStatusJustification, setStatusText, setStatusText, setStatusText, setTitle, setTransient, setUseSharedLocation, showProgressBar, showTaskMonitorComponent, stopProgressTimer, taskCancelled, taskCompleted, toFront, toString, waitForCurrentTask
-
-
-
-
Constructor Detail
-
OptionsDialog
public OptionsDialog(java.lang.String title, java.lang.String rootNodeName, Options[] options, OptionsEditorListener listener)
Construct a new OptionsDialog.- Parameters:
title
- dialog titlerootNodeName
- name to display for the root node in the treeoptions
- editable optionslistener
- listener notified when the apply button is hit.
-
OptionsDialog
public OptionsDialog(java.lang.String title, java.lang.String rootNodeName, Options[] options, OptionsEditorListener listener, boolean showRestoreDefaultsButton)
-
-
Method Detail
-
dispose
public void dispose()
- Overrides:
dispose
in classDialogComponentProvider
-
getSelectedPath
public javax.swing.tree.TreePath getSelectedPath()
-
setSelectedPath
public void setSelectedPath(javax.swing.tree.TreePath path)
-
cancelCallback
protected void cancelCallback()
Description copied from class:DialogComponentProvider
The callback method for when the "Cancel" button is pressed. The default behavior is to call setVisible(false) and dispose() on the dialog.- Overrides:
cancelCallback
in classDialogComponentProvider
-
okCallback
protected void okCallback()
Description copied from class:DialogComponentProvider
The callback method for when the "OK" button is pressed.- Overrides:
okCallback
in classDialogComponentProvider
-
applyCallback
protected void applyCallback()
Description copied from class:DialogComponentProvider
The callback method for when the "Apply" button is pressed.- Overrides:
applyCallback
in classDialogComponentProvider
-
displayCategory
public void displayCategory(java.lang.String category, java.lang.String filterText)
-
-