edu.iu.iv.common.util.algorithmview
Class AlgorithmView

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JInternalFrame
                          |
                          +--edu.iu.iv.common.util.algorithmview.AlgorithmView

All Implemented Interfaces:

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

public class AlgorithmView

extends javax.swing.JInternalFrame

A dynamically generated view of an Algorithm. This class takes in a proper Algorithm, a Validator, a Labeller, and a Descriptor. In order for this class to work properly these classes must be structured strictly by the following rules:

• Algorithms, must implement the Algorithm interface. It is vitally important that there are getters and setters for all the data that you need inputted from the user. The setters should be in the following form: public void setOptionName(DataType value);
• Validators are used for specific validating of potential data for the setters in the Algorithm class. Validators do not have a specific interface, but the methods must conform to the following form: public boolean isOptionNameValid(DataType value);
• Descriptors provide tooltips for the data to be inputted so the user can know what the options are and what values are acceptable. Descriptors do not have a specific Interface, but the mothods must conform to the following form: public String getOptionNameDescription();
• Labellers provide labels for each OptionName to be shown beside the data entry component. Descriptors do not have to have a specific interface, but the methods must conform to the following form: public String getOptionNameLabel();

If the Algorithm, Validator, Labeller, or Descriptors are not properly formatted and given to the AlgorithmView, then it will ignore the illegally formatted methods and do its best at constructing the interface with what LEGAL methods are given.

Note also, that you do not have to provide a Validator, Labeller or Descriptor. If they are not provided then standard validation (eg. Making sure an int is an integer in the text field) will be used and no tooltip will be given for a description of the OptionName given in the AlgorithmView. If no descriptor, then it will use the OptionName of the

Author:

Team IVC

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.JInternalFrame

CONTENT_PANE_PROPERTY, FRAME_ICON_PROPERTY, GLASS_PANE_PROPERTY, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, LAYERED_PANE_PROPERTY, MENU_BAR_PROPERTY, ROOT_PANE_PROPERTY, TITLE_PROPERTY

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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

AlgorithmView(java.lang.String title, Algorithm algorithm)
given a properly created algorithm and its title, creates a view to be shown in the user interface of the algorithm.

AlgorithmView(java.lang.String title, Algorithm algorithm, java.lang.Object validator, java.lang.Object descriptor)
given a properly created algorithm, its title, and optional validator and descriptor objects, creates a view to be shown in the user interface of the algorithm.

AlgorithmView(java.lang.String title, Algorithm algorithm, java.lang.Object validator, java.lang.Object descriptor, java.lang.Object labeller)
given a properly created algorithm, its title, and optional validator and descriptor objects, creates a view to be shown in the user interface of the algorithm.

Methods inherited from class javax.swing.JInternalFrame

addInternalFrameListener, dispose, doDefaultCloseAction, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getJMenuBar, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isSelected, moveToBack, moveToFront, pack, remove, removeInternalFrameListener, reshape, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIcon, setIconifiable, setJMenuBar, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setSelected, setTitle, setUI, show, toBack, toFront, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmView

public AlgorithmView(java.lang.String title,
                     Algorithm algorithm)

given a properly created algorithm and its title, creates a view to be shown in the user interface of the algorithm.

Parameters:

title - the title for the algorithm

algorithm - the algorithm to be analyzed.

AlgorithmView

public AlgorithmView(java.lang.String title,
                     Algorithm algorithm,
                     java.lang.Object validator,
                     java.lang.Object descriptor)

given a properly created algorithm, its title, and optional validator and descriptor objects, creates a view to be shown in the user interface of the algorithm.

Parameters:

title - the title for the algorithm

algorithm - the algorithm to be analyzed.

validator - the validator that validates the data.

descriptor - the descriptor that provides tooltip hints for entering data.

AlgorithmView

public AlgorithmView(java.lang.String title,
                     Algorithm algorithm,
                     java.lang.Object validator,
                     java.lang.Object descriptor,
                     java.lang.Object labeller)

given a properly created algorithm, its title, and optional validator and descriptor objects, creates a view to be shown in the user interface of the algorithm.

Parameters:

title - the title for the algorithm

algorithm - the algorithm to be analyzed.

validator - the validator that validates the data.

descriptor - the descriptor that provides tooltip hints for entering data.

labeller - the labeller that provides labels for the gui