DESY ACOP Beans Home

com.cosylab.gui.displayers
Class AbstractDisplayerPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.cosylab.gui.displayers.AbstractDisplayerPanel

All Implemented Interfaces:

PopupManageable, CommonDisplayer, ConvertibleDisplayer, DataConsumer, DataStateProvider, Displayer, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

CharacteristicsMapPanel, IconDisplayer

public abstract class AbstractDisplayerPanel
extends javax.swing.JPanel
implements Displayer, PopupManageable, ConvertibleDisplayer

AbstractDisplayerPanel is a displayer that provides common feature of a Displayer interface.

Version:

$id$

Author:

Jernej Kamenik

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 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 com.cosylab.gui.displayers.ConvertibleDisplayer

CONVERTER_PROPERTY

Fields inherited from interface com.cosylab.gui.displayers.Displayer

C_EDITABLE, DATA_SOURCE

Fields inherited from interface com.cosylab.gui.displayers.CommonDisplayer

C_BIT_DESCRIPTIONS, C_BIT_MASK, C_COLOR, C_CONDITION_WHEN_CLEARED, C_CONDITION_WHEN_SET, C_DESCRIPTION, C_DISPLAY_NAME, C_FORMAT, C_GRAPH_MAX, C_GRAPH_MIN, C_MAXIMUM, C_MIN_STEP, C_MINIMUM, C_POSITION, C_PROPERTY_TYPE, C_SEQUENCE_LENGTH, C_UNITS

Fields inherited from interface com.cosylab.gui.displayers.DataStateProvider

DATA_STATE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

AbstractDisplayerPanel()
Constructor for AbstractDisplayerPanel.

Method Summary

void	cleanup() Performs general cleanup of displayer resources.
void	destroy()
Converter	getConverter() Returns the converter.
AbstractCustomizerPanel	getCustomizer() Generates the customizer for the displayer.
DataSource	getDataSource() Returns data source.
DataState	getDataState() Returns data quality state.
DataConsumer	getDefaultDataConsumer() Returns the implementation of default consumer type supported by this data consumer.
PopupManager	getPopupManager() Returns popup manager for adding popup actions.
java.lang.String[]	getSupportedCharacteristics() Resturns array with names of supported characteristics.
java.lang.String	getTitle() Returns title of this component.
protected ResizableTextLabel	getTitleLabel()
int	getTitleMaximumFontSize() Returns the maximum title font size.
int	getTitleMinimumFontSize() Returns the minimum title font size.
boolean	isPopupEnabled() Return true if the popup menu is enabled or false otherwise.
boolean	isSuspended() Returns true if GUI updates are suspended.
boolean	isTitleVisible() Returns visibility of title.
void	resume() Resumes updates of GUI component.
void	setBackground(java.awt.Color bg)
void	setConverter(Converter converter) Sets new converter.
void	setDataSource(DataSource dataSource) Sets data source and registeres this displayer as data consumer.
void	setForeground(java.awt.Color fg)
void	setPopupEnabled(boolean enabled) Enables or disables the popup menu.
void	setTitle(java.lang.String value) Sets the title of component.
void	setTitleMaximumFontSize(int max) Sets the maximum title font size.
void	setTitleMinimumFontSize(int min) Sets the minimum title font size.
void	setTitleVisible(boolean value) Sets visibility of title label.
void	suspend() Suspends all updates of displayer.
void	updateDataState(DataState state) Push data state (quality) update change for dynamic value.

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, 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, 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 com.cosylab.gui.displayers.Displayer

isEditable

Methods inherited from interface com.cosylab.gui.displayers.DataConsumer

getDataConsumer, getName, getSupportedConsumerTypes, setCharacteristics

Methods inherited from interface com.cosylab.gui.displayers.DataStateProvider

addPropertyChangeListener, addPropertyChangeListener, removePropertyChangeListener, removePropertyChangeListener

Constructor Detail

AbstractDisplayerPanel

public AbstractDisplayerPanel()

Constructor for AbstractDisplayerPanel.

Method Detail

getCustomizer

public AbstractCustomizerPanel getCustomizer()

Generates the customizer for the displayer.

Returns:

getTitleLabel

protected ResizableTextLabel getTitleLabel()

getDefaultDataConsumer

public DataConsumer getDefaultDataConsumer()

Description copied from interface: DataConsumer

Returns the implementation of default consumer type supported by this data consumer.

Specified by:

getDefaultDataConsumer in interface DataConsumer

Returns:

the implementation of default consumer type supported by this data consumer

getSupportedCharacteristics

public java.lang.String[] getSupportedCharacteristics()

Description copied from interface: DataConsumer

Resturns array with names of supported characteristics. Data source can use this method to optimize setting characteristics to this data consumer. If arrray of length 0 is return, then consumer does not need or support any characteristic. If null is returned, than consumer expect all existing characteristics from data source.

Specified by:

getSupportedCharacteristics in interface DataConsumer

Returns:

array with names of supported characteristics

updateDataState

public void updateDataState(DataState state)

Description copied from interface: DataConsumer

Push data state (quality) update change for dynamic value. Usually called by data source.

Specified by:

updateDataState in interface DataConsumer

Parameters:

state - new data state(quality) descriptor

cleanup

public void cleanup()

Description copied from interface: CommonDisplayer

Performs general cleanup of displayer resources. All by displayer issued object are not valid any more after cleanup. Displayer positions itself in initial state and DataState is changed to NOT_INITIALIZED state.

Specified by:

cleanup in interface CommonDisplayer

getDataState

public DataState getDataState()

Description copied from interface: DataStateProvider

Returns data quality state. This property is changed by data consumer interface. In case of multiple displayer, this state indicates integral state for all contained data consumers.

Specified by:

getDataState in interface DataStateProvider

Returns:

dynamic data quality state

isSuspended

public boolean isSuspended()

Description copied from interface: CommonDisplayer

Returns true if GUI updates are suspended.

Specified by:

isSuspended in interface CommonDisplayer

Returns:

true if GUI updates are suspended

resume

public void resume()

Description copied from interface: CommonDisplayer

Resumes updates of GUI component.

Specified by:

resume in interface CommonDisplayer

See Also:

CommonDisplayer.suspend()

suspend

public void suspend()

Description copied from interface: CommonDisplayer

Suspends all updates of displayer. Displayer might receive data change updates, but does not call redraw on GUI components, which is time and CPU consuming.

Specified by:

suspend in interface CommonDisplayer

getPopupManager

public PopupManager getPopupManager()

Returns popup manager for adding popup actions.

Specified by:

getPopupManager in interface PopupManageable

Returns:

returns popup manager, which manages popup menu

See Also:

PopupManageable.getPopupManager()

isPopupEnabled

public boolean isPopupEnabled()

Return true if the popup menu is enabled or false otherwise.

Returns:

true if popup is enabled

setPopupEnabled

public void setPopupEnabled(boolean enabled)

Enables or disables the popup menu.

Parameters:

enabled - true if enable or false if disableds

destroy

public void destroy()

getDataSource

public DataSource getDataSource()

Description copied from interface: Displayer

Returns data source. This is convenience method for integration with VCE development tools. If null returned does not mean that this displayer is not connected to data source, it only means that setDataSource() method was not used.

Specified by:

getDataSource in interface Displayer

Returns:

the data source for this displayer, if set by setter

setDataSource

public void setDataSource(DataSource dataSource)
                   throws java.beans.PropertyVetoException

Description copied from interface: Displayer

Sets data source and registeres this displayer as data consumer. This is convenience method for integration with VCE development tools, you can connect displayers directly to data sources without using this method.

Specified by:

setDataSource in interface Displayer

Parameters:

dataSource - new data source of this displayer

Throws:

java.beans.PropertyVetoException - DOCUMENT ME!

getConverter

public Converter getConverter()

Returns the converter.

Specified by:

getConverter in interface ConvertibleDisplayer

Returns:

Returns the converter.

setConverter

public void setConverter(Converter converter)
                  throws java.beans.PropertyVetoException

Sets new converter.

Specified by:

setConverter in interface ConvertibleDisplayer

Parameters:

converter - new converter

Throws:

java.beans.PropertyVetoException - if set fails

getTitleMaximumFontSize

public int getTitleMaximumFontSize()

Returns the maximum title font size.

Returns:

font size in pixels

getTitleMinimumFontSize

public int getTitleMinimumFontSize()

Returns the minimum title font size.

Returns:

font size in pixels

setTitleMaximumFontSize

public void setTitleMaximumFontSize(int max)

Sets the maximum title font size.

Parameters:

max - new font size in pixels

setTitleMinimumFontSize

public void setTitleMinimumFontSize(int min)

Sets the minimum title font size.

Parameters:

min - new font size in pixels

setTitleVisible

public void setTitleVisible(boolean value)

Sets visibility of title label.

Parameters:

value - True if title should be visible.

isTitleVisible

public boolean isTitleVisible()

Returns visibility of title.

Returns:

True if title is visible.

getTitle

public java.lang.String getTitle()

Returns title of this component.

Specified by:

getTitle in interface Displayer

Returns:

the title of this displayer

See Also:

Displayer.getTitle()

setTitle

public void setTitle(java.lang.String value)

Sets the title of component.

Specified by:

setTitle in interface Displayer

Parameters:

value - new title of this displayer, can be null

See Also:

Displayer.setTitle(java.lang.String)

setBackground

public void setBackground(java.awt.Color bg)

Overrides:

setBackground in class javax.swing.JComponent

setForeground

public void setForeground(java.awt.Color fg)

Overrides:

setForeground in class javax.swing.JComponent