Java Doc for RenderedImageList.java in » 6.0-JDK-Modules » Java-Advanced-Imaging » javax » media » jai » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » 6.0 JDK Modules » Java Advanced Imaging » javax.media.jai

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

javax.media.jai .CollectionImage

javax.media.jai .RenderedImageList

RenderedImageList

public class RenderedImageList extends CollectionImage implements List,RenderedImage,Serializable(Code)

A CollectionImage which is also a RenderedImage. The underlying Collection in this case is required to be a List containing only RenderedImages.

Instances of this class may be returned from either a RenderedImageFactory or from a CollectionImageFactory. This class would be particularly useful for implementing operations the result of which includes a single primary image and one or more secondary or dependant images the data of which are less likely to be requested.

Invocations of RenderedImage methods on an instance of this class will be forwarded to the first RenderedImage in the underlying List, i.e., the image at index zero. This should be the index assigned to the primary image in the case alluded to above. If there are no images in the List when a RenderedImage method is invoked an IllegalStateException will be thrown.

One example of the use of this class is in generating a classmap image using a classification algorithm. A by-product image of such an operation is often an error image wherein the value of each pixel is some measure of the classification error at that pixel. In this case the classmap image would be stored at index zero in the internal list and the error image at the unity index. The error image would be an OpImage that has the classmap image as its source. The result is that a reference to the error image is always available with the classmap image but the computation of the error image pixel values may be deferred until such time as the data are needed, if ever.

Methods defined in the RenderedImage and List interfaces are not all commented in detail. The List methods merely forward the call in most cases directly to the underlying List; as previously stated, RenderedImage method invocations are forwarded to the RenderedImage at position zero in the List.
since:
   JAI 1.1
See Also:   CollectionImage
See Also:   java.awt.image.RenderedImage
See Also:   java.util.List

Constructor Summary
protected	RenderedImageList() Creates an empty `RenderedImageList`.
public	RenderedImageList(List renderedImageList) Creates a `RenderedImageList` from the supplied `List`. `IllegalArgumentException` if any objects in the`List` are not `RenderedImage`s.

Method Summary
public void	add(int index, Object element) Inserts the specified element at the specified position in this list. throws: IllegalArgumentException - if the specified elementis not a `RenderedImage`. throws: IndexOutOfBoundsException - if the index is out of range(index < 0 \|\| index > size()).
public boolean	add(Object o) Adds the specified object to this `List`. throws: IllegalArgumentException - if `o` is `null`or is not an `RenderedImage`.
public boolean	addAll(int index, Collection c) Inserts into this `List` at the indicated position all elements in the specified `Collection` which are `RenderedImage`s.
public boolean	addAll(Collection c) Adds to this `List` all elements in the specified `Collection` which are `RenderedImage`s.
public WritableRaster	copyData(WritableRaster dest) Copies an arbitrary rectangular region of the primary image into a caller-supplied WritableRaster.
public Object	get(int index) the `RenderedImage` object at thespecified index. Parameters: index - index of element to return.
public ColorModel	getColorModel() Returns the ColorModel of the primary image.
public Raster	getData() Returns the entire primary image in a single `Raster`.
public Raster	getData(Rectangle bounds) Returns an arbitrary rectangular region of the primary image in a `Raster`.
public int	getHeight() Returns the height of the primary image.
public int	getMinTileX() Returns the horizontal index of the leftmost column of tiles of the primary image.
public int	getMinTileY() Returns the vertical index of the uppermost row of tiles of the primary image.
public int	getMinX() Returns the X coordinate of the leftmost column of the primary image.
public int	getMinY() Returns the X coordinate of the uppermost row of the primary image.
public int	getNumXTiles() Returns the number of tiles of the primary image along the tile grid in the horizontal direction.
public int	getNumYTiles() Returns the number of tiles of the primary image along the tile grid in the vertical direction.
public RenderedImage	getPrimaryImage() Returns the first image in the underlying list of `RenderedImage`s.
public Object	getProperty(String name) Gets a property from the property set of this image.
public String[]	getPropertyNames() Returns a list of the properties recognized by this image.
public SampleModel	getSampleModel() Returns the SampleModel of the primary image.
public Vector	getSources() Returns a `Vector` containing the image sources.
public Raster	getTile(int tileX, int tileY) Returns tile (`tileX`, `tileY`) of the primary image as a `Raster`.
public int	getTileGridXOffset() Returns the X coordinate of the upper-left pixel of tile (0, 0) of the primary image.
public int	getTileGridYOffset() Returns the Y coordinate of the upper-left pixel of tile (0, 0) of the primary image.
public int	getTileHeight() Returns the height of a tile of the primary image.
public int	getTileWidth() Returns the width of a tile of the primary image.
public int	getWidth() Returns the width of the primary image.
public int	indexOf(Object o)
public int	lastIndexOf(Object o)
public ListIterator	listIterator()
public ListIterator	listIterator(int index)
public Object	remove(int index)
public Object	set(int index, Object element)
public List	subList(int fromIndex, int toIndex)

Constructor Detail

RenderedImageList
protected RenderedImageList()(Code)
	Creates an empty `RenderedImageList`.

RenderedImageList
public RenderedImageList(List renderedImageList)(Code)
	Creates a `RenderedImageList` from the supplied `List`. `IllegalArgumentException` if any objects in the`List` are not `RenderedImage`s. `IllegalArgumentException` if the `List`is empty. `IllegalArgumentException` if the `List`parameter is `null`.

Method Detail

add
public void add(int index, Object element)(Code)
	Inserts the specified element at the specified position in this list. throws: IllegalArgumentException - if the specified elementis not a `RenderedImage`. throws: IndexOutOfBoundsException - if the index is out of range(index < 0 \|\| index > size()).

add
public boolean add(Object o)(Code)
	Adds the specified object to this `List`. throws: IllegalArgumentException - if `o` is `null`or is not an `RenderedImage`. `true` if and only if the parameter is added to the`List`.

addAll
public boolean addAll(int index, Collection c)(Code)
	Inserts into this `List` at the indicated position all elements in the specified `Collection` which are `RenderedImage`s. `true` if this `List` changedas a result of the call. throws: IndexOutOfBoundsException - if the index is out of range(index < 0 \|\| index > size()).

addAll
public boolean addAll(Collection c)(Code)
	Adds to this `List` all elements in the specified `Collection` which are `RenderedImage`s. `true` if this `List` changedas a result of the call.

copyData
public WritableRaster copyData(WritableRaster dest)(Code)
	Copies an arbitrary rectangular region of the primary image into a caller-supplied WritableRaster. The region to be computed is determined by clipping the bounds of the supplied WritableRaster against the bounds of the image. The supplied WritableRaster must have a SampleModel that is compatible with that of the image. If the raster argument is null, the entire image will be copied into a newly-created WritableRaster with a SampleModel that is compatible with that of the image. The call is forwarded to the first image in the `List`. Parameters: dest - a WritableRaster to hold the returned portion ofthe image. a reference to the supplied WritableRaster, or to a new WritableRaster if the supplied one was null.

get
public Object get(int index)(Code)
	the `RenderedImage` object at thespecified index. Parameters: index - index of element to return. the element at the specified position in this list. throws: IndexOutOfBoundsException - if the index is out of range (index< 0 \|\| index >= size()).

getColorModel
public ColorModel getColorModel()(Code)
	Returns the ColorModel of the primary image. The call is forwarded to the first image in the `List`.

getData
public Raster getData()(Code)
	Returns the entire primary image in a single `Raster`. For images with multiple tiles this will require making a copy. The returned `Raster` is semantically a copy. The call is forwarded to the first image in the `List`. a `Raster` containing a copy of this image's data.

getData
public Raster getData(Rectangle bounds)(Code)
	Returns an arbitrary rectangular region of the primary image in a `Raster`. The returned `Raster` is semantically a copy. The call is forwarded to the first image in the `List`. Parameters: bounds - the region of the `RenderedImage` to bereturned.

getHeight
public int getHeight()(Code)
	Returns the height of the primary image. The call is forwarded to the first image in the `List`.

getMinTileX
public int getMinTileX()(Code)
	Returns the horizontal index of the leftmost column of tiles of the primary image. The call is forwarded to the first image in the `List`.

getMinTileY
public int getMinTileY()(Code)
	Returns the vertical index of the uppermost row of tiles of the primary image. The call is forwarded to the first image in the `List`.

getMinX
public int getMinX()(Code)
	Returns the X coordinate of the leftmost column of the primary image. The call is forwarded to the first image in the `List`.

getMinY
public int getMinY()(Code)
	Returns the X coordinate of the uppermost row of the primary image. The call is forwarded to the first image in the `List`.

getNumXTiles
public int getNumXTiles()(Code)
	Returns the number of tiles of the primary image along the tile grid in the horizontal direction. The call is forwarded to the first image in the `List`.

getNumYTiles
public int getNumYTiles()(Code)
	Returns the number of tiles of the primary image along the tile grid in the vertical direction. The call is forwarded to the first image in the `List`.

getPrimaryImage
public RenderedImage getPrimaryImage()(Code)
	Returns the first image in the underlying list of `RenderedImage`s. The call is forwarded to the first image in the `List`.

getProperty
public Object getProperty(String name)(Code)
	Gets a property from the property set of this image. If the property name is not recognized, `java.awt.Image.UndefinedProperty` will be returned. The call is forwarded to the first image in the `List`. Parameters: name - the name of the property to get, as a`String`. a reference to the property`Object`, or the value`java.awt.Image.UndefinedProperty.` throws: IllegalArgumentException - if `name` is`null`.

getPropertyNames
public String[] getPropertyNames()(Code)
	Returns a list of the properties recognized by this image. If no properties are available, `null` will be returned. The call is forwarded to the first image in the `List`. an array of `String`s representing validproperty names.

getSampleModel
public SampleModel getSampleModel()(Code)
	Returns the SampleModel of the primary image. The call is forwarded to the first image in the `List`.

getSources
public Vector getSources()(Code)
	Returns a `Vector` containing the image sources. The call is forwarded to the first image in the `List`.

getTile
public Raster getTile(int tileX, int tileY)(Code)
	Returns tile (`tileX`, `tileY`) of the primary image as a `Raster`. Note that `tileX` and `tileY` are indices into the tile array, not pixel locations. The call is forwarded to the first image in the `List`. Parameters: tileX - The X index of the requested tile in the tile array. Parameters: tileY - The Y index of the requested tile in the tile array.

getTileGridXOffset
public int getTileGridXOffset()(Code)
	Returns the X coordinate of the upper-left pixel of tile (0, 0) of the primary image. The call is forwarded to the first image in the `List`.

getTileGridYOffset
public int getTileGridYOffset()(Code)
	Returns the Y coordinate of the upper-left pixel of tile (0, 0) of the primary image. The call is forwarded to the first image in the `List`.

getTileHeight
public int getTileHeight()(Code)
	Returns the height of a tile of the primary image. The call is forwarded to the first image in the `List`.

getTileWidth
public int getTileWidth()(Code)
	Returns the width of a tile of the primary image. The call is forwarded to the first image in the `List`.

getWidth
public int getWidth()(Code)
	Returns the width of the primary image. The call is forwarded to the first image in the `List`.

indexOf
public int indexOf(Object o)(Code)

lastIndexOf
public int lastIndexOf(Object o)(Code)

listIterator
public ListIterator listIterator()(Code)

listIterator
public ListIterator listIterator(int index)(Code)

remove
public Object remove(int index)(Code)

set
public Object set(int index, Object element)(Code)

subList
public List subList(int fromIndex, int toIndex)(Code)

Fields inherited from javax.media.jai.CollectionImage

protected PropertyChangeSupportJAI eventManager(Code)(Java Doc)
protected Collection imageCollection(Code)(Java Doc)
protected CollectionImageFactory imageFactory(Code)(Java Doc)
protected WritablePropertySourceImpl properties(Code)(Java Doc)
protected Set sinks(Code)(Java Doc)

Methods inherited from javax.media.jai.CollectionImage

public boolean add(Object o)(Code)(Java Doc)
public boolean addAll(Collection c)(Code)(Java Doc)
public void addPropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)(Code)(Java Doc)
public synchronized boolean addSink(Object sink)(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public boolean contains(Object o)(Code)(Java Doc)
public boolean containsAll(Collection c)(Code)(Java Doc)
public Object get(int index)(Code)(Java Doc)
public CollectionImageFactory getImageFactory()(Code)(Java Doc)
public Object getProperty(String name)(Code)(Java Doc)
public Object getProperty(String name, Collection collection)(Code)(Java Doc)
public Class getPropertyClass(String name)(Code)(Java Doc)
public String[] getPropertyNames()(Code)(Java Doc)
public String[] getPropertyNames(String prefix)(Code)(Java Doc)
public synchronized Set getSinks()(Code)(Java Doc)
public boolean isEmpty()(Code)(Java Doc)
public Iterator iterator()(Code)(Java Doc)
public boolean remove(Object o)(Code)(Java Doc)
public boolean removeAll(Collection c)(Code)(Java Doc)
public void removeProperty(String name)(Code)(Java Doc)
public void removePropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)(Code)(Java Doc)
public synchronized boolean removeSink(Object sink)(Code)(Java Doc)
public synchronized void removeSinks()(Code)(Java Doc)
public boolean retainAll(Collection c)(Code)(Java Doc)
public void setImageFactory(CollectionImageFactory imageFactory)(Code)(Java Doc)
public void setProperty(String name, Object value)(Code)(Java Doc)
public int size()(Code)(Java Doc)
public Object[] toArray()(Code)(Java Doc)
public Object[] toArray(Object[] a)(Code)(Java Doc)

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.