weka.gui.knowledgeflow

Class StepEditorDialog

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

weka.gui.knowledgeflow.StepEditorDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, EnvironmentHandler

Direct Known Subclasses:

BlockStepEditorDialog, DataGridStepEditorDialog, ExecuteProcessStepEditorDialog, FlowByExpressionStepEditorDialog, GOEStepEditorDialog, JoinStepEditorDialog, NoteEditorDialog, SetVariablesStepEditorDialog, StorePropertiesInEnvironmentStepEditorDialog, SubstringLabelerStepEditorDialog, SubstringReplacerStepEditorDialog

public abstract class StepEditorDialog
extends javax.swing.JPanel
implements EnvironmentHandler

Base class for step editor dialogs. Clients can extend this in order to supply their own custom dialogs. The constructor for this class provides OK and Cancel buttons in the SOUTH location of a BorderLayout. To do meaningful things on click of OK or Cancel, subclasses should override okPressed() and/or cancelPressed(). If setStepToEdit() is not overridden, then this class will also provide an "about" panel in the NORTH location of BorderLayout. This then leaves the CENTER of the BorderLayout for custom widgets. Subclasses should typically override the no-op layoutEditor() method to add their widgets.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StepEditorDialog.ClosingListener Interface for those that want to be notified when this dialog closes

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

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JPanel	m_buttonHolder Holder for buttons
protected javax.swing.JButton	m_cancelBut Cancel button
protected StepEditorDialog.ClosingListener	m_closingListener Listener to be informed when the window closes
protected KFGraphicalEnvironmentCommandHandler	m_commandHandler The handler for graphical commands
protected Environment	m_env Environment variables
protected javax.swing.JButton	m_helpBut About button
protected java.lang.StringBuilder	m_helpText Buffer to hold the help text
protected boolean	m_isEdited True if the step's properties have been altered
protected MainKFPerspective	m_mainPerspective Reference to the main perspective
protected javax.swing.JButton	m_okBut OK button
protected java.awt.Window	m_parent Parent window
protected javax.swing.JButton	m_settingsBut Settings button
protected Step	m_stepToEdit The step to edit

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 and Description
StepEditorDialog() Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addSettingsButton() Adds a button for popping up a settings editor.
protected void	cancelPressed() Called when the Cancel button is pressed.
protected void	createAboutPanel(Step step) Creates an "about" panel to add to the dialog
java.lang.String	environmentSubstitute(java.lang.String source) Substitute the values of any environment variables present in the supplied string
Environment	getEnvironment() Get environment variables
protected KFGraphicalEnvironmentCommandHandler	getGraphicalEnvironmentCommandHandler() Get the environment for performing commands at the application-level in a graphical environment.
protected MainKFPerspective	getMainPerspective() Get the main knowledgeflow perspective
protected Step	getStepToEdit() Get the step being edited
protected boolean	isEdited() Returns true if the properties of the step being edited have been changed
protected void	layoutEditor() Layout the editor.
protected void	okPressed() Called when the OK button is pressed.
protected void	setClosingListener(StepEditorDialog.ClosingListener c) Set a closing listener
protected void	setEdited(boolean edited) Set whether the step's properties have changed or not
void	setEnvironment(Environment env) Set environment variables
protected void	setMainPerspective(MainKFPerspective main) Set the main perspective
protected void	setParentWindow(java.awt.Window parent) Set the parent window of this dialog
protected void	setStepToEdit(Step step) Set the step to edit
protected void	showErrorDialog(java.lang.Exception cause) Show an error dialog
protected void	showInfoDialog(java.lang.Object information, java.lang.String title, boolean isWarning) Show an information dialog

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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

m_isEdited

protected boolean m_isEdited

True if the step's properties have been altered

m_env

protected Environment m_env

Environment variables

m_buttonHolder

protected javax.swing.JPanel m_buttonHolder

Holder for buttons

m_okBut

protected javax.swing.JButton m_okBut

OK button

m_cancelBut

protected javax.swing.JButton m_cancelBut

Cancel button

m_settingsBut

protected javax.swing.JButton m_settingsBut

Settings button

m_mainPerspective

protected MainKFPerspective m_mainPerspective

Reference to the main perspective

m_parent

protected java.awt.Window m_parent

Parent window

m_closingListener

protected StepEditorDialog.ClosingListener m_closingListener

Listener to be informed when the window closes

m_stepToEdit

protected Step m_stepToEdit

The step to edit

m_helpText

protected java.lang.StringBuilder m_helpText

Buffer to hold the help text

m_helpBut

protected javax.swing.JButton m_helpBut

About button

m_commandHandler

protected KFGraphicalEnvironmentCommandHandler m_commandHandler

The handler for graphical commands

Constructor Detail

StepEditorDialog

public StepEditorDialog()

Constructor

Method Detail

setMainPerspective

protected void setMainPerspective(MainKFPerspective main)

Set the main perspective

Parameters:

main - the main perspective

getMainPerspective

protected MainKFPerspective getMainPerspective()

Get the main knowledgeflow perspective

Returns:

the main knowledge flow perspective

getGraphicalEnvironmentCommandHandler

protected KFGraphicalEnvironmentCommandHandler getGraphicalEnvironmentCommandHandler()

Get the environment for performing commands at the application-level in a graphical environment.

Returns:

the graphical environment command handler.

showErrorDialog

protected void showErrorDialog(java.lang.Exception cause)

Show an error dialog

Parameters:

cause - an exception to show in the dialog

showInfoDialog

protected void showInfoDialog(java.lang.Object information,
                              java.lang.String title,
                              boolean isWarning)

Show an information dialog

Parameters:

information - the information to show

title - the title for the dialog

isWarning - true if this is a warning rather than general information

getStepToEdit

protected Step getStepToEdit()

Get the step being edited

Returns:

setStepToEdit

protected void setStepToEdit(Step step)

Set the step to edit

Parameters:

step - the step to edit

layoutEditor

protected void layoutEditor()

Layout the editor. This is a no-op method that subclasses should override

addSettingsButton

protected void addSettingsButton()

Adds a button for popping up a settings editor. Is only visible if the step being edited provides default settings

setParentWindow

protected void setParentWindow(java.awt.Window parent)

Set the parent window of this dialog

Parameters:

parent - the parent window

setClosingListener

protected void setClosingListener(StepEditorDialog.ClosingListener c)

Set a closing listener

Parameters:

c - the closing listener

isEdited

protected boolean isEdited()

Returns true if the properties of the step being edited have been changed

Returns:

true if the step has been edited

setEdited

protected void setEdited(boolean edited)

Set whether the step's properties have changed or not

Parameters:

edited - true if the step has been edited

okPressed

protected void okPressed()

Called when the OK button is pressed. This is a no-op method - subclasses should override

cancelPressed

protected void cancelPressed()

Called when the Cancel button is pressed. This is a no-op method - subclasses should override

createAboutPanel

protected void createAboutPanel(Step step)

Creates an "about" panel to add to the dialog

Parameters:

step - the step from which to extract help info

getEnvironment

public Environment getEnvironment()

Get environment variables

Returns:

environment variables

setEnvironment

public void setEnvironment(Environment env)

Set environment variables

Specified by:

setEnvironment in interface EnvironmentHandler

Parameters:

env - the environment variables to use

environmentSubstitute

public java.lang.String environmentSubstitute(java.lang.String source)

Substitute the values of any environment variables present in the supplied string

Parameters:

source - the source string to substitute vars in

Returns:

the string with any environment variables substituted