Generated by
JDiff

java.awt.image.renderable Documentation Differences

This file contains all the changes in documentation in the package java.awt.image.renderable as colored differences. Deletions are shown like this, and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a <code> tag will cause all subsequent paragraphs to be displayed differently.

Class ContextualRenderedImageFactory, RenderedImage create(RenderContext, ParameterBlock)

Creates a rendering given a RenderContext and a ParameterBlock containing the operation's sources and parameters. The output is a RenderedImage that takes the RenderContext into account to determine its dimensions and placement on the image plane. This method houses the "intelligence" that allows a rendering-independent operation to adapt to a specific RenderContext. @param renderContext The RenderContext specifying the rendering. @param paramBlock a ParameterBlock containing the operation's sources and parameters @return a RenderedImage from the sources and parameters in the specified ParameterBlock and according to the rendering instructions in the specified RenderContext.
Class ContextualRenderedImageFactory, String[] getPropertyNames()

Returns a list of names recognized by getProperty. @return the list of property names.
Class ContextualRenderedImageFactory, boolean isDynamic()

Returns true if successive renderings (that is calls to create(RenderContext ParameterBlock)) with the same arguments may produce different results. This method may be used to determine whether an existing rendering may be cached and reused. It is always safe to return true. @return true if successive renderings with the same arguments might produce different results; false otherwise.
Class ContextualRenderedImageFactory, RenderContext mapRenderContext(int, RenderContext, ParameterBlock, RenderableImage)

Maps the operation's output RenderContext into a RenderContext for each of the operation's sources. This is useful for operations that can be expressed in whole or in part simply as alterations in the RenderContext such as an affine mapping or operations that wish to obtain lower quality renderings of their sources in order to save processing effort or transmission bandwith. Some operations such as blur can also use this mechanism to avoid obtaining sources of higher quality than necessary. @param i the index of the source image. @param renderContext the RenderContext being applied to the operation. @param paramBlock a ParameterBlock containing the operation's sources and parameters. @param image the RenderableImage being rendered. @return a RenderContext for the source at the specified index of the parameters Vector contained in the specified ParameterBlock.

Class ParameterBlock, constructor ParameterBlock(Vector)

Constructs a ParameterBlock with a given Vector of sources. @param sources a Vector of source images
Class ParameterBlock, constructor ParameterBlock(Vector, Vector)

Constructs a ParameterBlock with a given Vector of sources and Vector of parameters. @param sources a Vector of source images @param parameters a Vector of parameters to be used in the rendering operation
Class ParameterBlock, ParameterBlock add(Object)

Adds an object to the list of parameters. @param obj the Object to add to the parameters Vector @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock add(byte)

Adds a Byte to the list of parameters. @param b the byte to add to the parameters Vector @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock add(char)

Adds a Character to the list of parameters. @param c the char to add to the parameters Vector @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock add(double)

Adds a Double to the list of parameters. @param d the double to add to the parameters Vector @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock add(float)

Adds a Float to the list of parameters. @param f the float to add to the parameters Vector @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock add(int)

Adds a Integer to the list of parameters. @param i the int to add to the parameters Vector @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock add(long)

Adds a Long to the list of parameters. @param l the long to add to the parameters Vector @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock add(short)

Adds a Short to the list of parameters. @param s the short to add to the parameters Vector @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock addSource(Object)

Adds an image to end of the list of sources. The image is stored as an object in order to allow new node types in the future. @param source an image object to be stored in the source list. @return a new ParameterBlock containing the specified source.
Class ParameterBlock, int getNumParameters()

Returns the number of parameters (not including source images). @return the number of parameters in the parameters Vector.
Class ParameterBlock, int getNumSources()

Returns the number of source images. @return the number of source images in the sources Vector.
Class ParameterBlock, Object getObjectParameter(int)

Gets a parameter as an object. @param index the index of the parameter to get @return an Object representing the the parameter at the specified index into the parameters Vector.
Class ParameterBlock, Class[] getParamClasses()

Returns an array of Class objects describing the types of the parameters. @return an array of Class objects.
Class ParameterBlock, Vector getParameters()

Returns the entire Vector of parameters. @return the parameters Vector. @see #setParameters(Vector)
Class ParameterBlock, RenderableImage getRenderableSource(int)

AReturns convenience method to return a source as a RenderableImage. This method is a convenience method. An exception will be thrown if the sources is not a RenderableImage. @param index the index of the source to be returned @return a RenderableImage that represents the source image that is at the specified index in the sources Vector.
Class ParameterBlock, RenderedImage getRenderedSource(int)

AReturns convenience method to return a source as a RenderedImage. This method is a convenience method. An exception will be thrown if the sourcessource is not a RenderedImage. @param index the index of the source to be returned @return a RenderedImage that represents the source image that is at the specified index in the sources Vector.
Class ParameterBlock, Object getSource(int)

Returns a source as a general Object. The caller must cast it into an appropriate type. @param index the index of the source to be returned. @return an Object that represents the source located at the specified index in the sources Vector. @see #setSource(Object int)
Class ParameterBlock, Vector getSources()

Returns the entire Vector of sources. @return the sources Vector. @see #setSources(Vector)
Class ParameterBlock, ParameterBlock set(Object, int)

Replaces an Object in the list of parameters. If the index lies beyond the current source list the list is extended with nulls as needed. @param obj the parameter that replaces the parameter at the specified index in the parameters Vector @param index the index of the parameter to be replaced with the specified parameter @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock set(byte, int)

Replaces an Object in the list of parameters with a Byte. If the index lies beyond the current source list the list is extended with nulls as needed. @param b the parameter that replaces the parameter at the specified index in the parameters Vector @param index the index of the parameter to be replaced with the specified parameter @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock set(char, int)

Replaces an Object in the list of parameters with a Character. If the index lies beyond the current source list the list is extended with nulls as needed. @param c the parameter that replaces the parameter at the specified index in the parameters Vector @param index the index of the parameter to be replaced with the specified parameter @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock set(double, int)

Replaces an Object in the list of parameters with a Double. If the index lies beyond the current source list the list is extended with nulls as needed. @param d the parameter that replaces the parameter at the specified index in the parameters Vector @param index the index of the parameter to be replaced with the specified parameter @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock set(float, int)

Replaces an Object in the list of parameters with a Float. If the index lies beyond the current source list the list is extended with nulls as needed. @param f the parameter that replaces the parameter at the specified index in the parameters Vector @param index the index of the parameter to be replaced with the specified parameter @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock set(int, int)

Replaces an Object in the list of parameters with an Integer. If the index lies beyond the current source list the list is extended with nulls as needed. @param i the parameter that replaces the parameter at the specified index in the parameters Vector @param index the index of the parameter to be replaced with the specified parameter @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock set(long, int)

Replaces an Object in the list of parameters with a Long. If the index lies beyond the current source list the list is extended with nulls as needed. @param l the parameter that replaces the parameter at the specified index in the parameters Vector @param index the index of the parameter to be replaced with the specified parameter @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, ParameterBlock set(short, int)

Replaces an Object in the list of parameters with a Short. If the index lies beyond the current source list the list is extended with nulls as needed. @param s the parameter that replaces the parameter at the specified index in the parameters Vector @param index the index of the parameter to be replaced with the specified parameter @return a new ParameterBlock containing the specified parameter.
Class ParameterBlock, void setParameters(Vector)

Sets the entire Vector of parameters to a given Vector. @param parameters the specified Vector of parameters @see #getParameters
Class ParameterBlock, ParameterBlock setSource(Object, int)

Replaces an entry in the list of source with a new source. If the index lies beyond the current source list the list is extended with nulls as needed. @param source the specified source image @param index the index into the sources Vector at which to insert the specified source @return a new ParameterBlock that contains the specified source at the specified index. @see #getSource(int)
Class ParameterBlock, void setSources(Vector)

Sets the entire Vector of sources to a given Vector. @param sources the Vector of source images @see #getSources

Class RenderContext, Shape getAreaOfInterest()

Gets the ares of interest currently contained in the RenderContext. @return a reference to the area of interest of the RenderContext or null if none is specified. @see #setAreaOfInterest(Shape)
Class RenderContext, RenderingHints getRenderingHints()

Gets the rendering hints of this RenderContext. @return a RenderingHints object that represents the rendering hints of this RenderContext. @see #setRenderingHints(RenderingHints)
Class RenderContext, AffineTransform getTransform()

Gets the current user-to-device AffineTransform. @return a reference to the current AffineTransform. @see #setTransform(AffineTransform)
Class RenderContext, void setAreaOfInterest(Shape)

Sets the current area of interest. The old area is discarded. @param newAoi The new area of interest. @see #getAreaOfInterest
Class RenderContext, void setRenderingHints(RenderingHints)

Sets the rendering hints of this RenderContext. @param hints a RenderingHints object that represents the rendering hints to assign to this RenderContext. @see #getRenderingHints
Class RenderContext, void setTransform(AffineTransform)

Sets the current user-to-device AffineTransform contained in the RenderContext to a given transform. @param newTransform the new AffineTransform. @see #getTransform

Class RenderableImage, float getMinX()

Gets the minimum X coordinate of the rendering-independent image data. @return the minimum X coordinate of the rendering-independent image data.
Class RenderableImage, float getMinY()

Gets the minimum Y coordinate of the rendering-independent image data. @return the minimum Y coordinate of the rendering-independent image data.
Class RenderableImage, String[] getPropertyNames()

Returns a list of names recognized by getProperty. @return a list of property names.
Class RenderableImage, boolean isDynamic()

Returns true if successive renderings (that is calls to createRendering() or createScaledRendering()) with the same arguments may produce different results. This method may be used to determine whether an existing rendering may be cached and reused. It is always safe to return true. @return true if successive renderings with the same arguments might produce different results; false otherwise.

Class RenderableImageOp, ParameterBlock getParameterBlock()

Returns a reference to the current parameter block. @return the ParameterBlock of this RenderableImageOp. @see #setParameterBlock(ParameterBlock)
Class RenderableImageOp, String[] getPropertyNames()

Return a list of names recognized by getProperty. @return a list of property names.
Class RenderableImageOp, boolean isDynamic()

Returns true if successive renderings (that is calls to createRendering() or createScaledRendering()) with the same arguments may produce different results. This method may be used to determine whether an existing rendering may be cached and reused. The CRIF's isDynamic method will be called. @return true if successive renderings with the same arguments might produce different results; false otherwise.
Class RenderableImageOp, ParameterBlock setParameterBlock(ParameterBlock)

Change the current ParameterBlock of the operation allowing editing of image rendering chains. The effects of such a change will be visible when a new rendering is created from this RenderableImageOp or any dependent RenderableImageOp. @param paramBlock the new ParameterBlock. @return the old ParameterBlock. @see #getParameterBlock