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)
()
javax.swing.JPanel.AccessibleJPanel
javax.swing.JComponent.AccessibleJComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Constructor and Description |
---|
JXImageView()
Creates a new instance of JXImageView
|
Modifier and Type | Method and Description |
---|---|
void |
addErrorListener(ErrorListener el)
Adds an ErrorListener to the list of listeners to be notified
of ErrorEvents
|
protected void |
fireError(java.lang.Throwable throwable)
Send a new ErrorEvent to all registered ErrorListeners
|
java.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 990
|
javax.swing.Action |
getRotateClockwiseAction()
Deprecated.
see SwingX issue 990
|
javax.swing.Action |
getRotateCounterClockwiseAction()
Deprecated.
see SwingX issue 990
|
javax.swing.Action |
getSaveAction()
Deprecated.
see SwingX issue 990
|
double |
getScale()
Gets the current image scale .
|
javax.swing.Action |
getZoomInAction()
Deprecated.
see SwingX issue 990
|
javax.swing.Action |
getZoomOutAction()
Deprecated.
see SwingX issue 990
|
boolean |
isDragEnabled()
Gets the current value of the
dragEnabled 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 the
dragEnabled 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.io.File file)
Set the current image to an image pointed to by this File.
|
void |
setImage(java.awt.Image image)
Sets the current image.
|
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 .
|
getAlpha, getBackgroundPainter, getEffectiveAlpha, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, isInheritAlpha, isPaintBorderInsets, paint, setAlpha, setBackground, setBackgroundPainter, setInheritAlpha, setPaintBorderInsets, setScrollableTracksViewportHeight, setScrollableTracksViewportWidth
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
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
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
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
public java.awt.geom.Point2D getImageLocation()
public void setImageLocation(java.awt.geom.Point2D imageLocation)
imageLocation
- The new image location.public java.awt.Image getImage()
public void setImage(java.awt.Image image)
image
- the new image to set, or null.public void setImage(java.net.URL url) throws java.io.IOException
url
- a URL pointing to an image, or nulljava.io.IOException
- thrown if the image cannot be loadedpublic void setImage(java.io.File file) throws java.io.IOException
file
- a File pointing to an imagejava.io.IOException
- thrown if the image cannot be loadedpublic double getScale()
public void setScale(double scale)
scale
- the new image scalepublic boolean isEditable()
public void setEditable(boolean editable)
editable
- whether or not the user can drag imagespublic void setDragEnabled(boolean dragEnabled)
dragEnabled
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.dragEnabled
- the value to set the dragEnabled property to.public boolean isDragEnabled()
dragEnabled
property.dragEnabled
propertypublic void addErrorListener(ErrorListener el)
el
- an ErrorListener to addpublic void removeErrorListener(ErrorListener el)
el
- an ErrorListener to removeprotected void fireError(java.lang.Throwable throwable)
throwable
- the Error or Exception which was thrown@Deprecated public javax.swing.Action getOpenAction()
ErrorListener
@Deprecated public javax.swing.Action getSaveAction()
@Deprecated public javax.swing.Action getRotateClockwiseAction()
@Deprecated public javax.swing.Action getRotateCounterClockwiseAction()
@Deprecated public javax.swing.Action getZoomOutAction()
@Deprecated public javax.swing.Action getZoomInAction()
protected void paintComponent(java.awt.Graphics g)
paintComponent
in class JXPanel
g
- public java.lang.String getExportName()
public void setExportName(java.lang.String exportName)
public java.lang.String getExportFormat()
public void setExportFormat(java.lang.String exportFormat)
public java.net.URL getImageURL()
public void setImageURL(java.net.URL imageURL) throws java.io.IOException
java.io.IOException
public java.lang.String getImageString()
public void setImageString(java.lang.String url) throws java.io.IOException
url
- string of a URLjava.io.IOException
- thrown if the URL does not parse