org.youscope.addon.component.generic

Class PropertyEditorAdapter

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.youscope.uielements.DynamicPanel

org.youscope.addon.component.generic.PropertyEditorAdapter

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, PropertyEditor

Direct Known Subclasses:

PropertyBooleanEditor, PropertyCameraEditor, PropertyChannelEditor, PropertyDoubleEditor, PropertyEnumEditor, PropertyFocusEditor, PropertyIntegerEditor, PropertyStringEditor

public abstract class PropertyEditorAdapter
extends DynamicPanel
implements PropertyEditor

Adapter class to simplify property editor construction.

Author:

Moritz Lang

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

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class org.youscope.uielements.DynamicPanel

CONSTRAINT_CENTER, CONSTRAINT_NEW_LINE

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 and Description
PropertyEditorAdapter(Property property, Configuration configuration, YouScopeClient client, YouScopeServer server, java.lang.Class<?>... supportedType) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(java.awt.event.ActionListener listener) Adds a listener to be notified when the value of the property edited changed.
protected void	addLabel()
void	addMessageListener(MessageListener listener) Adds a listener to get notified about errors and similar.
protected YouScopeClient	getClient()
protected Configuration	getConfiguration()
java.awt.Component	getEditor() Returns the UI element of the editor.
protected Property	getProperty()
protected YouScopeServer	getServer()
java.lang.Class<?>[]	getSupportedTypes() Get the property types supported by this editor.
protected java.lang.Object	getValue()
protected <T> T	getValue(java.lang.Class<T> valueType)
boolean	isFillSpace() Returns true if this editor can fill up extra space.
protected void	notifyPropertyValueChanged() Call this function to notify all action listeners that the property's value has changed.
void	removeActionListener(java.awt.event.ActionListener listener) Removes a previously added listener.
void	removeMessageListener(MessageListener listener) Removes a previously added listener
protected void	sendErrorMessage(java.lang.String message, java.lang.Throwable error) Sends an error message to all message listener.
protected void	sendMessage(java.lang.String message) Sends a message to all message listeners.
protected void	setValue(java.lang.Object value)

Methods inherited from class org.youscope.uielements.DynamicPanel

add, add, add, add, addCenter, addCenter, addFill, addFill, addFillEmpty

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, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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

Methods inherited from interface org.youscope.addon.component.generic.PropertyEditor

commitEdits

Constructor Detail

PropertyEditorAdapter

public PropertyEditorAdapter(Property property,
                             Configuration configuration,
                             YouScopeClient client,
                             YouScopeServer server,
                             java.lang.Class<?>... supportedType)

Constructor.

Parameters:

property - The property which gets edited by this editor.

configuration - The configuration where the respective property changes.

client - Interface to the client.

server - Interface to the server.

supportedType - property types supported by this editor.

Method Detail

addLabel

protected void addLabel()

getProperty

protected Property getProperty()

getSupportedTypes

public java.lang.Class<?>[] getSupportedTypes()

Description copied from interface: PropertyEditor

Get the property types supported by this editor.

Specified by:

getSupportedTypes in interface PropertyEditor

Returns:

Supported property types.

getValue

protected <T> T getValue(java.lang.Class<T> valueType)
                  throws GenericException

Throws:

GenericException

getValue

protected java.lang.Object getValue()
                             throws GenericException

Throws:

GenericException

setValue

protected void setValue(java.lang.Object value)
                 throws GenericException

Throws:

GenericException

getConfiguration

protected Configuration getConfiguration()

getClient

protected YouScopeClient getClient()

getServer

protected YouScopeServer getServer()

getEditor

public java.awt.Component getEditor()

Description copied from interface: PropertyEditor

Returns the UI element of the editor.

Specified by:

getEditor in interface PropertyEditor

Returns:

UI element of the editor.

addMessageListener

public void addMessageListener(MessageListener listener)

Description copied from interface: PropertyEditor

Adds a listener to get notified about errors and similar.

Specified by:

addMessageListener in interface PropertyEditor

Parameters:

listener - message listener to add.

removeMessageListener

public void removeMessageListener(MessageListener listener)

Description copied from interface: PropertyEditor

Removes a previously added listener

Specified by:

removeMessageListener in interface PropertyEditor

Parameters:

listener - message listener to remove.

addActionListener

public void addActionListener(java.awt.event.ActionListener listener)

Description copied from interface: PropertyEditor

Adds a listener to be notified when the value of the property edited changed.

Specified by:

addActionListener in interface PropertyEditor

Parameters:

listener - action listener.

removeActionListener

public void removeActionListener(java.awt.event.ActionListener listener)

Description copied from interface: PropertyEditor

Removes a previously added listener.

Specified by:

removeActionListener in interface PropertyEditor

Parameters:

listener - listener to remove.

isFillSpace

public boolean isFillSpace()

Description copied from interface: PropertyEditor

Returns true if this editor can fill up extra space. Return false, if this would lead to an ugly UI.

Specified by:

isFillSpace in interface PropertyEditor

Returns:

TRUE if editor can fill up extra space.

notifyPropertyValueChanged

protected void notifyPropertyValueChanged()

Call this function to notify all action listeners that the property's value has changed. Note: update the properties value in the configuration first.

sendMessage

protected void sendMessage(java.lang.String message)

Sends a message to all message listeners.

Parameters:

message - The message to send.

sendErrorMessage

protected void sendErrorMessage(java.lang.String message,
                                java.lang.Throwable error)

Sends an error message to all message listener. Should only be called when the error is produced autonomously, i.e. not as a direct response to a function call. If a function is called and an error occurs in the function call, an error should be thrown instead of an error message be send. A typical example when an error message would be send is when a thread is started as a response to a function call, and an error occurs in the thread while the original function call already succeeded. Another example are errors occurring as response to the user interacting with UI components.

Parameters:

message - The message to send.

error - The error which occurred.