DeferRable (Apache Batik Javadoc)

java.lang.Object
- org.apache.batik.ext.awt.image.renderable.DeferRable

All Implemented Interfaces:

java.awt.image.renderable.RenderableImage, Filter
```
public class DeferRable
extends java.lang.Object
implements Filter
```
This class allows for the return of a proxy object quickly, while a heavy weight object is constrcuted in a background Thread. This proxy object will then block if any methods are called on it that require talking to the source object. This is actually a particular instance of a very general pattern this is probably best represented using the Proxy class in the Reflection APIs.

Field Summary
- Fields inherited from interface java.awt.image.renderable.RenderableImage
  HINTS_OBSERVED

Constructor Summary

Constructors
Constructor and Description

DeferRable()
Constructor takes nothing

Constructors
Constructor and Description
`DeferRable()` Constructor takes nothing

Method Summary

Methods
Modifier and Type	Method and Description
`java.awt.image.RenderedImage`	`createDefaultRendering()` Forward the call (blocking until source is set if need be).
`java.awt.image.RenderedImage`	`createRendering(java.awt.image.renderable.RenderContext rc)` Forward the call (blocking until source is set if need be).
`java.awt.image.RenderedImage`	`createScaledRendering(int w, int h, java.awt.RenderingHints hints)` Forward the call (blocking until source is set if need be).
`java.awt.geom.Rectangle2D`	`getBounds2D()` Implement the baseclass method to call getSource() so it will block until we have a real source.
`java.awt.Shape`	`getDependencyRegion(int srcIndex, java.awt.geom.Rectangle2D outputRgn)` Forward the call (blocking until source is set if need be).
`java.awt.Shape`	`getDirtyRegion(int srcIndex, java.awt.geom.Rectangle2D inputRgn)` Forward the call (blocking until source is set if need be).
`float`	`getHeight()`
`float`	`getMinX()`
`float`	`getMinY()`
`java.lang.Object`	`getProperty(java.lang.String name)` Forward the call (blocking until source is set if need be).
`java.lang.String[]`	`getPropertyNames()` Forward the call (blocking until source is set if need be).
`Filter`	`getSource()` Key method that blocks if the src has not yet been provided.
`java.util.Vector`	`getSources()`
`long`	`getTimeStamp()` Returns the current modification timestamp on this Renderable node.
`float`	`getWidth()`
`boolean`	`isDynamic()` Forward the call (blocking until source is set if need be).
`void`	`setBounds(java.awt.geom.Rectangle2D bounds)`
`void`	`setProperties(java.util.Map props)`
`void`	`setSource(Filter src)` Key method that sets the src.

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

- Constructor Detail
  - DeferRable
```
public DeferRable()
```
    Constructor takes nothing
- Method Detail
  - getSource
```
public Filter getSource()
```
    Key method that blocks if the src has not yet been provided.
  - setSource
```
public void setSource(Filter src)
```
    Key method that sets the src. The source can only be set once (this makes sense given the intent of the class is to stand in for a real object, so swaping that object isn't a good idea. This will wake all the threads that might be waiting for the source to be set.
  - setBounds
```
public void setBounds(java.awt.geom.Rectangle2D bounds)
```
  - setProperties
```
public void setProperties(java.util.Map props)
```
  - getTimeStamp
```
public long getTimeStamp()
```
    Description copied from interface: Filter
    
    Returns the current modification timestamp on this Renderable node. This value will change whenever cached output data becomes invalid.
    
    Specified by:
    
    getTimeStamp in interface Filter
    
    Returns:
    Current modification timestamp value.
  - getSources
```
public java.util.Vector getSources()
```
    Specified by:
    
    getSources in interface java.awt.image.renderable.RenderableImage
  - isDynamic
```
public boolean isDynamic()
```
    Forward the call (blocking until source is set if need be).
    
    Specified by:
    
    isDynamic in interface java.awt.image.renderable.RenderableImage
  - getBounds2D
```
public java.awt.geom.Rectangle2D getBounds2D()
```
    Implement the baseclass method to call getSource() so it will block until we have a real source.
    
    Specified by:
    
    getBounds2D in interface Filter
  - getMinX
```
public float getMinX()
```
    Specified by:
    
    getMinX in interface java.awt.image.renderable.RenderableImage
  - getMinY
```
public float getMinY()
```
    Specified by:
    
    getMinY in interface java.awt.image.renderable.RenderableImage
  - getWidth
```
public float getWidth()
```
    Specified by:
    
    getWidth in interface java.awt.image.renderable.RenderableImage
  - getHeight
```
public float getHeight()
```
    Specified by:
    
    getHeight in interface java.awt.image.renderable.RenderableImage
  - getProperty
```
public java.lang.Object getProperty(java.lang.String name)
```
    Forward the call (blocking until source is set if need be).
    
    Specified by:
    
    getProperty in interface java.awt.image.renderable.RenderableImage
  - getPropertyNames
```
public java.lang.String[] getPropertyNames()
```
    Forward the call (blocking until source is set if need be).
    
    Specified by:
    
    getPropertyNames in interface java.awt.image.renderable.RenderableImage
  - createDefaultRendering
```
public java.awt.image.RenderedImage createDefaultRendering()
```
    Forward the call (blocking until source is set if need be).
    
    Specified by:
    
    createDefaultRendering in interface java.awt.image.renderable.RenderableImage
  - createScaledRendering
```
public java.awt.image.RenderedImage createScaledRendering(int w,
                                                 int h,
                                                 java.awt.RenderingHints hints)
```
    Forward the call (blocking until source is set if need be).
    
    Specified by:
    
    createScaledRendering in interface java.awt.image.renderable.RenderableImage
  - createRendering
```
public java.awt.image.RenderedImage createRendering(java.awt.image.renderable.RenderContext rc)
```
    Forward the call (blocking until source is set if need be).
    
    Specified by:
    
    createRendering in interface java.awt.image.renderable.RenderableImage
  - getDependencyRegion
```
public java.awt.Shape getDependencyRegion(int srcIndex,
                                 java.awt.geom.Rectangle2D outputRgn)
```
    Forward the call (blocking until source is set if need be).
    
    Specified by:
    
    getDependencyRegion in interface Filter
    
    Parameters:
    srcIndex - The source to do the dependency calculation for.
    outputRgn - The region of output you are interested in generating dependencies for. The is given in the user coordiate system for this node.
    
    Returns:
    The region of input required. This is in the user coordinate system for the source indicated by srcIndex.
  - getDirtyRegion
```
public java.awt.Shape getDirtyRegion(int srcIndex,
                            java.awt.geom.Rectangle2D inputRgn)
```
    Forward the call (blocking until source is set if need be).
    
    Specified by:
    
    getDirtyRegion in interface Filter
    
    Parameters:
    srcIndex - The input that inputRgn reflects changes in.
    inputRgn - the region of input that has changed, used to calculate the returned shape. This is given in the user coordinate system of the source indicated by srcIndex.
    
    Returns:
    The region of output that would be invalid given a change to inputRgn of the source selected by srcIndex. this is in the user coordinate system of this node.

Class DeferRable

Field Summary

Fields inherited from interface java.awt.image.renderable.RenderableImage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DeferRable

Method Detail

getSource

setSource

setBounds

setProperties

getTimeStamp

getSources

isDynamic

getBounds2D

getMinX

getMinY

getWidth

getHeight

getProperty

getPropertyNames

createDefaultRendering

createScaledRendering

createRendering

getDependencyRegion

getDirtyRegion