Package org.jdesktop.swingx
Class JXImageView
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JPanel
-
- org.jdesktop.swingx.JXPanel
-
- org.jdesktop.swingx.JXImageView
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,javax.accessibility.Accessible
,javax.swing.Scrollable
public class JXImageView extends JXPanel
A panel which shows an image centered. The user can drag an image into the panel from other applications and move the image around within the view. The JXImageView has built in actions for scaling, rotating, opening a new image, and saving. These actions can be obtained using the relevant get*Action() methods.
TODO: has dashed rect and text indicating you should drag there.
If the user drags more than one photo at a time into the JXImageView only the first photo will be loaded and shown. Any errors generated internally, such as dragging in a list of files which are not images, will be reported to any attached
ErrorListener
added by the
method.addErrorListener(org.jdesktop.swingx.error.ErrorListener)
()- Author:
- Joshua Marinacci joshua.marinacci@sun.com
- 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
-
-
Field Summary
-
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
-
-
Constructor Summary
Constructors Constructor Description JXImageView()
Creates a new instance of JXImageView
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addErrorListener(ErrorListener el)
Adds an ErrorListener to the list of listeners to be notified of ErrorEventsprotected void
fireError(java.lang.Throwable throwable)
Send a new ErrorEvent to all registered ErrorListenersjava.lang.String
getExportFormat()
java.lang.String
getExportName()
java.awt.Image
getImage()
Gets the currently set image, or null if no image is set.java.awt.geom.Point2D
getImageLocation()
Gets the current image location.java.lang.String
getImageString()
Returns the current image's URL (if available) as a string.java.net.URL
getImageURL()
javax.swing.Action
getOpenAction()
Deprecated.see SwingX issue 990javax.swing.Action
getRotateClockwiseAction()
Deprecated.see SwingX issue 990javax.swing.Action
getRotateCounterClockwiseAction()
Deprecated.see SwingX issue 990javax.swing.Action
getSaveAction()
Deprecated.see SwingX issue 990double
getScale()
Gets the current image scale .javax.swing.Action
getZoomInAction()
Deprecated.see SwingX issue 990javax.swing.Action
getZoomOutAction()
Deprecated.see SwingX issue 990boolean
isDragEnabled()
Gets the current value of thedragEnabled
property.boolean
isEditable()
Returns whether or not the user can drag images.protected void
paintComponent(java.awt.Graphics g)
Implementation detail.void
removeErrorListener(ErrorListener el)
Remove an ErrorListener from the list of listeners to be notified of ErrorEvents.void
setDragEnabled(boolean dragEnabled)
Sets thedragEnabled
property, which determines whether or not the user can drag images out of the image view and into other components or application.void
setEditable(boolean editable)
Sets whether or not the user can drag images.void
setExportFormat(java.lang.String exportFormat)
void
setExportName(java.lang.String exportName)
void
setImage(java.awt.Image image)
Sets the current image.void
setImage(java.io.File file)
Set the current image to an image pointed to by this File.void
setImage(java.net.URL url)
Set the current image to an image pointed to by this URL.void
setImageLocation(java.awt.geom.Point2D imageLocation)
Set the current image location.void
setImageString(java.lang.String url)
Sets the current image using a string.void
setImageURL(java.net.URL imageURL)
void
setScale(double scale)
Sets the current image scale .-
Methods inherited from class org.jdesktop.swingx.JXPanel
getAlpha, getBackgroundPainter, getEffectiveAlpha, getPainterChangeListener, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableHeightHint, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollableWidthHint, isInheritAlpha, isPaintBorderInsets, paint, setAlpha, setBackground, setBackgroundPainter, setInheritAlpha, setPaintBorderInsets, setScrollableHeightHint, setScrollableTracksViewportHeight, setScrollableTracksViewportWidth, setScrollableWidthHint
-
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, paintBorder, paintChildren, 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, 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
-
-
-
-
Method Detail
-
getImageLocation
public java.awt.geom.Point2D getImageLocation()
Gets the current image location. This location can be changed programmatically or by the user dragging the image within the JXImageView.- Returns:
- the current image location
-
setImageLocation
public void setImageLocation(java.awt.geom.Point2D imageLocation)
Set the current image location.- Parameters:
imageLocation
- The new image location.
-
getImage
public java.awt.Image getImage()
Gets the currently set image, or null if no image is set.- Returns:
- the currently set image, or null if no image is set.
-
setImage
public void setImage(java.awt.Image image)
Sets the current image. Can set null if there should be no image show.- Parameters:
image
- the new image to set, or null.
-
setImage
public void setImage(java.net.URL url) throws java.io.IOException
Set the current image to an image pointed to by this URL.- Parameters:
url
- a URL pointing to an image, or null- Throws:
java.io.IOException
- thrown if the image cannot be loaded
-
setImage
public void setImage(java.io.File file) throws java.io.IOException
Set the current image to an image pointed to by this File.- Parameters:
file
- a File pointing to an image- Throws:
java.io.IOException
- thrown if the image cannot be loaded
-
getScale
public double getScale()
Gets the current image scale . When the scale is set to 1.0 then one image pixel = one screen pixel. When scale < 1.0 the draw image will be smaller than it's real size. When scale > 1.0 the drawn image will be larger than it's real size. 1.0 is the default value.- Returns:
- the current image scale
-
setScale
public void setScale(double scale)
Sets the current image scale . When the scale is set to 1.0 then one image pixel = one screen pixel. When scale < 1.0 the draw image will be smaller than it's real size. When scale > 1.0 the drawn image will be larger than it's real size. 1.0 is the default value.- Parameters:
scale
- the new image scale
-
isEditable
public boolean isEditable()
Returns whether or not the user can drag images.- Returns:
- whether or not the user can drag images
-
setEditable
public void setEditable(boolean editable)
Sets whether or not the user can drag images. When set to true the user can drag the photo around with their mouse. Also the cursor will be set to the 'hand' cursor. When set to false the user cannot drag photos around and the cursor will be set to the default.- Parameters:
editable
- whether or not the user can drag images
-
setDragEnabled
public void setDragEnabled(boolean dragEnabled)
Sets thedragEnabled
property, which determines whether or not the user can drag images out of the image view and into other components or application. Note: setting this to true will disable the ability to move the image around within the well., though it will not change the editable property directly.- Parameters:
dragEnabled
- the value to set the dragEnabled property to.
-
isDragEnabled
public boolean isDragEnabled()
Gets the current value of thedragEnabled
property.- Returns:
- the current value of the
dragEnabled
property
-
addErrorListener
public void addErrorListener(ErrorListener el)
Adds an ErrorListener to the list of listeners to be notified of ErrorEvents- Parameters:
el
- an ErrorListener to add
-
removeErrorListener
public void removeErrorListener(ErrorListener el)
Remove an ErrorListener from the list of listeners to be notified of ErrorEvents.- Parameters:
el
- an ErrorListener to remove
-
fireError
protected void fireError(java.lang.Throwable throwable)
Send a new ErrorEvent to all registered ErrorListeners- Parameters:
throwable
- the Error or Exception which was thrown
-
getOpenAction
@Deprecated public javax.swing.Action getOpenAction()
Deprecated.see SwingX issue 990Returns an Action which will open a file chooser, ask the user for an image file then load the image into the view. If the load fails an error will be fired to all registered ErrorListeners- Returns:
- the action
- See Also:
ErrorListener
-
getSaveAction
@Deprecated public javax.swing.Action getSaveAction()
Deprecated.see SwingX issue 990Returns an Action which will open a file chooser, ask the user for an image file then save the image from the view. If the save fails an error will be fired to all registered ErrorListeners- Returns:
- an Action
-
getRotateClockwiseAction
@Deprecated public javax.swing.Action getRotateClockwiseAction()
Deprecated.see SwingX issue 990Get an action which will rotate the currently selected image clockwise.- Returns:
- an action
-
getRotateCounterClockwiseAction
@Deprecated public javax.swing.Action getRotateCounterClockwiseAction()
Deprecated.see SwingX issue 990Gets an action which will rotate the current image counter clockwise.- Returns:
- an Action
-
getZoomOutAction
@Deprecated public javax.swing.Action getZoomOutAction()
Deprecated.see SwingX issue 990Gets an action which will zoom the current image out by a factor of 2.- Returns:
- an action
-
getZoomInAction
@Deprecated public javax.swing.Action getZoomInAction()
Deprecated.see SwingX issue 990Gets an action which will zoom the current image in by a factor of 2- Returns:
- an action
-
paintComponent
protected void paintComponent(java.awt.Graphics g)
Implementation detail.- Overrides:
paintComponent
in classJXPanel
- Parameters:
g
-
-
getExportName
public java.lang.String getExportName()
-
setExportName
public void setExportName(java.lang.String exportName)
-
getExportFormat
public java.lang.String getExportFormat()
-
setExportFormat
public void setExportFormat(java.lang.String exportFormat)
-
getImageURL
public java.net.URL getImageURL()
-
setImageURL
public void setImageURL(java.net.URL imageURL) throws java.io.IOException
- Throws:
java.io.IOException
-
getImageString
public java.lang.String getImageString()
Returns the current image's URL (if available) as a string. If the image has no URL, or if there is no image, then this method will return null.- Returns:
- the url of the image as a string
-
setImageString
public void setImageString(java.lang.String url) throws java.io.IOException
Sets the current image using a string. This string must contain a valid URL.- Parameters:
url
- string of a URL- Throws:
java.io.IOException
- thrown if the URL does not parse
-
-