org.zimowski.bambi.editor.studio.image

Class ImageContainer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLabel

org.zimowski.bambi.editor.studio.image.ScrollableJLabel

org.zimowski.bambi.editor.studio.image.ImageContainer

All Implemented Interfaces:

AdjustmentListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, Scrollable, SwingConstants

public class ImageContainer
extends ScrollableJLabel
implements AdjustmentListener, MouseListener, MouseMotionListener

Canvas for displaying an image. Provides scrolling, clipping and preview functionality. Internals of image manipulation delegated to ImageModel.

Version:

0.01 - initial demo release; part of image viewer demo app; very limited functionality, 0.1 - integrated into a working image upload application; added movable & resizable selector feature along with preview of sub image defined by the selector bounds., 1.0 - major improvements to the selector; Rearchitected to work more efficiently with the ImageModel

Author:

Sun Microsystems (0.01) - initial demo release; non-functional very limited, Adam Zimowski (mrazjava) (1.0+) - integrated into a working application

See Also:

Serialized Form

Nested Class Summary

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

JLabel.AccessibleJLabel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CANVAS_HEIGHT
static int	DEFAULT_CANVAS_WIDTH
static int	DEFAULT_SELECTOR_HEIGHT
static int	DEFAULT_SELECTOR_WIDTH
static int	EDGE_CURSOR_DETECTION Number of pixels on each side of the edge that creates invisible buffer detection zone to display proper resize cursor.
static int	STARTING_POS_SELECTOR_X
static int	STARTING_POS_SELECTOR_Y

Fields inherited from class javax.swing.JLabel

labelFor

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
ImageContainer(ImageOutputConfigFacade iConfig) Constructs a UI view of the image, backed by the model driving editing operations.

Method Summary

Methods

Modifier and Type	Method and Description
void	adjustmentValueChanged(AdjustmentEvent e) Scroll listener reports scroll bar click events.
BufferedImage	getClippedImage() Clips main image to bounds defined by the selector and returns sub image.
BufferedImage	getImage()
Dimension	getPreferredSize()
void	handleModelReset()
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	onEventQueue(ImageFilterQueueEvent ev)
void	onModelChanged(ModelLifecycleEvent ev)
void	onSelectorBackgroundColor(SelectorBackgroundEvent ev)
void	onSelectorChange(SelectorTypeEvent ev)
void	onShowSelector(SelectorVisibilityEvent ev)
void	paint(Graphics g) Paints selector and other artifacts on top of the image.
void	setMouseInputListener(ViewportMouseListener mouseInputListener)
void	setSelectorObserver(SelectorObserver observer)
void	setSelectorVisible(boolean isSelectorVisible)

Methods inherited from class org.zimowski.bambi.editor.studio.image.ScrollableJLabel

getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, setMaxUnitIncrement

Methods inherited from class javax.swing.JLabel

checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition, 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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, 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, 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, hide, 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

Field Detail

EDGE_CURSOR_DETECTION

public static final int EDGE_CURSOR_DETECTION

Number of pixels on each side of the edge that creates invisible buffer detection zone to display proper resize cursor.

See Also:

Constant Field Values

DEFAULT_CANVAS_WIDTH

public static final int DEFAULT_CANVAS_WIDTH

See Also:

Constant Field Values

DEFAULT_CANVAS_HEIGHT

public static final int DEFAULT_CANVAS_HEIGHT

See Also:

Constant Field Values

STARTING_POS_SELECTOR_X

public static final int STARTING_POS_SELECTOR_X

See Also:

Constant Field Values

STARTING_POS_SELECTOR_Y

public static final int STARTING_POS_SELECTOR_Y

See Also:

Constant Field Values

DEFAULT_SELECTOR_WIDTH

public static final int DEFAULT_SELECTOR_WIDTH

See Also:

Constant Field Values

DEFAULT_SELECTOR_HEIGHT

public static final int DEFAULT_SELECTOR_HEIGHT

See Also:

Constant Field Values

Constructor Detail

ImageContainer

public ImageContainer(ImageOutputConfigFacade iConfig)

Constructs a UI view of the image, backed by the model driving editing operations. If path argument is invalid it will be gracefully handled by a backing model which will load dummy image instead.

Parameters:

iConfig - output config handler

Method Detail

setSelectorObserver

public void setSelectorObserver(SelectorObserver observer)

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

paint

public void paint(Graphics g)

Paints selector and other artifacts on top of the image.

Overrides:

paint in class JComponent

onEventQueue

public void onEventQueue(ImageFilterQueueEvent ev)

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

getClippedImage

public BufferedImage getClippedImage()
                              throws RasterFormatException

Clips main image to bounds defined by the selector and returns sub image.

Returns:

image within the bounds of a selector

Throws:

RasterFormatException - if part of a selector is out of picture bounds

getImage

public BufferedImage getImage()

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

adjustmentValueChanged

public void adjustmentValueChanged(AdjustmentEvent e)

Scroll listener reports scroll bar click events.

Specified by:

adjustmentValueChanged in interface AdjustmentListener

setSelectorVisible

public void setSelectorVisible(boolean isSelectorVisible)

onModelChanged

public void onModelChanged(ModelLifecycleEvent ev)

handleModelReset

public void handleModelReset()

setMouseInputListener

public void setMouseInputListener(ViewportMouseListener mouseInputListener)

onSelectorChange

public void onSelectorChange(SelectorTypeEvent ev)

onSelectorBackgroundColor

public void onSelectorBackgroundColor(SelectorBackgroundEvent ev)

onShowSelector

public void onShowSelector(SelectorVisibilityEvent ev)