dsto.dfc.swing.forms
Class AbstractFormEditorComponent

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              dsto.dfc.swing.forms.AbstractFormEditorComponent

All Implemented Interfaces:

FormEditor, ImageObserver, MenuContainer, Customizer, Serializable

Direct Known Subclasses:

ColorChooserCombo, ColorChooserPanel, EnumFormEditor, FontLabelEditor, FontSelectorEditor, JFileChooserFormEditor, PopupFormEditor, RadioBox, TermCustomizer

public abstract class AbstractFormEditorComponent
extends JComponent
implements FormEditor, Customizer

Abstract base class for JComponent-based FormEditor's.

Version:

$Revision$

See Also:

Serialized Form

Nested Class Summary

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

protected String

description

Fields inherited from class javax.swing.JComponent

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

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

AbstractFormEditorComponent()

Method Summary

void	addFormEditorListener(FormEditorListener l)
void	commitEdits() Default implementation does nothing.
void	fireEditComitted() Deprecated. Supports old typo, ise fireEditCommitted instead.
void	fireEditCommitRequested()
void	fireEditCommitted()
Component	getEditorComponent() Get the component, if any, that acts as a UI for this editor.
String	getEditorDescription() Get a short description of the value being edited for this editor (eg 'host name').
abstract Object	getEditorValue() Get the current value from the form editor.
Class	getPreferredValueType() Default implementation: returns java.lang.Object to indicate no preferred type.
abstract boolean	isDirectEdit() True if the editor directly edits the value passed in with setValue ().
void	removeFormEditorListener(FormEditorListener l)
void	setEditorDescription(String newValue)
abstract void	setEditorValue(Object value) Sets the value to be displayed/edited by the form editor.
void	setObject(Object bean)

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI

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, 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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.beans.Customizer

addPropertyChangeListener, removePropertyChangeListener

Field Detail

description

protected String description

Constructor Detail

AbstractFormEditorComponent

public AbstractFormEditorComponent()

Method Detail

getEditorDescription

public String getEditorDescription()

Description copied from interface: FormEditor

Get a short description of the value being edited for this editor (eg 'host name'). May be null.

Specified by:

getEditorDescription in interface FormEditor

setEditorDescription

public void setEditorDescription(String newValue)

getPreferredValueType

public Class getPreferredValueType()

Default implementation: returns java.lang.Object to indicate no preferred type.

Specified by:

getPreferredValueType in interface FormEditor

isDirectEdit

public abstract boolean isDirectEdit()

Description copied from interface: FormEditor

True if the editor directly edits the value passed in with setValue (). If false, the parent editor will be reponsible for retrieving the value from the editor and storing it.

Specified by:

isDirectEdit in interface FormEditor

setEditorValue

public abstract void setEditorValue(Object value)
                             throws IllegalFormatException

Description copied from interface: FormEditor

Sets the value to be displayed/edited by the form editor.

Specified by:

setEditorValue in interface FormEditor

Parameters:

value - The value to display.

Throws:

IllegalFormatException - if the value was not in the correct format for display by this editor. The source specified by the exception should be this FormEditor instance or a child.

getEditorValue

public abstract Object getEditorValue()

Description copied from interface: FormEditor

Get the current value from the form editor. At least one call to setValue () must be made beforehand.

Specified by:

getEditorValue in interface FormEditor

commitEdits

public void commitEdits()
                 throws IllegalFormatException

Default implementation does nothing.

Specified by:

commitEdits in interface FormEditor

Throws:

IllegalFormatException - if the commit failed because of an illegal input or other error. The source specified by the exception should be the FormEditor instance that caused the error (ie either this editor or a child).

getEditorComponent

public Component getEditorComponent()

Description copied from interface: FormEditor

Get the component, if any, that acts as a UI for this editor. May return null if not associated with a component.

Specified by:

getEditorComponent in interface FormEditor

addFormEditorListener

public void addFormEditorListener(FormEditorListener l)

Specified by:

addFormEditorListener in interface FormEditor

removeFormEditorListener

public void removeFormEditorListener(FormEditorListener l)

Specified by:

removeFormEditorListener in interface FormEditor

fireEditComitted

public void fireEditComitted()

Deprecated. Supports old typo, ise fireEditCommitted instead.

fireEditCommitted

public void fireEditCommitted()

fireEditCommitRequested

public void fireEditCommitRequested()

setObject

public void setObject(Object bean)

Specified by:

setObject in interface Customizer