Tile (Geotools modules 20-SNAPSHOT API)

Object
- Tile

All Implemented Interfaces:

ImageLoader

Direct Known Subclasses:

BingTile, OSMTile
```
public abstract class Tile
extends Object
implements ImageLoader
```
At tile represents a single space on the map within a specific ReferencedEnvelope. It holds a RenderExecutorComposite for fetching its image, and an SWTImage (which is disposed at various times). It listens to events for when to fetch, dispose, and construct new images. From

Since:

12

Author:

GDavis, Ugo Taddei

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Tile.ContextState` These states represent the state of the context.
`static class`	`Tile.RenderState` These are the states of the tile.
`static class`	`Tile.ScreenState` These states represent if the tile is on or off screen.
`static class`	`Tile.ValidatedState` These states represent if the tile has been validated in response to a user event.

Field Summary

Fields
Modifier and Type Field and Description

protected static Logger LOGGER

Fields
Modifier and Type	Field and Description
`protected static Logger`	`LOGGER`

Constructor Summary

Constructors
Constructor and Description

Tile(TileIdentifier tileId, ReferencedEnvelope env, int tileSize)
for locking on the SWT image to prevent creating it multiple times

Constructors
Constructor and Description
`Tile(TileIdentifier tileId, ReferencedEnvelope env, int tileSize)` for locking on the SWT image to prevent creating it multiple times

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected BufferedImage`	`createErrorImage(String message)` Gets an image showing an error, possibly indicating a failure to load the tile image.
`void`	`dispose()` Disposes of the tile.
`boolean`	`equals(Object other)`
`BufferedImage`	`getBufferedImage()`
`Tile.ContextState`	`getContextState()` This function returns the state of the tile render stack.
`ReferencedEnvelope`	`getExtent()`
`String`	`getId()` Diese Methode wird verwendet um...
`Tile.RenderState`	`getRenderState()` Gets the state of the tiled image.
`Tile.ScreenState`	`getScreenState()` Sets if the tile is on screen or not.
`TileIdentifier`	`getTileIdentifier()` Diese Methode wird verwendet um...
`int`	`getTileSize()`
`Tile.ValidatedState`	`getTileState()` Gets the validation state.
`abstract URL`	`getUrl()`
`int`	`hashCode()`
`BufferedImage`	`loadImageTileImage(Tile tile)` Loads an image for the given tile.
`void`	`setContextState(Tile.ContextState newState)` Sets the state of the tile rendering stack.
`void`	`setImageLoader(ImageLoader imageLoader)`
`void`	`setRenderState(Tile.RenderState newState)` Sets the state of the tiles image.
`void`	`setScreenState(Tile.ScreenState newState)` Sets the screen state.
`void`	`setStateChangedListener(TileStateChangedListener listener)`
`void`	`setTileState(Tile.ValidatedState newState)` Sets the validation state.
`String`	`toString()`

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOGGER
```
protected static final Logger LOGGER
```
- Constructor Detail
  - Tile
```
public Tile(TileIdentifier tileId,
            ReferencedEnvelope env,
            int tileSize)
```
    for locking on the SWT image to prevent creating it multiple times
- Method Detail
  - setImageLoader
```
public void setImageLoader(ImageLoader imageLoader)
```
  - setStateChangedListener
```
public void setStateChangedListener(TileStateChangedListener listener)
```
  - dispose
```
public void dispose()
```
    Disposes of the tile.
  - getBufferedImage
```
public BufferedImage getBufferedImage()
```
  - loadImageTileImage
```
public BufferedImage loadImageTileImage(Tile tile)
                                 throws IOException
```
    Description copied from interface: ImageLoader
    
    Loads an image for the given tile.
    
    Specified by:
    
    loadImageTileImage in interface ImageLoader
    
    Returns:
    
    an image
    
    Throws:
    
    IOException
  - createErrorImage
```
protected BufferedImage createErrorImage(String message)
```
    Gets an image showing an error, possibly indicating a failure to load the tile image.
    
    Returns:
  - getTileSize
```
public int getTileSize()
```
    Returns:
    
    The size of the tile in pixels.
  - getExtent
```
public ReferencedEnvelope getExtent()
```
    Returns:
    
    the bounds of the tile
  - setRenderState
```
public void setRenderState(Tile.RenderState newState)
```
    Sets the state of the tiles image.
    See getRenderState() for a description of the valid states.
    
    Parameters:
    
    newState -
  - getRenderState
```
public Tile.RenderState getRenderState()
```
    Gets the state of the tiled image.
    One Of:
    - RenderState.NEW - a new tile that needs to be rendered
    - RenderState.Renderer - the tile has been rendered or is in the state of being rendered
    - RenderState.Invalid - something has changed and the tile's rendered image is not longer valid and needs to be re-rendered
    Returns:
  - getContextState
```
public Tile.ContextState getContextState()
```
    This function returns the state of the tile render stack. If the context is invalid then the context needs to be updated before the tile is rendered.
    Should be one of:
    - INVALID - The context needs to be updated.
    - OKAY - The context is okay and does not need updating.
    Returns:
    
    the state of the tiles rendering stack
  - setContextState
```
public void setContextState(Tile.ContextState newState)
```
    Sets the state of the tile rendering stack.
    See getContextState() for valid value descriptions.
    
    Parameters:
    
    newState -
  - getScreenState
```
public Tile.ScreenState getScreenState()
```
    Sets if the tile is on screen or not.
    This is used with other information to determine if a tile can be disposed of. Valid values include:
    - ONSCREEN - the tile has been requested by the viewport therefore we assume it is on screen
    - OFFSCREEN - this tile was not requested by the viewport
    Returns:
  - setScreenState
```
public void setScreenState(Tile.ScreenState newState)
```
    Sets the screen state.
    See getScreenState() for a description of the valid values.
    
    Parameters:
    
    newState -
  - getTileState
```
public Tile.ValidatedState getTileState()
```
    Gets the validation state.
    This is used in conjunction with the screen state to determine it a tile can be disposed of. This state is set during a refresh event that is triggered from some gui event. Valid values include:
    - VALIDATED - The tile is validated and ready to be used for painting on the screen. Don't remove this tile.
    - OLD - This tile is an old tile that if off screen can be removed.
    Returns:
  - setTileState
```
public void setTileState(Tile.ValidatedState newState)
```
    Sets the validation state.
    See getTileState() for a description of valid values.
    
    Parameters:
    
    newState -
  - getId
```
public String getId()
```
    Diese Methode wird verwendet um... TODO.
    
    Returns:
  - getTileIdentifier
```
public TileIdentifier getTileIdentifier()
```
    Diese Methode wird verwendet um... TODO.
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getUrl
```
public abstract URL getUrl()
```

Class Tile

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

LOGGER

Constructor Detail

Tile

Method Detail

setImageLoader

setStateChangedListener

dispose

getBufferedImage

loadImageTileImage

createErrorImage

getTileSize

getExtent

setRenderState

getRenderState

getContextState

setContextState

getScreenState

setScreenState

getTileState

setTileState

getId

getTileIdentifier

hashCode

equals

toString

getUrl