com.cellmatrix.chemcomp.API.v1

Class ControlPanel

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

com.cellmatrix.chemcomp.API.v1.ControlPanel

All Implemented Interfaces:

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

public class ControlPanel
extends javax.swing.JFrame

Version:

1.0 ControlPanel - a customizable widget interface for use manipulation of the run-time environment.

Constructing a ControlPanel causes the appearance of an empty panel with a given title. User code can create buttons, checkboxes, sliders, and input- and output- text areas, and link them to user code of their choice with a simple connect() method.

Author:

Nicholas J. Macias, Cell Matrix Corporation

See Also:

Serialized Form

Nested Class Summary

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

java.awt.Window.Type

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static int	Button connect() argument for a button
static int	CheckBox connect() argument for a check box
static int	Slider connect() argument for a slider
static int	TextIn connect() argument for text input area

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

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, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ControlPanel(java.lang.String title) Creates an empty control panel, on which the user can place buttons, check boxes and sliders.

Method Summary

Modifier and Type	Method and Description
void	addText(java.lang.String text) append text to the text output window
void	connect(java.lang.Object userObject, int type, int number, int start, int low, int high, int id, java.lang.String label, java.lang.String method) display and connect a panel's control to a user-specified method
void	connect(java.lang.Object userObject, int type, int number, int id, java.lang.String label, java.lang.String method) display and connect a panel's control to a user-specified method
void	setText(boolean visible) Set the visibility of the text output area
void	setText(java.lang.String text) set text in the text output area
void	textInInstant(boolean textInInstant) Controls when the text handler is called.

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

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, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, 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, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, 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, 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, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

Button

public static final int Button

connect() argument for a button

See Also:

Constant Field Values

CheckBox

public static final int CheckBox

connect() argument for a check box

See Also:

Constant Field Values

Slider

public static final int Slider

connect() argument for a slider

See Also:

Constant Field Values

TextIn

public static final int TextIn

connect() argument for text input area

See Also:

Constant Field Values

Constructor Detail

ControlPanel

public ControlPanel(java.lang.String title)

Creates an empty control panel, on which the user can place buttons, check boxes and sliders. The panel can also contain text input and output areas.

Parameters:

title - the title to display on the top of the panel

Method Detail

textInInstant

public void textInInstant(boolean textInInstant)

Controls when the text handler is called.

Parameters:

textInInstant - true means call the handler after any key stroke; false means call only after ENTER

setText

public void setText(boolean visible)

Set the visibility of the text output area

Parameters:

visible - make text output area visible (true) or invisible (false)

setText

public void setText(java.lang.String text)

set text in the text output area

Parameters:

text - string to display

addText

public void addText(java.lang.String text)

append text to the text output window

Parameters:

text - string to append to text output window

connect

public void connect(java.lang.Object userObject,
                    int type,
                    int number,
                    int id,
                    java.lang.String label,
                    java.lang.String method)

display and connect a panel's control to a user-specified method

Parameters:

userObject - usually "this": the object whose method should be called

type - one of ControlPanel.Button, CheckBox, Slider or TextIn

number - index (0-n) of the control

id - user-specified integer to identify this control. Will be passed as the first argument to the method

label - string to display on the button

method - string containing the name of the method to call when the control changes. method is called with a ControlArgs object as its single argument

connect

public void connect(java.lang.Object userObject,
                    int type,
                    int number,
                    int start,
                    int low,
                    int high,
                    int id,
                    java.lang.String label,
                    java.lang.String method)

display and connect a panel's control to a user-specified method

Parameters:

userObject - usually "this": the object whose method should be called

type - one of ControlPanel.Button, CheckBox, Slider or TextIn

number - index (0-n) of the control

low - lower limit of slider

high - upper limit of slider

start - initial starting value

id - user-specified integer to identify this control. Will be passed as the first argument to the method

label - string to display on the button

method - string containing the name of the method to call when the control changes. method is called with a ControlArgs object as its single argument