javax.media.jai.operator
Class PatternDescriptor

java.lang.Object
  javax.media.jai.OperationDescriptorImpl
      javax.media.jai.operator.PatternDescriptor

All Implemented Interfaces:

OperationDescriptor, RegistryElementDescriptor, Serializable

public class PatternDescriptor

extends OperationDescriptorImpl

An OperationDescriptor describing the "Pattern" operation.

The "Pattern" operation defines a tiled image consisting of a repeated pattern. The width and height of the destination image must be specified. The tileWidth and tileHeight are equal to pattern's width and height. Each tile of the destination image will be defined by a reference to a shared instance of the pattern.

Resource List

Name	Value
GlobalName	pattern
LocalName	pattern
Vendor	com.sun.media.jai
Description	Defines an image with a repeated pattern.
DocURL	http://java.sun.com/products/java-media/jai/forDevelopers/jai-apidocs/javax/media/jai/operator/PatternDescriptor.html
Version	1.0
arg0Desc	The width of the image in pixels.
arg1Desc	The height of the image in pixels.

Parameter List

Name	Class Type	Default Value
width	java.lang.Integer	NO_PARAMETER_DEFAULT
height	java.lang.Integer	NO_PARAMETER_DEFAULT

See Also:

OperationDescriptor, Serialized Form

Field Summary

Fields inherited from class javax.media.jai.OperationDescriptorImpl

sourceNames, supportedModes

Fields inherited from interface javax.media.jai.OperationDescriptor

NO_PARAMETER_DEFAULT

Constructor Summary

PatternDescriptor()
Constructor.

Method Summary

static RenderedOp	create(RenderedImage source0, Integer width, Integer height, RenderingHints hints) Defines an image with a repeated pattern.
Number	getParamMinValue(int index) Returns the minimum legal value of a specified numeric parameter for this operation.

Methods inherited from class javax.media.jai.OperationDescriptorImpl

arePropertiesSupported, getDefaultSourceClass, getDestClass, getDestClass, getInvalidRegion, getName, getNumParameters, getNumSources, getParamClasses, getParamDefaults, getParamDefaultValue, getParameterListDescriptor, getParamMaxValue, getParamNames, getPropertyGenerators, getPropertyGenerators, getRenderableDestClass, getRenderableSourceClasses, getResourceBundle, getResources, getSourceClasses, getSourceClasses, getSourceNames, getSupportedModes, isImmediate, isModeSupported, isRenderableSupported, isRenderedSupported, makeDefaultSourceClassList, validateArguments, validateArguments, validateParameters, validateParameters, validateRenderableArguments, validateRenderableSources, validateSources, validateSources

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PatternDescriptor

public PatternDescriptor()

Constructor.

Method Detail

getParamMinValue

public Number getParamMinValue(int index)

Description copied from class: OperationDescriptorImpl

Returns the minimum legal value of a specified numeric parameter for this operation. If the specified parameter is non-numeric, this method returns null.

The return value should be of the class types corresponding to the parameter's primitive type, that is, Byte for a byte parameter, Integer for an int parameter, and so forth.

The default implementation returns the minimum value in the parameter data type's full range.

Specified by:

getParamMinValue in interface OperationDescriptor

Overrides:

getParamMinValue in class OperationDescriptorImpl

Parameters:

index - The index of the parameter to be queried.

Returns:

A Number representing the minimum legal value, or null if the specified parameter is not numeric.

See Also:

ParameterListDescriptor.getParamValueRange(java.lang.String), ParameterListDescriptor.getEnumeratedParameterValues(java.lang.String), ParameterListDescriptor.isParameterValueValid(java.lang.String, java.lang.Object)

create

public static RenderedOp create(RenderedImage source0,
                                Integer width,
                                Integer height,
                                RenderingHints hints)

Defines an image with a repeated pattern.

Creates a ParameterBlockJAI from all supplied arguments except hints and invokes JAI.create(String,ParameterBlock,RenderingHints).

Parameters:

source0 - RenderedImage source 0.

width - The width of the image in pixels.

height - The height of the image in pixels.

hints - The RenderingHints to use. May be null.

Returns:

The RenderedOp destination.

Throws:

IllegalArgumentException - if source0 is null.

IllegalArgumentException - if width is null.

IllegalArgumentException - if height is null.

See Also:

JAI, ParameterBlockJAI, RenderedOp