TiledImageViewer

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - org.pepsoft.util.swing.TiledImageViewer

All Implemented Interfaces:

ComponentListener, HierarchyListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener, TileListener

Direct Known Subclasses:

WorldPainterView
```
public class TiledImageViewer
extends JComponent
implements TileListener, MouseListener, MouseMotionListener, ComponentListener, HierarchyListener
```
A generic visual component which can display one or more layers of large or even endless tile-based images, with support for scrolling and scaling the images.
The tiles are provided by tile providers. The tiles are requested asynchronously on multiple threads and are cached. This means that tile providers have to do no caching themselves and are free to calculate or generate each tile on request, even if that is relatively slow.
When zooming in, this viewer performs all the scaling itself. When zooming out, for tile providers which indicate that they support zooming, the scaling is delegated to the tile providers.
This class does not provide scrollbars, however it can be encapsulated in a TiledImageViewerContainer which will surround it with scrollbars, with support for the tile providers' extents.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TiledImageViewer.BackgroundImageMode`
`static interface`	`TiledImageViewer.ViewListener` A listener for changes to a `TiledImageViewer` view.

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 IntegerAttributeKey`	`ADVANCED_SETTING_MAX_TILE_RENDER_THREADS`
`protected int`	`markerX` The image coordindates of the marker (if any) to paint as a red crosshair.
`protected int`	`markerY` The image coordindates of the marker (if any) to paint as a red crosshair.
`protected int`	`previousX` The previously displayed location in scaled coordinates.
`protected int`	`previousY` The previously displayed location in scaled coordinates.
`static int`	`TILE_SIZE`
`static int`	`TILE_SIZE_BITS`
`static int`	`TILE_SIZE_MASK`
`protected int`	`viewX` The currently displayed location in scaled coordinates.
`protected int`	`viewY` The currently displayed location in scaled coordinates.
`protected int`	`xOffset` The offset to apply to the image so that the view coordinates are displayed in the centre of the view.
`protected int`	`yOffset` The offset to apply to the image so that the view coordinates are displayed in the centre of the view.

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

Fields inherited from class java.awt.Component
accessibleContext, 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
`TiledImageViewer()` Create a new tiled image viewer which allows panning by dragging with the left mouse button and which paints the central crosshair.
`TiledImageViewer(boolean leftClickDrags, boolean paintCentre)` Create a new tiled image viewer.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addOverlay(String key, int x, Component componentToTrack, BufferedImage overlay)` Add an overlay.
`void`	`addTileProvider(int index, TileProvider tileProvider)` Add or insert a new tile provider at a specific index in the list.
`void`	`addTileProvider(TileProvider tileProvider)` Add a new tile provider to the end of the list of tile providers.
`void`	`componentHidden(ComponentEvent e)`
`void`	`componentMoved(ComponentEvent e)`
`void`	`componentResized(ComponentEvent e)`
`void`	`componentShown(ComponentEvent e)`
`BufferedImage`	`getBackgroundImage()`
`TiledImageViewer.BackgroundImageMode`	`getBackgroundImageMode()`
`Rectangle`	`getExtent()` Get the combined and zoom-corrected extent or main area of interest of all the tile providers, in component coordinates.
`Color`	`getGridColour()` Get the colour in which the grid is painted.
`int`	`getGridSize()` Get the current size in image coordinates of the grid.
`Point`	`getMarkerCoords()` Get the coordinates in image coordinates of the marker (displayed as a red crosshair), if configured.
`protected Rectangle`	`getTileBounds(int x, int y)` Get the bounds of a tile in component coordinates, taking the current zoom level into account.
`protected Rectangle`	`getTileBounds(int x, int y, int effectiveZoom)` Get the bounds of a tile in component coordinates, taking a specific zoom level into account.
`protected Rectangle`	`getTileBounds(int x, int y, int width, int height, int effectiveZoom)` Get the bounds of a rectangular area of tiles in component coordinates, taking a specific zoom level into account.
`protected Rectangle`	`getTileBounds(TileProvider tileProvider, int x, int y, int effectiveZoom)` Get the bounds of a tile in component coordinates, taking a specific zoom level into account and for a specific tile provider.
`protected Rectangle`	`getTileBounds(TileProvider tileProvider, int x, int y, int width, int height, int effectiveZoom)` Get the bounds of a rectangular area of tiles in component coordinates, taking a specific zoom level into account and for a specific tile provider.
`int`	`getTileProviderCount()` Get the number of currently configured tile providers.
`Point`	`getTileProviderOffset(TileProvider tileProvider)`
`List<TileProvider>`	`getTileProviders()` Get an unmodifiable view of the currently configured list of tile providers.
`TiledImageViewer.ViewListener`	`getViewListener()` Set the view listener.
`Point`	`getViewLocation()` Get the coordinate in image coordinates of the centre of the view.
`int`	`getViewX()` Get the X coordinate in image coordinates of the centre of the view.
`int`	`getViewY()` Get the Y coordinate in image coordinates of the centre of the view.
`int`	`getZoom()` Get the current zoom level in powers of two.
`void`	`hierarchyChanged(HierarchyEvent event)`
`boolean`	`isInhibitUpdates()`
`boolean`	`isPaintGrid()` Determine whether the grid is currently painted.
`protected boolean`	`isTileVisible(int x, int y, int effectiveZoom)` Determine whether a tile is currently visible in the viewport.
`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`	`moveBy(int dx, int dy)` Move the view by a number of pixels.
`void`	`moveTileProviderBy(TileProvider tileProvider, int dx, int dy)`
`void`	`moveTo(int x, int y)` Centre the view on a particular location in image coordinates.
`void`	`moveTo(Point coords)` Centre the view on a particular location in image coordinates.
`void`	`moveToMarker()` Centre the view on the currently configured marker.
`void`	`moveToOrigin()` Centre the view on the image origin (coordinates 0,0).
`protected void`	`paintComponent(Graphics g)`
`void`	`refresh()` Immediately throws away and refreshes all tiles of all tile providers.
`void`	`refresh(boolean keepDirtyTiles)` Refreshes all tiles of all tile providers.
`void`	`refresh(TileProvider tileProvider, int x, int y)` Refresh a single tile for a single tile provider.
`void`	`refresh(TileProvider tileProvider, Set<Point> tiles)` Refresh a number of tiles for a single tile provider.
`void`	`removeAllTileProviders()` Remove all tile providers.
`void`	`removeOverlay(String key)` Remove a previously added overlay.
`void`	`removeTileProvider(int index)` Remove a tile provider.
`void`	`removeTileProvider(TileProvider tileProvider)` Remove a tile provider.
`void`	`replaceTileProvider(int index, TileProvider newTileProvider)` Replace a tile provider and reuse the existing provider's cached tile images as stale tile images for the new provider.
`void`	`replaceTileProvider(TileProvider oldTileProvider, TileProvider newTileProvider)` Replace a tile provider and reuse the existing provider's cached tile images as stale tile images for the new provider.
`void`	`reset()` Deprecated.
`void`	`resetZoom()`
`void`	`setBackgroundImage(BufferedImage backgroundImage)`
`void`	`setBackgroundImageMode(TiledImageViewer.BackgroundImageMode backgroundImageMode)`
`void`	`setGridColour(Color gridColour)` Set the colour in which to paint the grid.
`void`	`setGridSize(int gridSize)` Set the size in image coordinates at which the grid should be painted.
`void`	`setInhibitUpdates(boolean inhibitUpdates)`
`void`	`setMarkerCoords(Point markerCoords)` Set the coordinates in image coordinates where a red crosshair marker should be displayed, if any.
`void`	`setPaintGrid(boolean paintGrid)` Set whether the gid should be painted.
`void`	`setTileProvider(int index, TileProvider tileProvider)` Replace a tile provider and remove all cached tile images for the existing provider.
`void`	`setTileProvider(TileProvider tileProvider)` Set the first tile provider.
`void`	`setTileProviderOffset(TileProvider tileProvider, Point offset)`
`void`	`setViewListener(TiledImageViewer.ViewListener viewListener)` Get the currently configured view listener, if any.
`void`	`setZoom(int zoom)` Set the zoom level in powers of two.
`void`	`setZoom(int zoom, int locusX, int locusY)` Set the zoom level in powers of two.
`void`	`tileChanged(TileProvider source, int x, int y)` Invoked when the contents of a tile have changed and the tile should be retrieved again.
`void`	`tilesChanged(TileProvider source, Set<Point> tiles)` Invoked when the contents of one or more tiles have changed and the tile(s) should be retrieved again.
`protected float`	`transformGraphics(Graphics2D g2)` Apply translation and scaling to a graphics canvas according to the current location and zoom settings such that it can be painted using image coordinates.
`Point`	`viewToWorld(int x, int y)` Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, taking the current zoom level into account.
`Point`	`viewToWorld(int x, int y, int effectiveZoom)` Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, using a specific zoom level.
`Rectangle`	`viewToWorld(int x, int y, int width, int height)` Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, taking the current zoom level into account.
`Point`	`viewToWorld(Point coords)` Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, taking the current zoom level into account.
`Point`	`viewToWorld(Point coords, int effectiveZoom)` Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, using a specific zoom level.
`Rectangle`	`viewToWorld(Rectangle coords)` Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, taking the current zoom level into account.
`Point`	`viewToWorld(TileProvider tileProvider, int x, int y)` Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, taking the current zoom level into account and for the specified tile provider.
`Point`	`viewToWorld(TileProvider tileProvider, int x, int y, int effectiveZoom)` Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, using a specific zoom level and for a specific tile provider.
`Point`	`viewToWorld(TileProvider tileProvider, Point coords, int effectiveZoom)` Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, using a specific zoom level and for a specific tile provider.
`Point`	`worldToView(int x, int y)` Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, taking the current zoom level into account.
`Rectangle`	`worldToView(int x, int y, int width, int height)` Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, taking the current zoom level into account.
`Rectangle`	`worldToView(int x, int y, int width, int height, int effectiveZoom)` Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, using a specific zoom level.
`Point`	`worldToView(Point coords)` Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, taking the current zoom level into account.
`Rectangle`	`worldToView(Rectangle coords)` Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, taking the current zoom level into account.
`Rectangle`	`worldToView(Rectangle coords, int effectiveZoom)` Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, using a specific zoom level.
`Rectangle`	`worldToView(TileProvider tileProvider, int x, int y, int width, int height, int effectiveZoom)` Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, using a specific zoom level and for a specific tile provider.

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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, updateUI

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, 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, 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
  - viewX
```
protected int viewX
```
    The currently displayed location in scaled coordinates.
  - viewY
```
protected int viewY
```
    The currently displayed location in scaled coordinates.
  - previousX
```
protected int previousX
```
    The previously displayed location in scaled coordinates. Used during mouse drag operations.
  - previousY
```
protected int previousY
```
    The previously displayed location in scaled coordinates. Used during mouse drag operations.
  - markerX
```
protected int markerX
```
    The image coordindates of the marker (if any) to paint as a red crosshair.
  - markerY
```
protected int markerY
```
    The image coordindates of the marker (if any) to paint as a red crosshair.
  - xOffset
```
protected int xOffset
```
    The offset to apply to the image so that the view coordinates are displayed in the centre of the view.
  - yOffset
```
protected int yOffset
```
    The offset to apply to the image so that the view coordinates are displayed in the centre of the view.
  - TILE_SIZE
```
public static final int TILE_SIZE
```
    See Also:
    
    Constant Field Values
  - TILE_SIZE_BITS
```
public static final int TILE_SIZE_BITS
```
    See Also:
    
    Constant Field Values
  - TILE_SIZE_MASK
```
public static final int TILE_SIZE_MASK
```
    See Also:
    
    Constant Field Values
  - ADVANCED_SETTING_MAX_TILE_RENDER_THREADS
```
public static final IntegerAttributeKey ADVANCED_SETTING_MAX_TILE_RENDER_THREADS
```
- Constructor Detail
  - TiledImageViewer
```
public TiledImageViewer()
```
    Create a new tiled image viewer which allows panning by dragging with the left mouse button and which paints the central crosshair.
  - TiledImageViewer
```
public TiledImageViewer(boolean leftClickDrags,
                        boolean paintCentre)
```
    Create a new tiled image viewer.
    
    Parameters:
    
    leftClickDrags - Whether dragging with the left mouse button should pan the image.
    
    paintCentre - Whether the central crosshair indicating the current location should be painted.
- Method Detail
  - getTileProviders
```
public List<TileProvider> getTileProviders()
```
    Get an unmodifiable view of the currently configured list of tile providers.
    
    Returns:
    
    An unmodifyable view of the currently configured list of tile providers.
  - addTileProvider
```
public void addTileProvider(TileProvider tileProvider)
```
    Add a new tile provider to the end of the list of tile providers.
    
    Parameters:
    
    tileProvider - The tile provider to add.
  - getTileProviderCount
```
public int getTileProviderCount()
```
    Get the number of currently configured tile providers.
    
    Returns:
    
    The number of currently configured tile providers.
  - setTileProvider
```
public void setTileProvider(TileProvider tileProvider)
```
    Set the first tile provider. Mainly meant as a convenience method for clients that will only ever use one tile provider at a time. Will add the tile provider if there are none yet configured, or replace the first tile provider on the list if one or more tile providers are already set.
    
    Parameters:
    
    tileProvider - The tile provider to set.
  - setTileProvider
```
public void setTileProvider(int index,
                            TileProvider tileProvider)
```
    Replace a tile provider and remove all cached tile images for the existing provider.
    
    Parameters:
    
    index - The index of the tile provider to replace.
    
    tileProvider - The tile provider with which to replace the existing provider at the specified index.
  - replaceTileProvider
```
public void replaceTileProvider(TileProvider oldTileProvider,
                                TileProvider newTileProvider)
```
    Replace a tile provider and reuse the existing provider's cached tile images as stale tile images for the new provider.
    
    Parameters:
    
    oldTileProvider - The tile provider to replace.
    
    newTileProvider - The tile provider with which to replace it.
  - replaceTileProvider
```
public void replaceTileProvider(int index,
                                TileProvider newTileProvider)
```
    Replace a tile provider and reuse the existing provider's cached tile images as stale tile images for the new provider.
    
    Parameters:
    
    index - The index of the tile provider to replace.
    
    newTileProvider - The tile provider with which to replace it.
  - removeTileProvider
```
public void removeTileProvider(TileProvider tileProvider)
```
    Remove a tile provider.
    
    Parameters:
    
    tileProvider - The tile provider to remove.
  - removeTileProvider
```
public void removeTileProvider(int index)
```
    Remove a tile provider.
    
    Parameters:
    
    index - The index of the tile provider to remove.
  - removeAllTileProviders
```
public void removeAllTileProviders()
```
    Remove all tile providers.
  - addTileProvider
```
public void addTileProvider(int index,
                            TileProvider tileProvider)
```
    Add or insert a new tile provider at a specific index in the list.
    
    Parameters:
    
    index - The index at which to add or insert the new tile provider.
    
    tileProvider - The tile provider to add or insert.
  - getViewX
```
public int getViewX()
```
    Get the X coordinate in image coordinates of the centre of the view.
    
    Returns:
    
    The X coordinate in image coordinates of the centre of the view.
  - getViewY
```
public int getViewY()
```
    Get the Y coordinate in image coordinates of the centre of the view.
    
    Returns:
    
    The Y coordinate in image coordinates of the centre of the view.
  - getExtent
```
public Rectangle getExtent()
```
    Get the combined and zoom-corrected extent or main area of interest of all the tile providers, in component coordinates.
    
    Returns:
    
    The combined and zoom-corrected extent or main area of interest of all the tile providers, or null if there are no tile providers configured, or none of them indicate an extent.
    
    See Also:
    
    TileProvider.getExtent()
  - getViewLocation
```
public Point getViewLocation()
```
    Get the coordinate in image coordinates of the centre of the view.
    
    Returns:
    
    The coordinate in image coordinates of the centre of the view.
  - getZoom
```
public int getZoom()
```
    Get the current zoom level in powers of two.
    
    Returns:
    
    The current zoom level as a power of two. The scale is 2^zoom.
  - setZoom
```
public void setZoom(int zoom)
```
    Set the zoom level in powers of two. 0 means "native size"; positive numbers zoom in (result in a larger scale); negative numbers zoom out (result in a smaller scale).
    
    Parameters:
    
    zoom - The new zoom level as a power of two. The scale will be 2^zoom.
  - setZoom
```
public void setZoom(int zoom,
                    int locusX,
                    int locusY)
```
    Set the zoom level in powers of two. 0 means "native size"; positive numbers zoom in (result in a larger scale); negative numbers zoom out (result in a smaller scale).
    
    Parameters:
    
    zoom - The new zoom level as a power of two. The scale will be 2^zoom.
  - resetZoom
```
public void resetZoom()
```
  - getMarkerCoords
```
public Point getMarkerCoords()
```
    Get the coordinates in image coordinates of the marker (displayed as a red crosshair), if configured.
    
    Returns:
    
    The coordinates in image coordinates of the marker, or null if no marker is configured.
  - setMarkerCoords
```
public void setMarkerCoords(Point markerCoords)
```
    Set the coordinates in image coordinates where a red crosshair marker should be displayed, if any.
    
    Parameters:
    
    markerCoords - The coordinates in image coordinates where a red crosshair marker should be displayed, or null if no marker should be displayed.
  - isPaintGrid
```
public boolean isPaintGrid()
```
    Determine whether the grid is currently painted.
    
    Returns:
    
    true if the grid is currently painted.
  - setPaintGrid
```
public void setPaintGrid(boolean paintGrid)
```
    Set whether the gid should be painted.
    
    Parameters:
    
    paintGrid - true if the grid should be painted.
  - getGridSize
```
public int getGridSize()
```
    Get the current size in image coordinates of the grid.
    
    Returns:
    
    The current size in image coordinates of the grid.
  - setGridSize
```
public void setGridSize(int gridSize)
```
    Set the size in image coordinates at which the grid should be painted.
    
    Parameters:
    
    gridSize - The size in image coordinates at which the grid should be painted.
  - moveTo
```
public void moveTo(Point coords)
```
    Centre the view on a particular location in image coordinates.
    
    Parameters:
    
    coords - The coordinates in image coordinates of the location to centre.
  - moveTo
```
public void moveTo(int x,
                   int y)
```
    Centre the view on a particular location in image coordinates.
    
    Parameters:
    
    x - The X coordinate in image coordinates of the location to centre.
    
    y - The Y coordinate in image coordinates of the location to centre.
  - moveToMarker
```
public void moveToMarker()
```
    Centre the view on the currently configured marker. Does nothing if no marker is configured.
  - moveToOrigin
```
public void moveToOrigin()
```
    Centre the view on the image origin (coordinates 0,0).
  - moveBy
```
public void moveBy(int dx,
                   int dy)
```
    Move the view by a number of pixels. The actual movement in image coordinates may be different if the zoom level is not zero.
    
    Parameters:
    
    dx - The number of pixels to move the view right.
    
    dy - The number of pixels to move the view down.
  - refresh
```
public void refresh()
```
    Immediately throws away and refreshes all tiles of all tile providers.
  - refresh
```
public void refresh(boolean keepDirtyTiles)
```
    Refreshes all tiles of all tile providers.
    
    Parameters:
    
    keepDirtyTiles - Whether to keep displaying the old tiles while the new ones are being rendered.
  - refresh
```
public void refresh(TileProvider tileProvider,
                    int x,
                    int y)
```
    Refresh a single tile for a single tile provider. If the tile is visible it will immediately be scheduled for background rendering. Otherwise it will be scheduled when it next becomes visible. If there is a fresh tile image in the cache that will be used as a stale tile image until it has been re-rendered.
    
    Parameters:
    
    tileProvider - The tile provider.
    
    x - The X coordinate of the tile in tiles relative to the image origin.
    
    y - The Y coordinate of the tile in tiles relative to the image origin.
  - refresh
```
public void refresh(TileProvider tileProvider,
                    Set<Point> tiles)
```
    Refresh a number of tiles for a single tile provider. Tiles that are currently visible will immediately be scheduled for background rendering. Otherwise they will be scheduled when they next become visible. Any fresh tile images in the cache will be used as stale tile images until the tiles are re-rendered.
    
    Parameters:
    
    tileProvider - The tile provider.
    
    tiles - A set of tile coordinates of the tiles to refresh, in tiles relative to the image origin.
  - reset
```
@Deprecated
public void reset()
```
    Deprecated.
    
    Reset the location to the origin, and the zoom level to -2.
  - worldToView
```
public final Point worldToView(Point coords)
```
    Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, taking the current zoom level into account.
  - worldToView
```
public final Point worldToView(int x,
                               int y)
```
    Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, taking the current zoom level into account.
  - viewToWorld
```
public final Point viewToWorld(Point coords)
```
    Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, taking the current zoom level into account.
  - viewToWorld
```
public final Point viewToWorld(int x,
                               int y)
```
    Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, taking the current zoom level into account. This version does not take tile-provider-specific offset into acount.
  - viewToWorld
```
public final Point viewToWorld(TileProvider tileProvider,
                               int x,
                               int y)
```
    Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, taking the current zoom level into account and for the specified tile provider.
    
    Throws:
    
    UnknownTileProviderException - If the specified tile provider is not configured on this image viewer.
  - viewToWorld
```
public final Point viewToWorld(Point coords,
                               int effectiveZoom)
```
    Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, using a specific zoom level. This version does not take per-tile-provider offsets into account.
  - viewToWorld
```
public final Point viewToWorld(TileProvider tileProvider,
                               Point coords,
                               int effectiveZoom)
```
    Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, using a specific zoom level and for a specific tile provider.
    
    Throws:
    
    UnknownTileProviderException - If the specified tile provider is not configured on this image viewer.
  - viewToWorld
```
public final Point viewToWorld(int x,
                               int y,
                               int effectiveZoom)
```
    Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, using a specific zoom level. This version does not take per-tile-provider offsets into account.
  - viewToWorld
```
public final Point viewToWorld(TileProvider tileProvider,
                               int x,
                               int y,
                               int effectiveZoom)
```
    Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, using a specific zoom level and for a specific tile provider.
    
    Throws:
    
    UnknownTileProviderException - If the specified tile provider is not configured on this image viewer.
  - worldToView
```
public final Rectangle worldToView(Rectangle coords)
```
    Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, taking the current zoom level into account.
  - worldToView
```
public final Rectangle worldToView(int x,
                                   int y,
                                   int width,
                                   int height)
```
    Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, taking the current zoom level into account.
  - worldToView
```
public final Rectangle worldToView(Rectangle coords,
                                   int effectiveZoom)
```
    Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, using a specific zoom level.
  - worldToView
```
public final Rectangle worldToView(int x,
                                   int y,
                                   int width,
                                   int height,
                                   int effectiveZoom)
```
    Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, using a specific zoom level. This version does not take tile-provider-specific offsets into account.
  - worldToView
```
public final Rectangle worldToView(TileProvider tileProvider,
                                   int x,
                                   int y,
                                   int width,
                                   int height,
                                   int effectiveZoom)
```
    Transform coordinates from image (world) coordinates to component (pixels relative to the top left corner) coordinates, using a specific zoom level and for a specific tile provider.
    
    Throws:
    
    UnknownTileProviderException - If the specified tile provider is not configured on this image viewer.
  - viewToWorld
```
public final Rectangle viewToWorld(Rectangle coords)
```
    Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, taking the current zoom level into account.
  - viewToWorld
```
public final Rectangle viewToWorld(int x,
                                   int y,
                                   int width,
                                   int height)
```
    Transform coordinates from component (pixels relative to the top left corner) coordinates to image (world) coordinates, taking the current zoom level into account.
  - getViewListener
```
public TiledImageViewer.ViewListener getViewListener()
```
    Set the view listener.
    
    Returns:
    
    The view listener to set.
  - setViewListener
```
public void setViewListener(TiledImageViewer.ViewListener viewListener)
```
    Get the currently configured view listener, if any.
    
    Parameters:
    
    viewListener - The currently configured view listener, or null if there is none.
  - addOverlay
```
public void addOverlay(String key,
                       int x,
                       Component componentToTrack,
                       BufferedImage overlay)
```
    Add an overlay. An overlay is an image which is overlaid on the viewport, on the left or right edge of the view, vertically tracking some other component. The image may be partially transparent.
    
    Parameters:
    
    key - The unique key of the overlay to add.
    
    x - The horizontal distance from the left edge to paint the overlay, or if negative: the horizontal distance from the right edge.
    
    componentToTrack - The component of which the height should be tracked.
    
    overlay - The image to overlay on the view.
  - removeOverlay
```
public void removeOverlay(String key)
```
    Remove a previously added overlay.
    
    Parameters:
    
    key - The unique key of the overlay to remove.
  - getGridColour
```
public Color getGridColour()
```
    Get the colour in which the grid is painted.
    
    Returns:
    
    The colour in which the grid is painted.
  - setTileProviderOffset
```
public void setTileProviderOffset(TileProvider tileProvider,
                                  Point offset)
```
  - getTileProviderOffset
```
public Point getTileProviderOffset(TileProvider tileProvider)
```
  - moveTileProviderBy
```
public void moveTileProviderBy(TileProvider tileProvider,
                               int dx,
                               int dy)
```
  - setGridColour
```
public void setGridColour(Color gridColour)
```
    Set the colour in which to paint the grid.
    
    Parameters:
    
    gridColour - The colour in which to paint the grid.
  - getBackgroundImage
```
public BufferedImage getBackgroundImage()
```
  - setBackgroundImage
```
public void setBackgroundImage(BufferedImage backgroundImage)
```
  - getBackgroundImageMode
```
public TiledImageViewer.BackgroundImageMode getBackgroundImageMode()
```
  - setBackgroundImageMode
```
public void setBackgroundImageMode(TiledImageViewer.BackgroundImageMode backgroundImageMode)
```
  - isInhibitUpdates
```
public boolean isInhibitUpdates()
```
  - setInhibitUpdates
```
public void setInhibitUpdates(boolean inhibitUpdates)
```
  - isTileVisible
```
protected final boolean isTileVisible(int x,
                                      int y,
                                      int effectiveZoom)
```
    Determine whether a tile is currently visible in the viewport.
    
    Parameters:
    
    x - The X coordinate of the tile to check for visibility.
    
    y - The Y coordinate of the tile to check for visibility.
    
    effectiveZoom - The zoom level to take into account.
    
    Returns:
    
    true if any part of the specified tile intersects the viewport.
  - getTileBounds
```
protected final Rectangle getTileBounds(int x,
                                        int y)
```
    Get the bounds of a tile in component coordinates, taking the current zoom level into account.
    
    Parameters:
    
    x - The X coordinate of the tile for which to determine the bounds.
    
    y - The X coordinate of the tile for which to determine the bounds.
    
    Returns:
    
    The area in component coordinates taken up by the specified tile.
  - getTileBounds
```
protected final Rectangle getTileBounds(int x,
                                        int y,
                                        int effectiveZoom)
```
    Get the bounds of a tile in component coordinates, taking a specific zoom level into account. This version does not take per-tile-provider offsets into account.
    
    Parameters:
    
    x - The X coordinate of the tile for which to determine the bounds.
    
    y - The X coordinate of the tile for which to determine the bounds.
    
    effectiveZoom - The zoom level to take into account.
    
    Returns:
    
    The area in component coordinates taken up by the specified tile.
  - getTileBounds
```
protected final Rectangle getTileBounds(TileProvider tileProvider,
                                        int x,
                                        int y,
                                        int effectiveZoom)
```
    Get the bounds of a tile in component coordinates, taking a specific zoom level into account and for a specific tile provider.
    
    Parameters:
    
    x - The X coordinate of the tile for which to determine the bounds.
    
    y - The X coordinate of the tile for which to determine the bounds.
    
    effectiveZoom - The zoom level to take into account.
    
    Returns:
    
    The area in component coordinates taken up by the specified tile.
    
    Throws:
    
    UnknownTileProviderException - If the specified tile provider is not configured on this image viewer.
  - getTileBounds
```
protected final Rectangle getTileBounds(int x,
                                        int y,
                                        int width,
                                        int height,
                                        int effectiveZoom)
```
    Get the bounds of a rectangular area of tiles in component coordinates, taking a specific zoom level into account. This version does not take tile-provider-specific offsets into account.
    
    Parameters:
    
    x - The X coordinate of the top left tile of the area for which to determine the bounds.
    
    y - The X coordinate of the top left tile of the area for which to determine the bounds.
    
    width - The width in tiles of the area for which to determine the bounds.
    
    height - The height in tiles of the area for which to determine the bounds.
    
    effectiveZoom - The zoom level to take into account.
    
    Returns:
    
    The area in component coordinates taken up by the specified rectangle of tiles.
  - getTileBounds
```
protected final Rectangle getTileBounds(TileProvider tileProvider,
                                        int x,
                                        int y,
                                        int width,
                                        int height,
                                        int effectiveZoom)
```
    Get the bounds of a rectangular area of tiles in component coordinates, taking a specific zoom level into account and for a specific tile provider.
    
    Parameters:
    
    x - The X coordinate of the top left tile of the area for which to determine the bounds.
    
    y - The X coordinate of the top left tile of the area for which to determine the bounds.
    
    width - The width in tiles of the area for which to determine the bounds.
    
    height - The height in tiles of the area for which to determine the bounds.
    
    effectiveZoom - The zoom level to take into account.
    
    Returns:
    
    The area in component coordinates taken up by the specified rectangle of tiles.
    
    Throws:
    
    UnknownTileProviderException - If the specified tile provider is not configured on this image viewer.
  - transformGraphics
```
protected final float transformGraphics(Graphics2D g2)
```
    Apply translation and scaling to a graphics canvas according to the current location and zoom settings such that it can be painted using image coordinates.
    
    Parameters:
    
    g2 - The graphics canvas to which to apply the transforms.
    
    Returns:
    
    The scaling factor to apply to image coordinates to account for the zoom level.
  - paintComponent
```
protected void paintComponent(Graphics g)
```
    Overrides:
    
    paintComponent in class JComponent
  - componentResized
```
public void componentResized(ComponentEvent e)
```
    Specified by:
    
    componentResized in interface ComponentListener
  - componentShown
```
public void componentShown(ComponentEvent e)
```
    Specified by:
    
    componentShown in interface ComponentListener
  - componentMoved
```
public void componentMoved(ComponentEvent e)
```
    Specified by:
    
    componentMoved in interface ComponentListener
  - componentHidden
```
public void componentHidden(ComponentEvent e)
```
    Specified by:
    
    componentHidden in interface ComponentListener
  - tileChanged
```
public void tileChanged(TileProvider source,
                        int x,
                        int y)
```
    Description copied from interface: TileListener
    
    Invoked when the contents of a tile have changed and the tile should be retrieved again.
    
    Specified by:
    
    tileChanged in interface TileListener
    
    Parameters:
    
    source - The tile provider from which the changed tile should be retrieved.
    
    x - The X coordinate (in tiles) of the changed tile.
    
    y - The Y coordinate (in tiles) of the changed tile.
  - tilesChanged
```
public void tilesChanged(TileProvider source,
                         Set<Point> tiles)
```
    Description copied from interface: TileListener
    
    Invoked when the contents of one or more tiles have changed and the tile(s) should be retrieved again.
    
    Specified by:
    
    tilesChanged in interface TileListener
    
    Parameters:
    
    source - The tile provider from which the changed tile(s) should be retrieved.
    
    tiles - The set of coordinates of the changed tile(s).
  - mousePressed
```
public void mousePressed(MouseEvent e)
```
    Specified by:
    
    mousePressed in interface MouseListener
  - mouseReleased
```
public void mouseReleased(MouseEvent e)
```
    Specified by:
    
    mouseReleased in interface MouseListener
  - 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
  - mouseDragged
```
public void mouseDragged(MouseEvent e)
```
    Specified by:
    
    mouseDragged in interface MouseMotionListener
  - mouseMoved
```
public void mouseMoved(MouseEvent e)
```
    Specified by:
    
    mouseMoved in interface MouseMotionListener
  - hierarchyChanged
```
public void hierarchyChanged(HierarchyEvent event)
```
    Specified by:
    
    hierarchyChanged in interface HierarchyListener

Class TiledImageViewer

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

viewX

viewY

previousX

previousY

markerX

markerY

xOffset

yOffset

TILE_SIZE

TILE_SIZE_BITS

TILE_SIZE_MASK

ADVANCED_SETTING_MAX_TILE_RENDER_THREADS

Constructor Detail

TiledImageViewer

TiledImageViewer

Method Detail

getTileProviders

addTileProvider

getTileProviderCount

setTileProvider

setTileProvider

replaceTileProvider

replaceTileProvider

removeTileProvider

removeTileProvider

removeAllTileProviders

addTileProvider

getViewX

getViewY

getExtent

getViewLocation

getZoom

setZoom

setZoom

resetZoom

getMarkerCoords

setMarkerCoords

isPaintGrid

setPaintGrid

getGridSize

setGridSize

moveTo

moveTo

moveToMarker

moveToOrigin

moveBy

refresh

refresh

refresh

refresh

reset

worldToView

worldToView

viewToWorld

viewToWorld

viewToWorld

viewToWorld

viewToWorld

viewToWorld

viewToWorld

worldToView

worldToView

worldToView

worldToView