Package chemaxon.marvin.plugin.gui
Class ParameterPanel
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- chemaxon.marvin.plugin.gui.ParameterPanel
-
- All Implemented Interfaces:
ParameterPanelHandler
,ImageObserver
,MenuContainer
,Serializable
,Accessible
@PublicAPI public class ParameterPanel extends JPanel implements ParameterPanelHandler
A configurable implementation of the plugin specific parameter setting panel. The panel has a n-row 2-column GridLayout, displaying each GUI parameter setter element in a single row with a preceeding display label. The panel is initialized by an array ofParameterTab
objects which store data read from the XML configuration.- Since:
- Marvin 4.0, 02/28/2005
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JPanel
JPanel.AccessibleJPanel
-
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
-
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 Modifier and Type Field Description protected chemaxon.marvin.plugin.gui.ParameterItem[]
items
-
Fields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
-
Fields inherited from class java.awt.Component
accessibleContext, 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
-
-
Constructor Summary
Constructors Constructor Description ParameterPanel(ParameterTab pane, ParameterTab[] tabs)
Constructor.ParameterPanel(ParameterTab pane, ParameterTab[] tabs, chemaxon.marvin.plugin.gui.ParameterItem[] items)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Component
getComponent()
Returns the parameter panel component.void
getParameters(Properties params)
Returns the plugin parameters.void
getStoredParameters(Properties params)
Returns the stored parameters.boolean
isOkActionEnabled()
Returnstrue
if "OK" button is enabled.void
reloadParameters()
Reloads previously stored parameters to parameter panel.void
restoreDefaultParameters()
Restores default parameters to parameter panel.void
saveParameters()
Saves parameters from parameter panel.boolean
verifyParameters()
Verifies parameters on the parameter panel.-
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
-
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
-
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
-
-
-
Constructor Detail
-
ParameterPanel
public ParameterPanel(ParameterTab pane, ParameterTab[] tabs)
Constructor.- Parameters:
pane
- the main parameter panetabs
- the parameter tab data array
-
ParameterPanel
public ParameterPanel(ParameterTab pane, ParameterTab[] tabs, chemaxon.marvin.plugin.gui.ParameterItem[] items)
Constructor.- Parameters:
pane
- the main parameter panetabs
- the parameter tab data arrayitems
-
-
-
Method Detail
-
getComponent
public Component getComponent()
Returns the parameter panel component. This can be the object implementing this interface, in which case simply returnthis
.- Specified by:
getComponent
in interfaceParameterPanelHandler
- Returns:
- the parameter panel component
-
getParameters
public void getParameters(Properties params)
Returns the plugin parameters. These can be stored parameters if the panel is not showing, but should be the currently visible parameter settings if the component is showing. Only the enabled parameter items are included.- Specified by:
getParameters
in interfaceParameterPanelHandler
- Parameters:
params
- is the properties object to be filled with the plugin parameters
-
getStoredParameters
public void getStoredParameters(Properties params)
Returns the stored parameters. All parameter items are included (also disabled).- Specified by:
getStoredParameters
in interfaceParameterPanelHandler
- Parameters:
params
- is the properties object to be filled with the plugin parameters
-
saveParameters
public void saveParameters()
Saves parameters from parameter panel. Should store the current settings in order to restore them later inreloadParameters()
. (Called when "OK" is pressed: GUI -> INNER STORE)- Specified by:
saveParameters
in interfaceParameterPanelHandler
-
reloadParameters
public void reloadParameters()
Reloads previously stored parameters to parameter panel. (Called when "Cancel" is pressed: INNER STORE -> GUI)- Specified by:
reloadParameters
in interfaceParameterPanelHandler
-
restoreDefaultParameters
public void restoreDefaultParameters()
Restores default parameters to parameter panel. (Called when "Restore Defaults" is pressed: DEFAULTS -> GUI)- Specified by:
restoreDefaultParameters
in interfaceParameterPanelHandler
-
verifyParameters
public boolean verifyParameters()
Verifies parameters on the parameter panel. (E.g. checks if a textfield declared to be of type "Double" contains a string convertable to a double.)- Specified by:
verifyParameters
in interfaceParameterPanelHandler
- Returns:
- true if parameter setting is accepted, false otherwise
-
isOkActionEnabled
public boolean isOkActionEnabled()
Description copied from interface:ParameterPanelHandler
Returnstrue
if "OK" button is enabled.- Specified by:
isOkActionEnabled
in interfaceParameterPanelHandler
- Returns:
true
if "OK" button is enabled
-
-