Package chemaxon.marvin.plugin.gui

Class OptionsPane

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

chemaxon.marvin.plugin.gui.OptionsPane

All Implemented Interfaces:

ActionListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

@PublicAPI
public class OptionsPane
extends JDialog
implements ActionListener, WindowListener

Displays plugin parameter tabbed panes.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JDialog

JDialog.AccessibleJDialog

Nested classes/interfaces inherited from class java.awt.Dialog

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
OptionsPane(Dialog owner, String key, String title, ParameterPanelHandler parameterPanel, ActionListener okActionListener)	Creates an options pane: plugin parameter panel with "Display", "OK", "Cancel" buttons.
OptionsPane(Frame owner, String key, String title, ParameterPanelHandler parameterPanel, ActionListener okActionListener)	Creates an options pane: plugin parameter panel with "Display", "OK", "Cancel" buttons.
OptionsPane(String key, String title, ParameterPanelHandler parameterPanel, ActionListener okActionListener)	Creates an options pane: plugin parameter panel with "Display", "OK", "Cancel" buttons.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent ev)	Action handler.
String	getKey()	Returns the plugin key.
void	getParameters(Properties params)	Returns the parameters set by the user.
void	setActionsEnabled(boolean enable)	Enables / disables action buttons.
void	windowActivated(WindowEvent e)	Do nothing.
void	windowClosed(WindowEvent e)	Do nothing.
void	windowClosing(WindowEvent e)	Close the window.
void	windowDeactivated(WindowEvent e)	Do nothing.
void	windowDeiconified(WindowEvent e)	Do nothing.
void	windowIconified(WindowEvent e)	Do nothing.
void	windowOpened(WindowEvent e)	Do nothing.

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionsPane

public OptionsPane(String key,
                   String title,
                   ParameterPanelHandler parameterPanel,
                   ActionListener okActionListener)
            throws PluginException

Creates an options pane: plugin parameter panel with "Display", "OK", "Cancel" buttons. The "OK", "Cancel" buttons are handled internally, 'displayActionListener' handles the "Display" button. A shared, hidden frame will be set as the owner of the dialog.

Parameters:

key - is the plugin key

title - is the plugin title (usually menu string)

parameterPanel - is the plugin parameter panel

okActionListener - is the event handler of the "Display" button with action command "plugin_"+key, no "Display" button is put if set to null

Throws:

PluginException

OptionsPane

public OptionsPane(Dialog owner,
                   String key,
                   String title,
                   ParameterPanelHandler parameterPanel,
                   ActionListener okActionListener)
            throws PluginException

Creates an options pane: plugin parameter panel with "Display", "OK", "Cancel" buttons. The "OK", "Cancel" buttons are handled internally, 'displayActionListener' handles the "Display" button.

Parameters:

owner - the non-null Dialog from which the dialog is displayed

key - is the plugin key

title - is the plugin title (usually menu string)

parameterPanel - is the plugin parameter panel

okActionListener - is the event handler of the "Display" button with action command "plugin_"+key, no "Display" button is put if set to null

Throws:

PluginException

OptionsPane

public OptionsPane(Frame owner,
                   String key,
                   String title,
                   ParameterPanelHandler parameterPanel,
                   ActionListener okActionListener)
            throws PluginException

Creates an options pane: plugin parameter panel with "Display", "OK", "Cancel" buttons. The "OK", "Cancel" buttons are handled internally, 'displayActionListener' handles the "Display" button.

Parameters:

owner - the Frame from which the dialog is displayed

key - is the plugin key

title - is the plugin title (usually menu string)

parameterPanel - is the plugin parameter panel

okActionListener - is the event handler of the "Display" button with action command "plugin_"+key, no "Display" button is put if set to null

Throws:

PluginException

Method Detail

getKey

public String getKey()

Returns the plugin key.

Returns:

the plugin key

getParameters

public void getParameters(Properties params)

Returns the parameters set by the user.

Parameters:

params - is the properties object to be filled with the plugin parameters

actionPerformed

public void actionPerformed(ActionEvent ev)

Action handler.

Specified by:

actionPerformed in interface ActionListener

Parameters:

ev - the action event

setActionsEnabled

public void setActionsEnabled(boolean enable)

Enables / disables action buttons. Sets cursor accordingly: Cursor.WAIT_CURSOR for disabled state, Cursor.DEFAULT_CURSOR for enabled state.

Parameters:

enable - is true if to be enabled

windowOpened

public void windowOpened(WindowEvent e)

Do nothing.

Specified by:

windowOpened in interface WindowListener

windowClosing

public void windowClosing(WindowEvent e)

Close the window.

Specified by:

windowClosing in interface WindowListener

windowClosed

public void windowClosed(WindowEvent e)

Do nothing.

Specified by:

windowClosed in interface WindowListener

windowIconified

public void windowIconified(WindowEvent e)

Do nothing.

Specified by:

windowIconified in interface WindowListener

windowDeiconified

public void windowDeiconified(WindowEvent e)

Do nothing.

Specified by:

windowDeiconified in interface WindowListener

windowActivated

public void windowActivated(WindowEvent e)

Do nothing.

Specified by:

windowActivated in interface WindowListener

windowDeactivated

public void windowDeactivated(WindowEvent e)

Do nothing.

Specified by:

windowDeactivated in interface WindowListener