java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - adams.gui.goe.GenericObjectEditor.GOEPanel

All Implemented Interfaces:

UserModeSupporter, ImageObserver, MenuContainer, Serializable, Accessible

Enclosing class:

GenericObjectEditor
```
public class GenericObjectEditor.GOEPanel
extends JPanel
implements UserModeSupporter
```
Handles the GUI side of editing values.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JPanel
  JPanel.AccessibleJPanel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields
Modifier and Type	Field	Description
`protected BaseButton`	`m_ButtonCancel`	cancel button.
`protected BaseButton`	`m_ButtonCopyPaste`	the button for copy/paste menu.
`protected BaseButton`	`m_ButtonLogClear`	the button for clearing the log message.
`protected BaseButton`	`m_ButtonLogCopy`	the button for copying the log message.
`protected BaseButton`	`m_ButtonOK`	ok button.
`protected BaseButton`	`m_ButtonOpen`	Open object from disk.
`protected BaseButton`	`m_ButtonRevert`	revert button.
`protected BaseButton`	`m_ButtonSave`	Save object to disk.
`protected BaseComboBox<String>`	`m_ComboBoxClassname`	The names of the proposed classes.
`protected ObjectFileChooser`	`m_FileChooser`	The filechooser for opening and saving object files.
`protected boolean`	`m_FirstUpdate`	whether its the first update.
`protected boolean`	`m_IgnoreChanges`	whether to ignore selection changes to the combobox.
`protected JLabel`	`m_LabelClassname`	The name of the current class.
`protected JPanel`	`m_PanelButtons`	the panel with the buttons.
`protected JPanel`	`m_PanelLeft`	the left panel.
`protected JPanel`	`m_PanelLog`	the panel for the log messages.
`protected JPanel`	`m_PanelLogAndButtons`	the panel for the log and buttons.
`protected JPanel`	`m_PanelRight`	the right panel.
`protected GenericObjectEditorClassTreePanel`	`m_PanelTree`	the class tree.
`protected PropertySheetPanel`	`m_PropertySheetChild`	The component that performs object customization.
`protected BaseSplitPane`	`m_SplitPane`	the split pane.
`protected BaseTextAreaWithButtons`	`m_TextLog`	the text area for the log message.
`protected JPanel`	`m_TopPanel`	the top panel with the classname and choose button.
`protected ClassTree`	`m_Tree`	the tree to use.
`protected boolean`	`m_UpdateSize`	whether to update the dialog size.

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 Description

GOEPanel()
Creates the GUI editor component.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addCancelListener(ActionListener a)`	This is used to hook an action listener to the cancel button.
`void`	`addOkListener(ActionListener a)`	This is used to hook an action listener to the ok button.
`void`	`clearLogMessage()`	Removes the message and hides the panel.
`protected void`	`close()`	Disposes the window the GOE belongs to, if possible.
`void`	`copyLogMessage()`	Copies the message to the clipboard.
`protected Object`	`copyObject(Object source)`	Makes a copy of an object using OptionUtils#shallowCopy(Object), CloneHandler#getClone() or serialization.
`boolean`	`getButtonsVisible()`	Returns whether the buttons are visible.
`boolean`	`getCanChangeClassInDialog()`	Returns whether the user can change the class in the dialog.
`protected ObjectFileChooser`	`getFileChooser()`	Creates the file chooser the user will use to save/load files with.
`String`	`getLogMessage()`	Returns the current log message.
`boolean`	`getUpdateSize()`	Returns whether to update the preferred size.
`UserMode`	`getUserMode()`	Returns the user mode.
`boolean`	`hasLogMessage()`	Returns whether a message is currently being displayed.
`boolean`	`isReadOnly()`	Returns whether the dialog is read-only or not.
`void`	`log(Level level, String msg)`	For logging messages.
`void`	`log(Level level, String msg, Throwable t)`	For logging messages.
`protected Object`	`openObject()`	Opens an object from a file selected by the user.
`void`	`removeCancelListener(ActionListener a)`	This is used to remove an action listener from the cancel button.
`void`	`removeOkListener(ActionListener a)`	This is used to remove an action listener from the ok button.
`protected void`	`saveObject(Object object)`	Saves an object to a file selected by the user.
`void`	`setButtonsVisible(boolean value)`	Sets whether to display the buttons.
`protected void`	`setCancelButton(boolean flag)`	Enables/disables the cancel button.
`void`	`setCanChangeClassInDialog(boolean value)`	Sets whether the user can change the class in the dialog.
`void`	`setOkButtonText(String newLabel)`	Allows customization of the action label on the dialog.
`void`	`setReadOnly(boolean value)`	Sets whether the dialog is read-only or not.
`void`	`setUpdateSize(boolean value)`	Sets whether to update the preferred size.
`void`	`setUserMode(UserMode value)`	Sets the user mode.
`void`	`updateChildPropertySheet()`	Updates the child property sheet, and creates if needed.

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - m_SplitPane
```
protected BaseSplitPane m_SplitPane
```
    the split pane.
  - m_PanelLeft
```
protected JPanel m_PanelLeft
```
    the left panel.
  - m_PanelRight
```
protected JPanel m_PanelRight
```
    the right panel.
  - m_Tree
```
protected ClassTree m_Tree
```
    the tree to use.
  - m_PanelTree
```
protected GenericObjectEditorClassTreePanel m_PanelTree
```
    the class tree.
  - m_PropertySheetChild
```
protected PropertySheetPanel m_PropertySheetChild
```
    The component that performs object customization.
  - m_ComboBoxClassname
```
protected BaseComboBox<String> m_ComboBoxClassname
```
    The names of the proposed classes.
  - m_LabelClassname
```
protected JLabel m_LabelClassname
```
    The name of the current class.
  - m_ButtonOpen
```
protected BaseButton m_ButtonOpen
```
    Open object from disk.
  - m_ButtonSave
```
protected BaseButton m_ButtonSave
```
    Save object to disk.
  - m_ButtonOK
```
protected BaseButton m_ButtonOK
```
    ok button.
  - m_ButtonCancel
```
protected BaseButton m_ButtonCancel
```
    cancel button.
  - m_ButtonRevert
```
protected BaseButton m_ButtonRevert
```
    revert button.
  - m_FileChooser
```
protected transient ObjectFileChooser m_FileChooser
```
    The filechooser for opening and saving object files.
  - m_ButtonCopyPaste
```
protected BaseButton m_ButtonCopyPaste
```
    the button for copy/paste menu.
  - m_TopPanel
```
protected JPanel m_TopPanel
```
    the top panel with the classname and choose button.
  - m_PanelLogAndButtons
```
protected JPanel m_PanelLogAndButtons
```
    the panel for the log and buttons.
  - m_PanelLog
```
protected JPanel m_PanelLog
```
    the panel for the log messages.
  - m_TextLog
```
protected BaseTextAreaWithButtons m_TextLog
```
    the text area for the log message.
  - m_ButtonLogClear
```
protected BaseButton m_ButtonLogClear
```
    the button for clearing the log message.
  - m_ButtonLogCopy
```
protected BaseButton m_ButtonLogCopy
```
    the button for copying the log message.
  - m_PanelButtons
```
protected JPanel m_PanelButtons
```
    the panel with the buttons.
  - m_IgnoreChanges
```
protected boolean m_IgnoreChanges
```
    whether to ignore selection changes to the combobox.
  - m_UpdateSize
```
protected boolean m_UpdateSize
```
    whether to update the dialog size.
  - m_FirstUpdate
```
protected boolean m_FirstUpdate
```
    whether its the first update.
- Constructor Detail
  - GOEPanel
```
public GOEPanel()
```
    Creates the GUI editor component.
- Method Detail
  - setUserMode
```
public void setUserMode(UserMode value)
```
    Sets the user mode.
    
    Specified by:
    
    setUserMode in interface UserModeSupporter
    
    Parameters:
    
    value - the mode
  - getUserMode
```
public UserMode getUserMode()
```
    Returns the user mode.
    
    Specified by:
    
    getUserMode in interface UserModeSupporter
    
    Returns:
    
    the mode
  - setUpdateSize
```
public void setUpdateSize(boolean value)
```
    Sets whether to update the preferred size.
    
    Parameters:
    
    value - true if to update
  - getUpdateSize
```
public boolean getUpdateSize()
```
    Returns whether to update the preferred size.
    
    Returns:
    
    true if to update
  - setButtonsVisible
```
public void setButtonsVisible(boolean value)
```
    Sets whether to display the buttons.
    
    Parameters:
    
    value - true if to display
  - getButtonsVisible
```
public boolean getButtonsVisible()
```
    Returns whether the buttons are visible.
    
    Returns:
    
    true if displayed
  - close
```
protected void close()
```
    Disposes the window the GOE belongs to, if possible.
  - setCancelButton
```
protected void setCancelButton(boolean flag)
```
    Enables/disables the cancel button.
    
    Parameters:
    
    flag - true to enable cancel button, false to disable it
  - openObject
```
protected Object openObject()
```
    Opens an object from a file selected by the user.
    
    Returns:
    
    the loaded object, or null if the operation was cancelled or failed to load object or incompatible type
  - saveObject
```
protected void saveObject(Object object)
```
    Saves an object to a file selected by the user.
    
    Parameters:
    
    object - the object to save
  - getFileChooser
```
protected ObjectFileChooser getFileChooser()
```
    Creates the file chooser the user will use to save/load files with.
  - copyObject
```
protected Object copyObject(Object source)
```
    Makes a copy of an object using OptionUtils#shallowCopy(Object), CloneHandler#getClone() or serialization.
    
    Parameters:
    
    source - the object to copy
    
    Returns:
    
    a copy of the source object
  - setOkButtonText
```
public void setOkButtonText(String newLabel)
```
    Allows customization of the action label on the dialog.
    
    Parameters:
    
    newLabel - the new string for the ok button
  - addOkListener
```
public void addOkListener(ActionListener a)
```
    This is used to hook an action listener to the ok button.
    
    Parameters:
    
    a - The action listener.
  - addCancelListener
```
public void addCancelListener(ActionListener a)
```
    This is used to hook an action listener to the cancel button.
    
    Parameters:
    
    a - The action listener.
  - removeOkListener
```
public void removeOkListener(ActionListener a)
```
    This is used to remove an action listener from the ok button.
    
    Parameters:
    
    a - The action listener
  - removeCancelListener
```
public void removeCancelListener(ActionListener a)
```
    This is used to remove an action listener from the cancel button.
    
    Parameters:
    
    a - The action listener
  - updateChildPropertySheet
```
public void updateChildPropertySheet()
```
    Updates the child property sheet, and creates if needed.
  - setCanChangeClassInDialog
```
public void setCanChangeClassInDialog(boolean value)
```
    Sets whether the user can change the class in the dialog.
    
    Parameters:
    
    value - if true then the user can change the class
  - getCanChangeClassInDialog
```
public boolean getCanChangeClassInDialog()
```
    Returns whether the user can change the class in the dialog.
    
    Returns:
    
    true if the user can change the class
  - setReadOnly
```
public void setReadOnly(boolean value)
```
    Sets whether the dialog is read-only or not.
    
    Parameters:
    
    value - if true then the dialog is read-only
  - isReadOnly
```
public boolean isReadOnly()
```
    Returns whether the dialog is read-only or not.
    
    Returns:
    
    true if the dialog is read-only
  - log
```
public void log(Level level,
                String msg)
```
    For logging messages.
    
    Parameters:
    
    level - the logging level
    
    msg - the message
  - log
```
public void log(Level level,
                String msg,
                Throwable t)
```
    For logging messages.
    
    Parameters:
    
    level - the logging level
    
    msg - the message
    
    t - the optional exception (if one occurred), can be null
  - clearLogMessage
```
public void clearLogMessage()
```
    Removes the message and hides the panel.
  - copyLogMessage
```
public void copyLogMessage()
```
    Copies the message to the clipboard.
  - hasLogMessage
```
public boolean hasLogMessage()
```
    Returns whether a message is currently being displayed.
    
    Returns:
    
    true if message displayed
  - getLogMessage
```
public String getLogMessage()
```
    Returns the current log message.
    
    Returns:
    
    the log message, null if none displayed

Class GenericObjectEditor.GOEPanel

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

m_SplitPane

m_PanelLeft

m_PanelRight

m_Tree

m_PanelTree

m_PropertySheetChild

m_ComboBoxClassname

m_LabelClassname

m_ButtonOpen

m_ButtonSave

m_ButtonOK

m_ButtonCancel

m_ButtonRevert

m_FileChooser

m_ButtonCopyPaste

m_TopPanel

m_PanelLogAndButtons

m_PanelLog

m_TextLog

m_ButtonLogClear

m_ButtonLogCopy

m_PanelButtons

m_IgnoreChanges

m_UpdateSize

m_FirstUpdate

Constructor Detail

GOEPanel

Method Detail

setUserMode

getUserMode

setUpdateSize

getUpdateSize

setButtonsVisible

getButtonsVisible

close

setCancelButton

openObject

saveObject

getFileChooser

copyObject

setOkButtonText

addOkListener

addCancelListener

removeOkListener

removeCancelListener

updateChildPropertySheet

setCanChangeClassInDialog

getCanChangeClassInDialog

setReadOnly

isReadOnly

log

log

clearLogMessage

copyLogMessage

hasLogMessage

getLogMessage