Package elki.gui.multistep.panels
Class ParameterTabPanel
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- elki.gui.multistep.panels.ParameterTabPanel
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,java.util.EventListener
,javax.accessibility.Accessible
,javax.swing.event.ChangeListener
- Direct Known Subclasses:
AlgorithmTabPanel
,EvaluationTabPanel
,InputTabPanel
,LoggingTabPanel
,OutputTabPanel
public abstract class ParameterTabPanel extends javax.swing.JPanel implements javax.swing.event.ChangeListener
Abstract panel, showing particular options.- Since:
- 0.4.0
- Author:
- Erich Schubert
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ParameterTabPanel.Status
Status code enumeration-
Nested classes/interfaces inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description private static Logging
LOG
ELKI logger for the GUIprivate ConfiguratorPanel
parameterTable
The parameter tableprivate javax.swing.JButton
runButton
The "run" button.private static long
serialVersionUID
Serial versionprivate javax.swing.JLabel
statusText
The status text field-
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
-
-
Constructor Summary
Constructors Constructor Description ParameterTabPanel()
Input pane
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addPanelListener(ParameterTabPanel o)
void
appendParameters(ListParameterization params)
Collect parametersboolean
canRun()
Test if this tab is ready-to-runprotected abstract void
configureStep(Parameterization config)
Configure this step with the given parameters.protected void
execute()
Execute the task.protected abstract void
executeStep()
Execute the configured step.protected void
firePanelUpdated()
protected abstract ParameterTabPanel.Status
getStatus()
Get the current status of this step.boolean
isComplete()
Test if this tab is complete(package private) void
panelUpdated(ParameterTabPanel o)
Called when an observed panel changes.void
removePanelListener(ParameterTabPanel o)
protected void
reportErrors(Parameterization config)
Report errors in a single error log record.void
setParameters(Parameterization config)
Do the actual setParameters invocation.void
stateChanged(javax.swing.event.ChangeEvent e)
protected void
updateParameterTable()
Serialize the parameter table and run setParameters()protected void
updateStatus()
Invoked to update the UI when the status could have changed.-
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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
Serial version- See Also:
- Constant Field Values
-
LOG
private static final Logging LOG
ELKI logger for the GUI
-
parameterTable
private final ConfiguratorPanel parameterTable
The parameter table
-
runButton
private final javax.swing.JButton runButton
The "run" button.
-
statusText
private final javax.swing.JLabel statusText
The status text field
-
-
Method Detail
-
updateParameterTable
protected void updateParameterTable()
Serialize the parameter table and run setParameters()
-
setParameters
public void setParameters(Parameterization config)
Do the actual setParameters invocation.- Parameters:
config
- Parameterization
-
appendParameters
public void appendParameters(ListParameterization params)
Collect parameters- Parameters:
params
- Parameter list to add to
-
reportErrors
protected void reportErrors(Parameterization config)
Report errors in a single error log record.- Parameters:
config
- Parameterization
-
execute
protected void execute()
Execute the task.
-
configureStep
protected abstract void configureStep(Parameterization config)
Configure this step with the given parameters.- Parameters:
config
- Configuration to use.
-
getStatus
protected abstract ParameterTabPanel.Status getStatus()
Get the current status of this step.- Returns:
- current status
-
executeStep
protected abstract void executeStep()
Execute the configured step.
-
canRun
public boolean canRun()
Test if this tab is ready-to-run- Returns:
- can-run status
-
isComplete
public boolean isComplete()
Test if this tab is complete- Returns:
- completeness status
-
updateStatus
protected void updateStatus()
Invoked to update the UI when the status could have changed.
-
firePanelUpdated
protected void firePanelUpdated()
-
addPanelListener
public void addPanelListener(ParameterTabPanel o)
-
removePanelListener
public void removePanelListener(ParameterTabPanel o)
-
stateChanged
public void stateChanged(javax.swing.event.ChangeEvent e)
- Specified by:
stateChanged
in interfacejavax.swing.event.ChangeListener
-
panelUpdated
void panelUpdated(ParameterTabPanel o)
Called when an observed panel changes.- Parameters:
o
- Observed panel
-
-