Package gov.nih.mipav.view
Class JPanelEdit
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- gov.nih.mipav.view.JPanelEdit
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
- Direct Known Subclasses:
JPanelEditAxisOrientation
,JPanelEditBoolean
,JPanelEditChar
,JPanelEditDate
,JPanelEditDefault
,JPanelEditImageOrientation
,JPanelEditModality
,JPanelEditOrientation
,JPanelEditRace
,JPanelEditSetOrParam
,JPanelEditSex
,JPanelEditTime
,JPanelEditValueType
,JPanelFileSelection
public abstract class JPanelEdit extends javax.swing.JPanel
An abstract class for editing a single, specfic value. If the panel contains information which must be verified before assembling as a panel value, then the owner must checkFields() before requesting the panel's value.- Version:
- 1.0
- Author:
- David Parsons
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
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 protected java.awt.Component
errorComponent
when necessary To CheckFields, and there is a problem with the panel such that a valid panel value cannot be made, the particular component which has a bad value will be pointed to here.protected java.lang.String
errorString
when necessary To CheckFields, and there is a problem with the panel such that a valid panel value cannot be made, the problem will be reported in this String.protected java.lang.String
propertyName
A changable property name for firingPropertyChangeEvent
s.private static long
serialVersionUID
Use serialVersionUID for interoperability.-
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 JPanelEdit()
Builds a standard JPanel.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
checkFields()
Abstract method notifying the owner if the incorporated fields need to be re-entered.abstract java.lang.Object
getCodedValue()
abstract method returning the panel's value.java.awt.Component
getErrorComponent()
method returns the Component (visual GUI interface) that has an error making the panel value in an attempt to allow the user the chance to correct the problem.java.lang.String
getErrorString()
method returns the String describing an error making the panel value.abstract java.lang.String
getPanelValue()
abstract method returning the panel's value.java.lang.String
getPropertyName()
Returns the current name used to identifyPropertyChangeEvent
s.void
setPropertyName(java.lang.String newPropertyName)
Sets the propertyName to allow thePropertyChangeEvent
to send out a unique name whenPropertyChangeEvent
s are fired.-
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
Use serialVersionUID for interoperability.- See Also:
- Constant Field Values
-
errorComponent
protected java.awt.Component errorComponent
when necessary To CheckFields, and there is a problem with the panel such that a valid panel value cannot be made, the particular component which has a bad value will be pointed to here.
-
errorString
protected java.lang.String errorString
when necessary To CheckFields, and there is a problem with the panel such that a valid panel value cannot be made, the problem will be reported in this String.
-
propertyName
protected java.lang.String propertyName
A changable property name for firingPropertyChangeEvent
s. A panel has but one unique property associated with it, that is the file it references, but in a situation where more than one such panel may be listened to by aPropertyChangeListener
, each of these panels may be given a unique name to help the Listener. Be careful when using this feature, however, because if there is more than one listener which is interested in changes in thePropertyChangeEvent
, changing the property name will cause conflicts (and likely ignored events).
-
-
Method Detail
-
checkFields
public abstract boolean checkFields()
Abstract method notifying the owner if the incorporated fields need to be re-entered. Fields need to be re-entered when the panel cannot make a panelValue. see errorString see errorComponent see getPanelValue- Returns:
- DOCUMENT ME!
-
getCodedValue
public abstract java.lang.Object getCodedValue()
abstract method returning the panel's value.If the information held by the panel is stored as a code (as in 'M' for "male" or 'F' for "female"), then this code will be returned by this method. If there is no code for this value, this method will return a the same value as getPanelValue()
- Returns:
- the coded value. If the panel has no coded value, then the return value will be the String returned by getPanelValue().
-
getPanelValue
public abstract java.lang.String getPanelValue()
abstract method returning the panel's value.- Returns:
- The value of the Panel in some understandable String format
-
getErrorComponent
public java.awt.Component getErrorComponent()
method returns the Component (visual GUI interface) that has an error making the panel value in an attempt to allow the user the chance to correct the problem. If there is no error, this method returns null- Returns:
- DOCUMENT ME!
-
getErrorString
public java.lang.String getErrorString()
method returns the String describing an error making the panel value. If there is no error, this method returns null.- Returns:
- DOCUMENT ME!
-
getPropertyName
public java.lang.String getPropertyName()
Returns the current name used to identifyPropertyChangeEvent
s.- Returns:
- DOCUMENT ME!
-
setPropertyName
public void setPropertyName(java.lang.String newPropertyName) throws java.lang.IllegalArgumentException
Sets the propertyName to allow thePropertyChangeEvent
to send out a unique name whenPropertyChangeEvent
s are fired. This panel has but one unique property associated with it, that is the file it references, but in a situation where more than one such panel may be listened to by aPropertyChangeListener
, each of these panels may be given a unique name to help the Listener. Be careful when using this feature, however, because if there is more than one listener which is interested in changes in thePropertyChangeEvent
, changing the property name will cause conflicts (and likely ignored events).- Parameters:
newPropertyName
- DOCUMENT ME!- Throws:
java.lang.IllegalArgumentException
- if thenewPropertyName
is null or is empty.
-
-