org.jplot2d.swing

Class JPlot2DComponent

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.jplot2d.swing.JPlot2DComponent

All Implemented Interfaces:

java.awt.event.HierarchyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, RenderingFinishedListener

public class JPlot2DComponent
extends javax.swing.JComponent
implements java.awt.event.HierarchyListener, RenderingFinishedListener

A JComponent that display a plot in its center.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JPlot2DComponent.DefaultImageRendererFactory

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

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

Constructors

Constructor and Description
JPlot2DComponent(Plot plot) Construct a JComponent to display the given plot in its center.
JPlot2DComponent(Plot plot, boolean threadSafe) Construct a JComponent to display the given plot in its center.
JPlot2DComponent(RenderEnvironment env) Construct a JComponent to display a plot in its center.

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	getImage() Returns the current image displayed in this component.
int	getImageOffsetX() Returns the x offset where the plot image draw.
int	getImageOffsetY() Returns the y offset where the plot image draw.
ImageRendererFactory	getImageRendererFactory() Returns the renderer factory used to create image renderers.
java.awt.Color	getPlotBackground() Returns the background color of plot.
RenderEnvironment	getRenderEnvironment() Return the RenderEnvironment of this JPlot2DComponent.
void	hierarchyChanged(java.awt.event.HierarchyEvent event)
void	paintComponent(java.awt.Graphics g)
void	renderingFinished(RenderingFinishedEvent event) This method is called by image renderer.
void	setBounds(int x, int y, int width, int height)
void	setImageRendererFactory(ImageRendererFactory rendererFactory) Sets the renderer factory used to create image renderers.
void	setInteractionEnabled(boolean enabled)
void	setMousePreference(MousePreference prefs)
void	setPlotBackground(java.awt.Color bgColor) Sets the background color of plot.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JPlot2DComponent

public JPlot2DComponent(Plot plot)

Construct a JComponent to display the given plot in its center. The plot properties can be safely by multiple threads.

Parameters:

plot - the plot to be display

JPlot2DComponent

public JPlot2DComponent(Plot plot,
                        boolean threadSafe)

Construct a JComponent to display the given plot in its center.

Parameters:

plot - the plot to be display

threadSafe - if false, all plot properties can only be changed within a single thread. if true, all plot properties can be safely changed by multiple threads.

JPlot2DComponent

public JPlot2DComponent(RenderEnvironment env)

Construct a JComponent to display a plot in its center. The plot has been assigned to the given RenderEnvironment.

Parameters:

env - the RenderEnvironment

Method Detail

getRenderEnvironment

public RenderEnvironment getRenderEnvironment()

Return the RenderEnvironment of this JPlot2DComponent. The RenderEnvironment generate plot images and display them in this component.

Returns:

the RenderEnvironment of this JPlot2DComponen

getPlotBackground

public java.awt.Color getPlotBackground()

Returns the background color of plot. The default color is Color.WHITE.

Returns:

the background color of plot

setPlotBackground

public void setPlotBackground(java.awt.Color bgColor)

Sets the background color of plot. The default color is Color.WHITE.

Parameters:

bgcolor - the new background color of plot

getImageRendererFactory

public ImageRendererFactory getImageRendererFactory()

Returns the renderer factory used to create image renderers.

Returns:

the current renderer factory

setImageRendererFactory

public void setImageRendererFactory(ImageRendererFactory rendererFactory)

Sets the renderer factory used to create image renderers.

Parameters:

rendererFactory - the new renderer factory

hierarchyChanged

public void hierarchyChanged(java.awt.event.HierarchyEvent event)

Specified by:

hierarchyChanged in interface java.awt.event.HierarchyListener

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)

Overrides:

setBounds in class java.awt.Component

paintComponent

public void paintComponent(java.awt.Graphics g)

Overrides:

paintComponent in class javax.swing.JComponent

getImage

public java.awt.image.BufferedImage getImage()

Returns the current image displayed in this component.

Returns:

the current image

getImageOffsetX

public int getImageOffsetX()

Returns the x offset where the plot image draw.

Returns:

the x offset of the plot image

getImageOffsetY

public int getImageOffsetY()

Returns the y offset where the plot image draw.

Returns:

the y offset of the plot image

renderingFinished

public void renderingFinished(RenderingFinishedEvent event)

Description copied from interface: RenderingFinishedListener

This method is called by image renderer. The renderer may be asynchronous, so the concurrency must be considered in this method.

Specified by:

renderingFinished in interface RenderingFinishedListener

Parameters:

event - the event

setMousePreference

public void setMousePreference(MousePreference prefs)

setInteractionEnabled

public void setInteractionEnabled(boolean enabled)