Java Doc for CollectionImage.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

All known Subclasses:   javax.media.jai .ImageSequence,  com.sun.media.jai.opimage .AddConstToCollectionOpImage,  javax.media.jai .RenderedImageList,  javax.media.jai .AttributedImageCollection,  javax.media.jai .ImageStack,  ca.forklabs.media.jai .SimpleCollectionImage,  com.sun.media.jai.imageioimpl .ImageIOCollectionImage,  javax.media.jai .CollectionOp,
CollectionImage
abstract public class CollectionImage implements ImageJAI,Collection(Code)
An abstract superclass for classes representing a Collection of images. It may be a Collection of RenderedImages or RenderableImages, a Collection of Collections that include images. In other words, this class supports nested Collections, but at the very bottom, there must be images associated with the Collection objects.

Field Summary
protected PropertyChangeSupportJAI eventManager
     A helper object to manage firing events.
protected Collection imageCollection
     A Collection of objects.
protected CollectionImageFactory imageFactory
     The CollectionImageFactory which created this CollectionImage; may be null which implies that the CollectionImage was not created by a CollectionImageFactory.
protected WritablePropertySourceImpl properties
     A helper object to manage the image properties.
protected Set sinks
     A Set of WeakReferences to the sinks of this CollectionImage.

Constructor Summary
protected CollectionImage()
     Default constructor.
public CollectionImage(Collection collection)
     Constructs a class that contains an image Collection.

Method Summary
public boolean add(Object o)
     Adds the specified object to this Collection.
public boolean addAll(Collection c)
     Adds all of the elements in the specified Collection to this Collection.
public void addPropertyChangeListener(PropertyChangeListener listener)
     Add a PropertyChangeListener to the listener list.
public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
     Add a PropertyChangeListener for a specific property.
public synchronized boolean addSink(Object sink)
     Adds a sink to the set of sinks.
public void clear()
     Removes all of the elements from this Collection.
public boolean contains(Object o)
     Returns true if this Collection contains the specified object.
public boolean containsAll(Collection c)
     Returns true if this Collection contains all of the elements in the specified Collection.
public Object get(int index)
     Returns the element at the given index in imageCollection. If imageCollection is a List then the call is forwarded to imageCollection; otherwise an array is created by applying toArray() to imageCollection and the indicated element of that array is returned.
public CollectionImageFactory getImageFactory()
     If this CollectionImage was created by a CollectionImageFactory then return a reference to that factory; otherwise return null.
public Object getProperty(String name)
     Returns the specified property.
public Object getProperty(String name, Collection collection)
     Returns the specified property.
public Class getPropertyClass(String name)
     Returns the class expected to be returned by a request for the property with the specified name.
public String[] getPropertyNames()
     Returns an array of Strings recognized as names by this property source.
public String[] getPropertyNames(String prefix)
     Returns an array of Strings recognized as names by this property source that begin with the supplied prefix.
public synchronized Set getSinks()
     Retrieves the set of sinks or null if there are none.
public boolean isEmpty()
     Returns true if this Collection contains no elements.
public Iterator iterator()
     Returns an Iterator over the elements in this Collection.
public boolean remove(Object o)
     Removes the specified object from this Collection.
public boolean removeAll(Collection c)
     Removes all this collection's elements that are also contained in the specified Collection.
public void removeProperty(String name)
     Removes the named property from the CollectionImage.
public void removePropertyChangeListener(PropertyChangeListener listener)
     Remove a PropertyChangeListener from the listener list.
public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
     Remove a PropertyChangeListener for a specific property.
public synchronized boolean removeSink(Object sink)
     Removes a sink from the set of sinks.
public synchronized void removeSinks()
     Removes all sinks from the set of sinks.
public boolean retainAll(Collection c)
     Retains only the elements in this Collection that are contained in the specified Collection.
public void setImageFactory(CollectionImageFactory imageFactory)
     Sets the imageFactory instance variable to the supplied value.
public void setProperty(String name, Object value)
     Sets a property on a CollectionImage.
public int size()
     Returns the number of elements in this Collection.
public Object[] toArray()
     Returns an array containing all of the elements in this Collection.
public Object[] toArray(Object[] a)
     Returns an array containing all of the elements in this collection whose runtime type is that of the specified array.

Field Detail
eventManager
protected PropertyChangeSupportJAI eventManager(Code)
A helper object to manage firing events.
since:
   JAI 1.1

imageCollection
protected Collection imageCollection(Code)
A Collection of objects. It may be a Collection of images of the same type, a Collection of objects of the same type, each containing an image, or a Collection of Collections whose leaf objects are images or objects that contain images.

imageFactory
protected CollectionImageFactory imageFactory(Code)
The CollectionImageFactory which created this CollectionImage; may be null which implies that the CollectionImage was not created by a CollectionImageFactory.
since:
   JAI 1.1

properties
protected WritablePropertySourceImpl properties(Code)
A helper object to manage the image properties.
since:
   JAI 1.1

sinks
protected Set sinks(Code)
A Set of WeakReferences to the sinks of this CollectionImage.
since:
   JAI 1.1

Constructor Detail
CollectionImage
protected CollectionImage()(Code)
Default constructor. The imageCollection parameter is null. Subclasses that use this constructor must either set the imageCollection parameter themselves, or override the methods defined in the Collection interface. Otherwise, a NullPointerException may be thrown at a later time when methods which use to the imageCollection instance variable are invoked.

CollectionImage
public CollectionImage(Collection collection)(Code)
Constructs a class that contains an image Collection.
Parameters:
  collection - A Collection of objects thatinclude images.
throws:
  IllegalArgumentException - if collection isnull.

Method Detail
add
public boolean add(Object o)(Code)
Adds the specified object to this Collection. true if and only if the parameter is added to theCollection.

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

addPropertyChangeListener
public void addPropertyChangeListener(PropertyChangeListener listener)(Code)
Add a PropertyChangeListener to the listener list. The listener is registered for all properties.
since:
   JAI 1.1

addPropertyChangeListener
public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)(Code)
Add a PropertyChangeListener for a specific property. The listener will be invoked only when a call on firePropertyChange names that specific property. The case of the name is ignored.
since:
   JAI 1.1

addSink
public synchronized boolean addSink(Object sink)(Code)
Adds a sink to the set of sinks.
since:
   JAI 1.1

clear
public void clear()(Code)
Removes all of the elements from this Collection.

contains
public boolean contains(Object o)(Code)
Returns true if this Collection contains the specified object.

containsAll
public boolean containsAll(Collection c)(Code)
Returns true if this Collection contains all of the elements in the specified Collection.

get
public Object get(int index)(Code)
Returns the element at the given index in imageCollection. If imageCollection is a List then the call is forwarded to imageCollection; otherwise an array is created by applying toArray() to imageCollection and the indicated element of that array is returned. Note that in the latter case no guarantee as to element ordering beyond that stated in the specification of Collection.toArray().
Parameters:
  index - The index of the desired element.
throws:
  IndexOutOfBoundsException - if the index is out of range(index < 0 || index ≥imageCollection.size()).
since:
   JAI 1.1

getImageFactory
public CollectionImageFactory getImageFactory()(Code)
If this CollectionImage was created by a CollectionImageFactory then return a reference to that factory; otherwise return null.
since:
   JAI 1.1

getProperty
public Object getProperty(String name)(Code)
Returns the specified property. The default implementation returns java.awt.Image.UndefinedProperty.
exception:
  IllegalArgumentException - if nameis null.

getProperty
public Object getProperty(String name, Collection collection)(Code)
Returns the specified property. The default implementation returns java.awt.Image.UndefinedProperty.
exception:
  IllegalArgumentException - if nameis null.

getPropertyClass
public Class getPropertyClass(String name)(Code)
Returns the class expected to be returned by a request for the property with the specified name. If this information is unavailable, null will be returned. The Class expected to be return by arequest for the value of this property or null.
exception:
  IllegalArgumentException - if nameis null.
since:
   JAI 1.1

getPropertyNames
public String[] getPropertyNames()(Code)
Returns an array of Strings recognized as names by this property source. If no property names match, null will be returned. An array of Strings which are the validproperty names or null if there are none.

getPropertyNames
public String[] getPropertyNames(String prefix)(Code)
Returns an array of Strings recognized as names by this property source that begin with the supplied prefix. If no property names are recognized, or no property names match, null will be returned. The comparison is done in a case-independent manner.
The default implementation calls getPropertyNames() and searches the list of names for matches. An array of Strings giving the validproperty names or null if there are none. IllegalArgumentException if prefixis null.

getSinks
public synchronized Set getSinks()(Code)
Retrieves the set of sinks or null if there are none.
since:
   JAI 1.1

isEmpty
public boolean isEmpty()(Code)
Returns true if this Collection contains no elements.

iterator
public Iterator iterator()(Code)
Returns an Iterator over the elements in this Collection.

remove
public boolean remove(Object o)(Code)
Removes the specified object from this Collection. true if and only if the parameter is removedfrom the Collection.

removeAll
public boolean removeAll(Collection c)(Code)
Removes all this collection's elements that are also contained in the specified Collection. true if this Collection changedas a result of the call.

removeProperty
public void removeProperty(String name)(Code)
Removes the named property from the CollectionImage. Some CollectionImage subclasses may ignore attempts to remove properties.
since:
   JAI 1.1

removePropertyChangeListener
public void removePropertyChangeListener(PropertyChangeListener listener)(Code)
Remove a PropertyChangeListener from the listener list. This removes a PropertyChangeListener that was registered for all properties.
since:
   JAI 1.1

removePropertyChangeListener
public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)(Code)
Remove a PropertyChangeListener for a specific property. The case of the name is ignored.
since:
   JAI 1.1

removeSink
public synchronized boolean removeSink(Object sink)(Code)
Removes a sink from the set of sinks. true if and only if the set of sinkschanged as a result of the call.
since:
   JAI 1.1

removeSinks
public synchronized void removeSinks()(Code)
Removes all sinks from the set of sinks.
since:
   JAI 1.1

retainAll
public boolean retainAll(Collection c)(Code)
Retains only the elements in this Collection that are contained in the specified Collection. true if this Collection changedas a result of the call.

setImageFactory
public void setImageFactory(CollectionImageFactory imageFactory)(Code)
Sets the imageFactory instance variable to the supplied value. The parameter may be null. It is recommended that this method be invoked as soon as the CollectionImage is constructed.
Parameters:
  imageFactory - The creating CollectionImageFactory ornull
throws:
  IllegalStateException - if the corresponding instance variablewas already set.
since:
   JAI 1.1

setProperty
public void setProperty(String name, Object value)(Code)
Sets a property on a CollectionImage. Some CollectionImage subclasses may ignore attempts to set properties.
Parameters:
  name - a String containing the property's name.
Parameters:
  value - the property, as a general Object.
throws:
  IllegalArgumentException - If name or value is null.
since:
   JAI 1.1

size
public int size()(Code)
Returns the number of elements in this Collection.

toArray
public Object[] toArray()(Code)
Returns an array containing all of the elements in this Collection.

toArray
public Object[] toArray(Object[] a)(Code)
Returns an array containing all of the elements in this collection whose runtime type is that of the specified array.
throws:
  ArrayStoreException - if the runtime type of the specified arrayis not a supertype of the runtime type of every element in thisCollection.

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.