jpiv2
Class ScriptDlg

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      jpiv2.ScriptDlg

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class ScriptDlg
extends javax.swing.JDialog

A customizable dialog for user input. This dialog is intended for use in scripts. It displays a dialog with some information about the script and its usage, and it gives the user the possibility to insert some variables. Use the addVariable(String name, String value, String description) method to add a new variable. Use the display() method to show the dialog. This method will return when the user presses either 'quit' or 'execute'. There are several getAs...(String name) methods to retrieve the values of the variables.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JDialog.AccessibleJDialog

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

java.awt.Dialog.AccessibleAWTDialog

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

java.awt.Window.AccessibleAWTWindow

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

int	EXECUTE_OPTION returned by display() if user selected 'execute'
int	QUIT_OPTION returned by display() if user selected 'quit'

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

ScriptDlg(java.awt.Frame parent, java.lang.String title, java.lang.String author)
Constructor.

Method Summary

void	addVariable(java.lang.String name, java.lang.String value, java.lang.String description) Add a variable that might be modified by the user.
int	display() Displays the dialog on screen.
boolean	getAsBoolean(java.lang.String name) Return the value of the variable 'name' as boolean.
double	getAsDouble(java.lang.String name) Return the value of the variable 'name' as a Double.
int	getAsInt(java.lang.String name) Return the value of the variable 'name' as an Integer.
java.lang.String	getAsString(java.lang.String name) Return the value of the variable 'name' as a String.
int	getSelectedRow() Get the index of the currently selected row
void	setComment(java.lang.String comment) Add additional information about your script.
void	setDate(java.lang.String date) Add the date when the script was changed the last time.
void	setDependencies(java.lang.String dependencies) Does the script require some external resources or programs?
void	setOs(java.lang.String os) Does the script require a particular operating system?

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, toBack, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

EXECUTE_OPTION

public final int EXECUTE_OPTION

returned by display() if user selected 'execute'

See Also:

Constant Field Values

QUIT_OPTION

public final int QUIT_OPTION

returned by display() if user selected 'quit'

See Also:

Constant Field Values

Constructor Detail

ScriptDlg

public ScriptDlg(java.awt.Frame parent,
                 java.lang.String title,
                 java.lang.String author)

Constructor. Call the constructor to create a new dialog.

Parameters:

parent - The parent frame (within a script this is usually 'jpiv';

title - The name of your script.

author - Your name or e-mail address.

See Also:

CmdInterpreter

Method Detail

display

public int display()

Displays the dialog on screen. Call this method to display your dialog. This method will return when the user presses either 'quit' or 'execute'. One of the constants QUIT_OPTION or EXECUTE_OPTION is returned respectively.

Returns:

One of the integer constants QUIT_OPTION or EXECUTE_OPTION.

setDate

public void setDate(java.lang.String date)

Add the date when the script was changed the last time.

Parameters:

date - The date.

setOs

public void setOs(java.lang.String os)

Does the script require a particular operating system?

Parameters:

os - The operating system (e.g. "linux", "win32").

setDependencies

public void setDependencies(java.lang.String dependencies)

Does the script require some external resources or programs?

Parameters:

dependencies - The resource (e.g. matlab, PivWare).

setComment

public void setComment(java.lang.String comment)

Add additional information about your script.

Parameters:

comment - The comment.

addVariable

public void addVariable(java.lang.String name,
                        java.lang.String value,
                        java.lang.String description)

Add a variable that might be modified by the user.

Parameters:

name - The variable name. Use this name to refere to the variable.

value - A default value. This value might be changed by the user.

description - A description of the variable.

getAsString

public java.lang.String getAsString(java.lang.String name)

Return the value of the variable 'name' as a String.

Parameters:

name - The name of the variable (key).

Returns:

The value of the variable.

getAsBoolean

public boolean getAsBoolean(java.lang.String name)

Return the value of the variable 'name' as boolean. The string "true" is interpreted as boolean true (ignoring case), everything else is interpreted as boolean false.

Parameters:

name - A string "true" (returns true) or something else (returns false)

Returns:

True or false.

getAsInt

public int getAsInt(java.lang.String name)

Return the value of the variable 'name' as an Integer.

Parameters:

name - The name of the variable (key).

Returns:

The value of the variable.

getAsDouble

public double getAsDouble(java.lang.String name)

Return the value of the variable 'name' as a Double.

Parameters:

name - The name of the variable (key).

Returns:

The value of the variable.

getSelectedRow

public int getSelectedRow()

Get the index of the currently selected row

Returns:

The index of the selected row