ScalablePicture (All javadoc for netcdf-java version 4.6.22-SNAPSHOT)

java.lang.Object
- ucar.nc2.ui.image.ScalablePicture

All Implemented Interfaces:

SourcePictureListener
```
public class ScalablePicture
extends java.lang.Object
implements SourcePictureListener
```
a class to load and scale an image either immediately or in a seperate thread.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ERROR` status code used to signal that there was an error
`static int`	`GARBAGE_COLLECTION` status code used to signal that the picture is cleaning up memory
`java.net.URL`	`imageUrl` the URL of the picture
`float`	`jpgQuality` the quality with which the JPG pictures shall be written.
`static int`	`LOADED` status code used to signal that the thread has finished loading the image
`static int`	`LOADING` status code used to signal that the thread is loading the image
`static int`	`READY` status code used to signal that the image is available.
`boolean`	`scaleAfterLoad` flag that indicates that the image should be scaled after a status message is received from the SourcePicture that the picture was loaded.
`java.awt.image.BufferedImage`	`scaledPicture` The scaled version of the image
`static int`	`SCALING` status code used to signal that the thread has loaded the tread is scaling the image
`SourcePicture`	`sourcePicture` the source picture for the scalable picture
`static int`	`UNINITIALISED` status code used to signal that the picture is not loaded

Constructor Summary

Constructors
Constructor and Description

ScalablePicture()
Constructor

Constructors
Constructor and Description
`ScalablePicture()` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStatusListener(ScalablePictureListener listener)` method to register the listening object of the status events
`void`	`createScaledPictureInThread(int priority)` method that creates the scaled image in the background in it's own thread.
`java.lang.String`	`getFilename()` return the filename of the original image
`int`	`getOriginalHeight()` return the height of the original image or Zero if there is none
`java.awt.image.BufferedImage`	`getOriginalImage()` return the image in the original size
`java.awt.Dimension`	`getOriginalSize()` return the size of the original image or Zero if there is none
`int`	`getOriginalWidth()` return the width of the original image or Zero if there is none
`int`	`getScaledHeight()` return the height of the scaled image or Zero if there is none
`java.awt.image.BufferedImage`	`getScaledPicture()` return the scaled image
`java.awt.Dimension`	`getScaledSize()` return the size of the scaled image or Zero if there is none
`java.lang.String`	`getScaledSizeString()` return the size of the scaled image as a neatly formatted text or Zero if there is none
`int`	`getScaledWidth()` return the width of the scaled image or Zero if there is none
`double`	`getScaleFactor()` return the current scale factor
`java.awt.Dimension`	`getScaleSize()` return the current scale size.
`SourcePicture`	`getSourcePicture()` return the image in the original size
`int`	`getStatusCode()` Method that returns the status code of the picture loading.
`java.lang.String`	`getStatusMessage()` Method that returns the status code of the picture loading.
`void`	`loadAndScalePictureInThread(java.net.URL imageUrl, int priority, double rotation)` method to invoke with a filename or URL of a picture that is to be loaded and scaled in a new thread.
`void`	`loadPictureImd(java.net.URL imageUrl, double rotation)` Synchroneous method to load the image.
`void`	`removeStatusListener(ScalablePictureListener listener)` method to register the listening object of the status events
`void`	`scalePicture()`
`void`	`setJpgQuality(float quality)` accessor method to set the quality that should be used on jpg write operations.
`void`	`setScaleFactor(double newFactor)` set the scale factor to the new desired value.
`void`	`setScaleSize(java.awt.Dimension newSize)` invoke this method to tell the scale process to figure out the scal factor so that the image fits either by height or by width into the indicated dimension.
`SourcePicture`	`setSourcePicture(SourcePicture source)`
`void`	`sourceLoadProgressNotification(int statusCode, int percentage)` pass on the update on the loading Progress to the listening objects
`void`	`sourceStatusChange(int statusCode, java.lang.String statusMessage, SourcePicture sp)` method that is invoked by the SourcePictureListener interface.
`void`	`stopLoadingExcept(java.net.URL url)` stops all picture loading except if the Url we desire is being loaded
`static void`	`writeJpg(java.io.File writeFile, java.awt.image.RenderedImage renderedImage, float jpgQuality)` This static method writes the indicated renderedImage (BufferedImage) to the indicated file.
`void`	`writeScaledJpg(java.io.File writeFile)` This method allows the ScalablePicture's scaled BufferedImage to be written to the desired file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sourcePicture
```
public SourcePicture sourcePicture
```
    the source picture for the scalable picture
  - scaledPicture
```
public java.awt.image.BufferedImage scaledPicture
```
    The scaled version of the image
  - imageUrl
```
public java.net.URL imageUrl
```
    the URL of the picture
  - UNINITIALISED
```
public static final int UNINITIALISED
```
    status code used to signal that the picture is not loaded
    
    See Also:
    
    Constant Field Values
  - GARBAGE_COLLECTION
```
public static final int GARBAGE_COLLECTION
```
    status code used to signal that the picture is cleaning up memory
    
    See Also:
    
    Constant Field Values
  - LOADING
```
public static final int LOADING
```
    status code used to signal that the thread is loading the image
    
    See Also:
    
    Constant Field Values
  - LOADED
```
public static final int LOADED
```
    status code used to signal that the thread has finished loading the image
    
    See Also:
    
    Constant Field Values
  - SCALING
```
public static final int SCALING
```
    status code used to signal that the thread has loaded the tread is scaling the image
    
    See Also:
    
    Constant Field Values
  - READY
```
public static final int READY
```
    status code used to signal that the image is available.
    
    See Also:
    
    Constant Field Values
  - ERROR
```
public static final int ERROR
```
    status code used to signal that there was an error
    
    See Also:
    
    Constant Field Values
  - jpgQuality
```
public float jpgQuality
```
    the quality with which the JPG pictures shall be written. 0 means poor 1 means great.
  - scaleAfterLoad
```
public boolean scaleAfterLoad
```
    flag that indicates that the image should be scaled after a status message is received from the SourcePicture that the picture was loaded.
- Constructor Detail
  - ScalablePicture
```
public ScalablePicture()
```
    Constructor
- Method Detail
  - loadAndScalePictureInThread
```
public void loadAndScalePictureInThread(java.net.URL imageUrl,
                                        int priority,
                                        double rotation)
```
    method to invoke with a filename or URL of a picture that is to be loaded and scaled in a new thread. This is handy to update the screen while the loading chuggs along in the background. Make sure you invoked setScaleFactor or setScaleSize before invoking this method.
    Step 1: Am I already loading what I need somewhere? If yes -> use it. Has it finished loading? If no -> wait for it If yes -> use it Else -> load it
    
    Parameters:
    
    priority - The Thread priority
    
    imageUrl - The URL of the image you want to load
    
    rotation - The rotation 0-360 that the image should be put through after loading.
  - loadPictureImd
```
public void loadPictureImd(java.net.URL imageUrl,
                           double rotation)
```
    Synchroneous method to load the image. It should only be called by something which is a thread itself such as the HtmlDistillerThread. Since this intended for large batch operations this bypasses the cache.
    
    Parameters:
    
    imageUrl - The Url of the image to be loaded
    
    rotation - The angle by which it is to be roated upon loading.
  - stopLoadingExcept
```
public void stopLoadingExcept(java.net.URL url)
```
    stops all picture loading except if the Url we desire is being loaded
    
    Parameters:
    
    url - The URL of the image which is to be loaded.
  - sourceStatusChange
```
public void sourceStatusChange(int statusCode,
                               java.lang.String statusMessage,
                               SourcePicture sp)
```
    method that is invoked by the SourcePictureListener interface. Usually this will be called by the SourcePicture telling the ScalablePicture that it has completed loading. The ScalablePicture should then change it's own status and tell the ScalableListeners what's up.
    
    Specified by:
    
    sourceStatusChange in interface SourcePictureListener
  - sourceLoadProgressNotification
```
public void sourceLoadProgressNotification(int statusCode,
                                           int percentage)
```
    pass on the update on the loading Progress to the listening objects
    
    Specified by:
    
    sourceLoadProgressNotification in interface SourcePictureListener
  - createScaledPictureInThread
```
public void createScaledPictureInThread(int priority)
```
    method that creates the scaled image in the background in it's own thread.
    
    Parameters:
    
    priority - The priority this image takes relative to the others.
  - scalePicture
```
public void scalePicture()
```
  - setScaleFactor
```
public void setScaleFactor(double newFactor)
```
    set the scale factor to the new desired value. The scale factor is a multiplier by which the original picture needs to be multiplied to get the size of the picture on the screen. You must call createScaledPictureInThread(int) to make anything happen.
    
    Example: Original is 3000 x 2000 --> Scale Factor 0.10 --> Target Picutre is 300 x 200
  - setScaleSize
```
public void setScaleSize(java.awt.Dimension newSize)
```
    invoke this method to tell the scale process to figure out the scal factor so that the image fits either by height or by width into the indicated dimension.
  - getScaleFactor
```
public double getScaleFactor()
```
    return the current scale factor
  - getScaleSize
```
public java.awt.Dimension getScaleSize()
```
    return the current scale size. This is the area that the picture ist fitted into. Since the are could be wider or taller than the picture will be scaled to there is a different mehtod getScaledSize that will return the size of the picture.
  - getScaledPicture
```
public java.awt.image.BufferedImage getScaledPicture()
```
    return the scaled image
  - getScaledSize
```
public java.awt.Dimension getScaledSize()
```
    return the size of the scaled image or Zero if there is none
  - getScaledSizeString
```
public java.lang.String getScaledSizeString()
```
    return the size of the scaled image as a neatly formatted text or Zero if there is none
  - getScaledHeight
```
public int getScaledHeight()
```
    return the height of the scaled image or Zero if there is none
  - getScaledWidth
```
public int getScaledWidth()
```
    return the width of the scaled image or Zero if there is none
  - getOriginalImage
```
public java.awt.image.BufferedImage getOriginalImage()
```
    return the image in the original size
  - getSourcePicture
```
public SourcePicture getSourcePicture()
```
    return the image in the original size
  - setSourcePicture
```
public SourcePicture setSourcePicture(SourcePicture source)
```
  - getOriginalSize
```
public java.awt.Dimension getOriginalSize()
```
    return the size of the original image or Zero if there is none
  - getOriginalHeight
```
public int getOriginalHeight()
```
    return the height of the original image or Zero if there is none
  - getOriginalWidth
```
public int getOriginalWidth()
```
    return the width of the original image or Zero if there is none
  - getFilename
```
public java.lang.String getFilename()
```
    return the filename of the original image
  - writeScaledJpg
```
public void writeScaledJpg(java.io.File writeFile)
```
    This method allows the ScalablePicture's scaled BufferedImage to be written to the desired file.
    
    Parameters:
    
    writeFile - The File that shall receive the jpg data
  - writeJpg
```
public static void writeJpg(java.io.File writeFile,
                            java.awt.image.RenderedImage renderedImage,
                            float jpgQuality)
```
    This static method writes the indicated renderedImage (BufferedImage) to the indicated file.
    
    Parameters:
    
    writeFile - The File that shall receive the jpg data
    
    renderedImage - The RenderedImage (BufferedImage) to be written
    
    jpgQuality - The quality with which to compress to jpg
  - addStatusListener
```
public void addStatusListener(ScalablePictureListener listener)
```
    method to register the listening object of the status events
  - removeStatusListener
```
public void removeStatusListener(ScalablePictureListener listener)
```
    method to register the listening object of the status events
  - getStatusCode
```
public int getStatusCode()
```
    Method that returns the status code of the picture loading.
  - getStatusMessage
```
public java.lang.String getStatusMessage()
```
    Method that returns the status code of the picture loading.
  - setJpgQuality
```
public void setJpgQuality(float quality)
```
    accessor method to set the quality that should be used on jpg write operations.

Class ScalablePicture

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sourcePicture

scaledPicture

imageUrl

UNINITIALISED

GARBAGE_COLLECTION

LOADING

LOADED

SCALING

READY

ERROR

jpgQuality

scaleAfterLoad

Constructor Detail

ScalablePicture

Method Detail

loadAndScalePictureInThread

loadPictureImd

stopLoadingExcept

sourceStatusChange

sourceLoadProgressNotification

createScaledPictureInThread

scalePicture

setScaleFactor

setScaleSize

getScaleFactor

getScaleSize

getScaledPicture

getScaledSize

getScaledSizeString

getScaledHeight

getScaledWidth

getOriginalImage

getSourcePicture

setSourcePicture

getOriginalSize

getOriginalHeight

getOriginalWidth

getFilename

writeScaledJpg

writeJpg

addStatusListener

removeStatusListener

getStatusCode

getStatusMessage

setJpgQuality