Layer

Inheritance: java.lang.Object, com.aspose.psd.DisposableObject, com.aspose.psd.DataStreamSupporter, com.aspose.psd.Image, com.aspose.psd.RasterImage, com.aspose.psd.RasterCachedImage

All Implemented Interfaces: java.lang.Cloneable

public class Layer extends RasterCachedImage implements Cloneable

The psd layer.

Constructors

ConstructorDescription
Layer()Initializes a new instance of the Layer class.
Layer(RasterImage image)
Layer(RasterImage image, boolean disposeImage)Initializes a new instance of the Layer class.
Layer(InputStream stream)Initializes a new instance of the Layer class.
Layer(Rectangle bounds, byte[] redBytes, byte[] greenBytes, byte[] blueBytes, String name)Initializes a new instance of the Layer class from byte arrays.

Fields

FieldDescription
BlendSignatureRepresents blend mode signature.
LayerHeaderSizeThe layer header size.
OnCreate_internalizedOccurs when image was loaded
OnLoad_internalizedOccurs when image was loaded by createFirstSupportedLoader
OnSave_internalizedOccurs when image was loaded or saved
OnUseCredit_internalizedOccurs when credit was used
resources_internalizedThe resources

Methods

MethodDescription
tryGetResource_internalized(Class typeOfT, T[] resource)Gets the resource associated with the specified type.
addLayerMask(LayerMaskData layerMask)Adds the mask to current layer.
addResource_internalized(LayerResource resource)Adds the resource.
adjustBrightness(int brightness)Adjust of a brightness for image.
adjustContrast(float contrast)Image contrasting
adjustGamma(float gamma)Gamma-correction of an image.
adjustGamma(float gammaRed, float gammaGreen, float gammaBlue)Gamma-correction of an image.
applyLayerState_internalized(LayerState layerState)Applies the layer style setting from input LayerState to current Layer instance.
beginResize_internalized(int newWidth, int newHeight)Begins the resize process.
binarizeBradley(double brightnessDifference)Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
binarizeBradley(double brightnessDifference, int windowSize)Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding
binarizeFixed(byte threshold)Binarization of an image with predefined threshold
binarizeOtsu()Binarization of an image with Otsu thresholding
cacheData()Caches the data and ensures no additional data loading will be performed from the underlying DataStreamSupporter.DataStreamContainer .
canLoad(InputStream stream)Determines whether image can be loaded from the specified stream.
canLoad(InputStream stream, LoadOptions loadOptions)Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions .
canLoad(String filePath)Determines whether image can be loaded from the specified file path.
canLoad(String filePath, LoadOptions loadOptions)Determines whether image can be loaded from the specified file path and optionally using the specified open options.
canLoadInternal_internalized(System.IO.Stream stream)
canLoadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)
canSave(ImageOptionsBase options)Determines whether image can be saved to the specified file format represented by the passed save options.
close()Implements the Closable interface and can be used in the try-with-resources statement since JDK 1.7.
convertToAps_internalized(ImageOptionsBase options, int mode, Rectangle clippingRectangle)Converts to aps.
create(ImageOptionsBase imageOptions, int width, int height)Creates a new image using the specified create options.
create(Image[] images)Creates a new image using the specified images as pages
create(Image[] images, boolean disposeImages)Creates a new image the specified images as pages.
createInstance_internalized(PsdHeader header, IColorPalette palette, LinkedLayersRegistry linkedLayersRegistry)Creates the new instance of the Layer class.
createLayerState_internalized()Creates the new LayerState instance based on current Layer values.
createPartialRotateSaver_internalized(PartialRotater resizer, IPixelsSaver pixelsSaver, int width, int height)
create_internalized(System.IO.Stream stream)
crop(Rectangle rectangle)Cropping the image.
crop(int leftShift, int rightShift, int topShift, int bottomShift)Crop image with shifts.
dispose()Disposes the current instance.
dither(int ditheringMethod, int bitsCount)Performs dithering on the current image.
dither(int ditheringMethod, int bitsCount, IColorPalette customPalette)Performs dithering on the current image.
doAfterSave_internalized(System.IO.Stream stream)
doCrop_internalized(Rectangle rectangle)Cropping the image.
doResize_internalized(int newWidth, int newHeight, ImageResizeSettings settings)Resizes the image.
doResize_internalized(int newWidth, int newHeight, int resizeType)
doRotate(float angle, boolean resizeProportionally, Color backgroundColor)
doRotateFlip_internalized(int rotateFlipType)Rotates, flips, or rotates and flips the image.
drawImage(Point location, RasterImage image)Draws the image on layer.
equals(Object obj)Determines whether the specified Object, is equal to this instance.
filter(Rectangle rectangle, FilterOptionsBase options)Filters the specified rectangle.
findAssignableResource_internalized(System.Type type)Finds the assignable resource.
findPattResource_internalized()Finds the PattResource
findResource_internalized(int typeToolKey)Finds the resource by unique key
getAbsoluteBounds_internalized()Gets or sets the absolute bounds.
getArgb32Pixel(int x, int y)Gets an image 32-bit ARGB pixel.
getAutoAdjustPalette()Gets a value indicating whether automatic adjust palette.
getBackgroundColor()Gets or sets a value for the background color.
getBitsPerPixel()Gets the image bits per pixel count.
getBlendClippedElements()Gets or sets the blending of clipped element.
getBlendModeKey()Gets or sets the blend mode key.
getBlendModeSignature()Gets the blend mode signature.
getBlendingOptions()Gets the blending options.
getBottom()Gets or sets the bottom layer position.
getBounds()Gets the image bounds.
getBufferSizeHint()Gets the buffer size hint which is defined max allowed size for all internal buffers.
getBytesPerRowForFullMask_internalized(int bitDepth)Gets the bytes per row for full mask mode.
getBytesPerRowForMask_internalized(int bitDepth)Gets the bytes per row.
getBytesPerRow_internalized(int bitDepth)Gets the bytes per row.
getChannelInformation()Gets or sets the channel information.
getChannelsCount()Gets the layer’s channels count.
getClass()
getClipping()Gets or sets the layer clipping.
getContainer()Gets the Image container.
getDataStreamContainer()Gets the object’s data stream.
getDeeplyAdjustPalette_internalized()Gets the deeply adjust palette.
getDefaultArgb32Pixels(Rectangle rectangle)Gets the default 32-bit ARGB pixels array.
getDefaultOptions(Object[] args)Gets the default options.
getDefaultPixels(Rectangle rectangle, IPartialArgb32PixelLoader partialPixelLoader)Gets the default pixels array using partial pixel loader.
getDefaultRawData(Rectangle rectangle, IPartialRawDataLoader partialRawDataLoader, RawDataSettings rawDataSettings)Gets the default raw data array using partial pixel loader.
getDefaultRawData(Rectangle rectangle, RawDataSettings rawDataSettings)Gets the default raw data array.
getDisplayName()Gets the display name of the layer.
getDisposed()Gets a value indicating whether this instance is disposed.
getExtraLength()Gets the layer extra information length in bytes.
getFileFormat()Gets a value of file format
getFileFormat(System.IO.Stream stream)Gets the file format.
getFileFormat(InputStream stream)Gets the file format.
getFileFormat(String filePath)Gets the file format.
getFillOpacity()Gets or sets the fill opacity.
getFiller()Gets or sets the layer filler.
getFittingRectangle(Rectangle rectangle, int width, int height)Gets rectangle which fits the current image.
getFittingRectangle(Rectangle rectangle, int[] pixels, int width, int height)Gets rectangle which fits the current image.
getFlags()Gets or sets the layer flags.
getFoldersHierarchy_internalized()Gets the list of LayerGroup folders hierarchy of current layer.
getFormatSpecificPalette_internalized()Gets palette from format-specific places
getGUID_internalized()Gets the unique identifier of this Layer instance.
getHeader_internalized()Gets or sets the header.
getHeight()Gets the image height.
getHorizontalResolution()Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage .
getImageOpacity()Gets opacity of this image.
getInnerDataTransformer_internalized()Gets the inner data transformer.
getInterruptMonitor()Gets the interrupt monitor.
getLayerBlendingRangesData()Gets or sets the layer blending ranges data.
getLayerCreationDateTime()Gets or sets the layer creation date time.
getLayerCreationDateTime_internalized()
getLayerLock()Gets or sets the layer lock.
getLayerMaskData()Gets or sets the layer mask data.
getLayerOptions()Gets the layer options.
getLayerPalette_internalized()Gets or sets the layer palette.
getLayerType_internalized()Gets the type of the layer.
getLeft()Gets or sets the left layer position.
getLength()Gets the overall layer length in bytes.
getMaxAllowedAllocationForPartialRotateSave_internalized()Gets or sets the max allowed allocation for partial rotate save.
getMemoryMgr_internalized()Gets the memory manager.
getModifyDate(boolean useDefault)Gets the date and time the resource image was last modified.
getModifyDate_internalized(boolean useDefault)
getName()Gets or sets the layer name.
getOpacity()Gets or sets the layer opacity.
getOpacityTotal_internalized()Gets the total opacity.
getOriginalOptions()Gets the options based on the original file settings.
getPaintableImage_internalized(ImageOptionsBase paintableOptions)Gets the paintable image.
getPalette()Gets the color palette.
getPixel(int x, int y)Gets an image pixel.
getPremultiplyComponents()Gets or sets a value indicating whether the image components must be premultiplied.
getPrivateFontCache_internalized()Creates the private font cache.
getProgressEventHandler()Gets the progress event handler information.
getProgressEventHandlerInfo()Gets the progress event handler information.
getProportionalHeight(int width, int height, int newWidth)Gets a proportional height.
getProportionalWidth(int width, int height, int newHeight)Gets a proportional width.
getRawCustomColorConverter()Gets or sets the custom color converter
getRawDataFormat()Gets the raw data format.
getRawDataSettings()
getRawFallbackIndex()Gets or sets the fallback index to use when palette index is out of bounds
getRawIndexedColorConverter()Gets or sets the indexed color converter
getRawLineSize()Gets the raw line size in bytes.
getResources()Gets or sets the layer resources.
getRight()Gets or sets the right layer position.
getRotateMode()Gets or sets the rotate mode.
getSheetColorHighlight()Gets or sets the decorative sheet color highlight in layers’ list
getSize()Gets the image size.
getSkewAngle()Gets the skew angle.
getSourceImagePath_internalized()Gets the file path of source image if it’s exist.
getSyncRoot_internalized()Gets the synchronize root.
getTop()Gets or sets the top layer position.
getTransparentColor()Gets the image transparent color.
getUpdateXmpData()Gets or sets a value indicating whether to update the XMP metadata.
getUseMemoryStrategy_internalized()Gets a value indicating whether object uses memory optimization strategy
getUseRawData()Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.
getUsedPalette_internalized()Gets the used palette.
getVentureLicense_internalized()Gets the venture license.
getVerticalResolution()Gets or sets the vertical resolution, in pixels per inch, of this RasterImage .
getWidth()Gets the image width.
getXmpData()Gets or sets the XMP metadata.
grayscale()Transformation of an image to its grayscale representation
hasAlpha()Gets a value indicating whether this instance has alpha.
hasBackgroundColor()Gets a value indicating whether image has background color.
hasImageChanged_internalized()Gets or sets a value indicating whether this instance of image has changed after loading.
hasTransparentColor()Gets a value indicating whether image has transparent color.
hashCode()Returns a hash code for this instance.
incrementProgressMaxValue_internalized(int value)Gets or sets the progress max value
indicateProgress_internalized(EventType eventType)Indicates the progress.
isCached()Gets a value indicating whether image data is cached currently.
isLayerValid_internalized()Detects if layer is valid for saving to a file.
isRawDataAvailable()Gets a value indicating whether raw data loading is available.
isUsePalette()Gets a value indicating whether the image palette is used.
isVisible()Gets or sets a value indicating whether the layer is visible
isVisibleInGroup()Gets a value indicating whether this instance is visible in group(If layer is not in group it means root group).
load(InputStream stream)Loads a new image from the specified stream.
load(InputStream stream, LoadOptions loadOptions)Loads a new image from the specified stream.
load(RandomAccessFile file)Loads a new image from the specified stream.
load(RandomAccessFile file, LoadOptions loadOptions)Loads a new image from the specified stream.
load(String filePath)Loads a new image from the specified file.
load(String filePath, LoadOptions loadOptions)Loads a new image from the specified file.
loadArgb32Pixels(Rectangle rectangle)Loads 32-bit ARGB pixels.
loadArgb64Pixels(Rectangle rectangle)Loads 64-bit ARGB pixels.
loadCmyk32Pixels(Rectangle rectangle)Loads pixels in CMYK format.
loadCmykPixels(Rectangle rectangle)Loads pixels in CMYK format.
loadInternal_internalized(System.IO.Stream stream)
loadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)
loadPartialArgb32Pixels(Rectangle rectangle, IPartialArgb32PixelLoader partialPixelLoader)Loads 32-bit ARGB pixels partially by packs.
loadPartialPixels(Rectangle desiredRectangle, IPartialPixelLoader pixelLoader)Loads pixels partially by packs.
loadPixels(Rectangle rectangle)Loads pixels.
loadRawData(Rectangle rectangle, RawDataSettings rawDataSettings, IPartialRawDataLoader rawDataLoader)Loads raw image data using the partial processing mechanism.
loadRawData(Rectangle rectangle, Rectangle destImageBounds, RawDataSettings rawDataSettings, IPartialRawDataLoader rawDataLoader)Loads raw data.
load_internalized(System.IO.Stream stream)
load_internalized(System.IO.Stream stream, long startPosition)Loads a new image from the specified stream.
load_internalized(System.IO.Stream stream, long startPosition, LoadOptions loadOptions)Loads a new image from the specified stream.
mergeLayerTo(Layer layerToMergeInto)Merges the layer to specified layer
normalizeAngle()Normalizes the angle.
normalizeAngle(boolean resizeProportionally, Color backgroundColor)Normalizes the angle.
notify()
notifyAll()
onContainerSet_internalized()Invoke when container of this Image was set.
readArgb32ScanLine(int scanLineIndex)Reads the whole scan line by the specified scan line index.
readScanLine(int scanLineIndex)Reads the whole scan line by the specified scan line index.
removeResource_internalized(LayerResource resource)Removes the resource.
replaceColor(Color oldColor, byte oldColorDiff, Color newColor)Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
replaceColor(int oldColorArgb, byte oldColorDiff, int newColorArgb)Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.
replaceNonTransparentColors(Color newColor)Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges.
replaceNonTransparentColors(int newColorArgb)Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges.
resize(int newWidth, int newHeight)Resizes the image.
resize(int newWidth, int newHeight, ImageResizeSettings settings)Resizes the image.
resize(int newWidth, int newHeight, int resizeType)Resizes the image.
resizeChannelsData_internalized(Rectangle rect)Resizes the channels data
resizeHeightProportionally(int newHeight)Resizes the height proportionally.
resizeHeightProportionally(int newHeight, ImageResizeSettings settings)Resizes the height proportionally.
resizeHeightProportionally(int newHeight, int resizeType)Resizes the height proportionally.
resizeWidthProportionally(int newWidth)Resizes the width proportionally.
resizeWidthProportionally(int newWidth, ImageResizeSettings settings)Resizes the width proportionally.
resizeWidthProportionally(int newWidth, int resizeType)Resizes the width proportionally.
resizeWithScale_internalized(double scaleX, double scaleY, int resizeType)Resizes the layer with the specified inverse scale.
rotate(float angle)Rotate image around the center.
rotate(float angle, boolean resizeProportionally, Color backgroundColor)Rotate image around the center.
rotateFlip(int rotateFlipType)
save()Saves the image data to the underlying stream.
save(System.IO.Stream stream)
save(OutputStream stream)Saves the object’s data to the specified stream.
save(OutputStream stream, ImageOptionsBase optionsBase)Saves the image’s data to the specified stream in the specified file format according to save options.
save(OutputStream dstStream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)Saves the image’s data to the specified stream in the specified file format according to save options.
save(RandomAccessFile file)Saves the object’s data to the specified stream.
save(RandomAccessFile file, ImageOptionsBase options)Saves the object’s data to the specified file location in the specified file format according to save options.
save(RandomAccessFile file, ImageOptionsBase optionsBase, Rectangle boundsRectangle)Saves the image’s data to the specified stream in the specified file format according to save options.
save(String filePath)Saves the object’s data to the specified file location.
save(String filePath, boolean overWrite)Saves the object’s data to the specified file location.
save(String filePath, ImageOptionsBase options)Saves the object’s data to the specified file location in the specified file format according to save options.
save(String filePath, ImageOptionsBase options, Rectangle boundsRectangle)Saves the object’s data to the specified file location in the specified file format according to save options.
saveArgb32Pixels(Rectangle rectangle, int[] pixels)Saves the 32-bit ARGB pixels.
saveCmyk32Pixels(Rectangle rectangle, int[] pixels)Saves the pixels.
saveCmykPixels(Rectangle rectangle, CmykColor[] pixels)Saves the pixels.
savePixels(Rectangle rectangle, Color[] pixels)Saves the pixels.
saveRawData(byte[] data, int dataOffset, Rectangle rectangle, RawDataSettings rawDataSettings)Saves the raw data.
save_internalized(System.IO.Stream stream)
save_internalized(System.IO.Stream stream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)
save_internalized(StreamContainer streamContainer, int psdVersion, int bitDepth)Saves data to the specified stream container.
setAbsoluteBounds_internalized(Rectangle value)Gets or sets the absolute bounds.
setArgb32Pixel(int x, int y, int argb32Color)Sets an image 32-bit ARGB pixel for the specified position.
setAutoAdjustPalette(boolean value)Sets a value indicating whether automatic adjust palette.
setBackgroundColor(boolean value)Gets or sets a value indicating whether image has background color.
setBackgroundColor(Color value)Gets or sets a value for the background color.
setBlendClippedElements(boolean value)Gets or sets the blending of clipped element.
setBlendModeKey(long value)Gets or sets the blend mode key.
setBottom(int value)Gets or sets the bottom layer position.
setBufferSizeHint(int value)Sets the buffer size hint which is defined max allowed size for all internal buffers.
setChannelInformation(ChannelInformation[] value)Gets or sets the channel information.
setClipping(byte value)Gets or sets the layer clipping.
setContainer_internalized(Image container)Sets the Image container.
setDataLoaderDirectly_internalized(IRasterImageArgb32PixelLoader loader)Sets the data loader directly.
setDataStreamContainer(StreamContainer value)Sets the object’s data stream.
setDisplayName(String value)Gets or sets the display name of the layer.
setFillOpacity(int value)Gets the fill opacity.
setFiller(byte value)Gets or sets the layer filler.
setFlags(byte value)Gets or sets the layer flags.
setFormatSpecificPalette_internalized(IColorPalette newPalette)Sets palette into format-specific places
setHeader_internalized(PsdHeader value)Gets or sets the header.
setHorizontalResolution(double value)Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage .
setIgnoreAfterSave_internalized(boolean value)Sets a value indicating whether [ignore after save].
setImageChanged_internalized(boolean value)Gets or sets a value indicating whether this instance of image has changed after loading.
setInnerDataTransformer_internalized(IInnerDataTransformer value)Sets the inner data transformer.
setInterruptMonitor(InterruptMonitor value)Sets the interrupt monitor.
setLayerBlendingRangesData(LayerBlendingRangesData value)Gets or sets the layer blending ranges data.
setLayerCreationDateTime(Date value)Gets or sets the layer creation date time.
setLayerCreationDateTime_internalized(System.DateTime value)
setLayerLock(int value)Gets or sets the layer lock (Note that if flag LayerFlags.TransparencyProtected is set it will be overritten by layer lock flag.
setLayerMaskData(LayerMaskData value)Gets or sets the layer mask data.
setLayerPalette_internalized(IColorPalette value)Gets or sets the layer palette.
setLeft(int value)Gets or sets the left layer position.
setMaxAllowedAllocationForPartialRotateSave_internalized(int value)Gets or sets the max allowed allocation for partial rotate save.
setMemoryManager_internalized(MemMgr memoryManager, boolean needDispose)Sets the memory manager.
setName(String name)Sets the layer name.
setName_internalized(String value)Gets or sets the layer name.
setOpacity(byte value)Gets or sets the layer opacity.
setPalette(IColorPalette value)Sets the color palette.
setPalette(IColorPalette palette, boolean updateColors)Sets the image palette.
setPixel(int x, int y, Color color)Sets an image pixel for the specified position.
setPremultiplyComponents(boolean value)Gets or sets a value indicating whether the image components must be premultiplied.
setRawCustomColorConverter(IColorConverter value)Gets or sets the custom color converter
setRawFallbackIndex(int value)Gets or sets the fallback index to use when palette index is out of bounds
setRawIndexedColorConverter(IIndexedColorConverter value)Gets or sets the indexed color converter
setResolution(double dpiX, double dpiY)Sets the resolution for this RasterImage .
setResources(LayerResource[] value)Gets or sets the layer resources.
setRight(int value)Gets or sets the right layer position.
setRotateMode_internalized(int value)Gets or sets the rotate mode.
setSheetColorHighlight(short value)Gets or sets the decorative sheet color highlight in layers’ list
setTop(int value)Gets or sets the top layer position.
setTransparentColor(boolean value)Gets a value indicating whether image has transparent color.
setTransparentColor(Color value)Gets the image transparent color.
setUpdateXmpData(boolean value)Gets or sets a value indicating whether to update the XMP metadata.
setUseRawData(boolean value)Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.
setVentureLicense_internalized(Object ventureLicense)All Aspose products should implement this method.
setVerticalResolution(double value)Gets or sets the vertical resolution, in pixels per inch, of this RasterImage .
setVisible(boolean value)Gets or sets a value indicating whether the layer is visible
setXmpData(XmpPacketWrapper value)Gets or sets the XMP metadata.
shallowCopy()Creates a shallow copy of the current Layer.
toBitmap()Converts raster image to the bitmap.
toBitmap_internalized()
toString()
updateBlendingOptions_internalized(PattResource pattResource)Updates the blending options after layer or global resources change.
wait()
wait(long arg0)
wait(long arg0, int arg1)
writeArgb32ScanLine(int scanLineIndex, int[] argb32Pixels)Writes the whole scan line to the specified scan line index.
writeScanLine(int scanLineIndex, Color[] pixels)Writes the whole scan line to the specified scan line index.

Layer()

public Layer()

Initializes a new instance of the Layer class. Constructor for lazy initialization.

Layer(RasterImage image)

public Layer(RasterImage image)

Parameters:

ParameterTypeDescription
imageRasterImage

Layer(RasterImage image, boolean disposeImage)

public Layer(RasterImage image, boolean disposeImage)

Initializes a new instance of the Layer class.

Parameters:

ParameterTypeDescription
imageRasterImageThe image.
disposeImagebooleanif set to true [dispose image].

Layer(InputStream stream)

public Layer(InputStream stream)

Initializes a new instance of the Layer class.

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe image stream

Layer(Rectangle bounds, byte[] redBytes, byte[] greenBytes, byte[] blueBytes, String name)

public Layer(Rectangle bounds, byte[] redBytes, byte[] greenBytes, byte[] blueBytes, String name)

Initializes a new instance of the Layer class from byte arrays.

Parameters:

ParameterTypeDescription
boundsRectangleThe layer bounds.
redBytesbyte[]The red bytes.
greenBytesbyte[]The green bytes.
blueBytesbyte[]The blue bytes.
namejava.lang.StringThe layer name.

BlendSignature

public static final int BlendSignature

Represents blend mode signature.

LayerHeaderSize

public static final int LayerHeaderSize

The layer header size.

OnCreate_internalized

public static final Event<AfterCreate> OnCreate_internalized

Occurs when image was loaded

OnLoad_internalized

public static final Event<AfterLoad> OnLoad_internalized

Occurs when image was loaded by createFirstSupportedLoader

OnSave_internalized

public static final Event<AfterSave> OnSave_internalized

Occurs when image was loaded or saved

OnUseCredit_internalized

public static final Event<AfterUseCredit> OnUseCredit_internalized

Occurs when credit was used

resources_internalized

public ResourceNest resources_internalized

The resources

tryGetResource_internalized(Class typeOfT, T[] resource)

public final boolean <T>tryGetResource_internalized(Class<T> typeOfT, T[] resource)

Gets the resource associated with the specified type.

Parameters:

ParameterTypeDescription
typeOfTjava.lang.Class
resourceT[]When this method returns, contains the resource associated with the specified key type, if the key is found; otherwise, returns null.

T : The key type of the value to get. |

Returns: boolean - if contains an resource with the specified type; otherwise, .

addLayerMask(LayerMaskData layerMask)

public final void addLayerMask(LayerMaskData layerMask)

Adds the mask to current layer.

Parameters:

ParameterTypeDescription
layerMaskLayerMaskDataThe layer mask.

addResource_internalized(LayerResource resource)

public final void addResource_internalized(LayerResource resource)

Adds the resource.

Parameters:

ParameterTypeDescription
resourceLayerResourceThe resource.

adjustBrightness(int brightness)

public void adjustBrightness(int brightness)

Adjust of a brightness for image.

Parameters:

ParameterTypeDescription
brightnessintBrightness value.

adjustContrast(float contrast)

public void adjustContrast(float contrast)

Image contrasting

Parameters:

ParameterTypeDescription
contrastfloatContrast value (in range [-100; 100])

adjustGamma(float gamma)

public void adjustGamma(float gamma)

Gamma-correction of an image.

Parameters:

ParameterTypeDescription
gammafloatGamma for red, green and blue channels coefficient

adjustGamma(float gammaRed, float gammaGreen, float gammaBlue)

public void adjustGamma(float gammaRed, float gammaGreen, float gammaBlue)

Gamma-correction of an image.

Parameters:

ParameterTypeDescription
gammaRedfloatGamma for red channel coefficient
gammaGreenfloatGamma for green channel coefficient
gammaBluefloatGamma for blue channel coefficient

applyLayerState_internalized(LayerState layerState)

public final void applyLayerState_internalized(LayerState layerState)

Applies the layer style setting from input LayerState to current Layer instance.

Parameters:

ParameterTypeDescription
layerStateLayerStateThe layer state with new style.

beginResize_internalized(int newWidth, int newHeight)

public IResizeController beginResize_internalized(int newWidth, int newHeight)

Begins the resize process.

Parameters:

ParameterTypeDescription
newWidthintThe new image width.
newHeightintThe new image height.

Returns: com.aspose.internal.IResizeController - The resize controller.

binarizeBradley(double brightnessDifference)

public void binarizeBradley(double brightnessDifference)

Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding

Parameters:

ParameterTypeDescription
brightnessDifferencedoubleThe brightness difference between pixel and the average of an s x s window of pixels centered around this pixel.

binarizeBradley(double brightnessDifference, int windowSize)

public void binarizeBradley(double brightnessDifference, int windowSize)

Binarization of an image using Bradley’s adaptive thresholding algorithm using the integral image thresholding

Parameters:

ParameterTypeDescription
brightnessDifferencedoubleThe brightness difference between pixel and the average of an s x s window of pixels centered around this pixel.
windowSizeintThe size of s x s window of pixels centered around this pixel

binarizeFixed(byte threshold)

public void binarizeFixed(byte threshold)

Binarization of an image with predefined threshold

Parameters:

ParameterTypeDescription
thresholdbyteThreshold value. If corresponding gray value of a pixel is greater than threshold, a value of 255 will be assigned to it, 0 otherwise.

binarizeOtsu()

public void binarizeOtsu()

Binarization of an image with Otsu thresholding

cacheData()

public void cacheData()

Caches the data and ensures no additional data loading will be performed from the underlying DataStreamSupporter.DataStreamContainer .

canLoad(InputStream stream)

public static boolean canLoad(InputStream stream)

Determines whether image can be loaded from the specified stream.

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe stream to load from.

Returns: boolean - true if image can be loaded from the specified stream; otherwise, false .

canLoad(InputStream stream, LoadOptions loadOptions)

public static boolean canLoad(InputStream stream, LoadOptions loadOptions)

Determines whether image can be loaded from the specified stream and optionally using the specified loadOptions .

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe stream to load from.
loadOptionsLoadOptionsThe load options.

Returns: boolean - true if image can be loaded from the specified stream; otherwise, false .

canLoad(String filePath)

public static boolean canLoad(String filePath)

Determines whether image can be loaded from the specified file path.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe file path.

Returns: boolean - true if image can be loaded from the specified file; otherwise, false .

canLoad(String filePath, LoadOptions loadOptions)

public static boolean canLoad(String filePath, LoadOptions loadOptions)

Determines whether image can be loaded from the specified file path and optionally using the specified open options.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe file path.
loadOptionsLoadOptionsThe load options.

Returns: boolean - true if image can be loaded from the specified file; otherwise, false .

canLoadInternal_internalized(System.IO.Stream stream)

public static boolean canLoadInternal_internalized(System.IO.Stream stream)

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.Stream

Returns: boolean

canLoadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)

public static boolean canLoadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.Stream
loadOptionsLoadOptions

Returns: boolean

canSave(ImageOptionsBase options)

public boolean canSave(ImageOptionsBase options)

Determines whether image can be saved to the specified file format represented by the passed save options.

Parameters:

ParameterTypeDescription
optionsImageOptionsBaseThe save options to use.

Returns: boolean - true if image can be saved to the specified file format represented by the passed save options; otherwise, false .

close()

public void close()

Implements the Closable interface and can be used in the try-with-resources statement since JDK 1.7. This method simply call dispose method.

convertToAps_internalized(ImageOptionsBase options, int mode, Rectangle clippingRectangle)

public ApsPage convertToAps_internalized(ImageOptionsBase options, int mode, Rectangle clippingRectangle)

Converts to aps.

Parameters:

ParameterTypeDescription
optionsImageOptionsBaseThe options.
modeintThe mode.
clippingRectangleRectangleThe clipping rectangle.

Returns: com.aspose.foundation.rendering.ApsPage - The APS page.

create(ImageOptionsBase imageOptions, int width, int height)

public static Image create(ImageOptionsBase imageOptions, int width, int height)

Creates a new image using the specified create options.

Parameters:

ParameterTypeDescription
imageOptionsImageOptionsBaseThe image options.
widthintThe width.
heightintThe height.

Returns: Image - The newly created image.

create(Image[] images)

public static Image create(Image[] images)

Creates a new image using the specified images as pages

Parameters:

ParameterTypeDescription
imagesImage[]The images.

Returns: Image - The Image as IMultipageImage

create(Image[] images, boolean disposeImages)

public static Image create(Image[] images, boolean disposeImages)

Creates a new image the specified images as pages.

Parameters:

ParameterTypeDescription
imagesImage[]The images.
disposeImagesbooleanif set to true [dispose images].

Returns: Image - The Image as IMultipageImage

createInstance_internalized(PsdHeader header, IColorPalette palette, LinkedLayersRegistry linkedLayersRegistry)

public static Layer createInstance_internalized(PsdHeader header, IColorPalette palette, LinkedLayersRegistry linkedLayersRegistry)

Creates the new instance of the Layer class.

Parameters:

ParameterTypeDescription
headercom.aspose.internal.fileformats.psd.sections.PsdHeaderThe header.
paletteIColorPaletteThe palette.
linkedLayersRegistrycom.aspose.internal.fileformats.psd.layers.LinkedLayersRegistryThe LinkedLayersRegistry.

Returns: Layer - Returns the new instance of the Layer class.

createLayerState_internalized()

public final LayerState createLayerState_internalized()

Creates the new LayerState instance based on current Layer values.

Returns: LayerState - The new LayerState instance based on current Layer values.

createPartialRotateSaver_internalized(PartialRotater resizer, IPixelsSaver pixelsSaver, int width, int height)

public static IPartialProcessor createPartialRotateSaver_internalized(PartialRotater resizer, IPixelsSaver pixelsSaver, int width, int height)

Parameters:

ParameterTypeDescription
resizercom.aspose.internal.rotaters.PartialRotater
pixelsSavercom.aspose.internal.IPixelsSaver
widthint
heightint

Returns: com.aspose.internal.IPartialProcessor

create_internalized(System.IO.Stream stream)

public static Layer create_internalized(System.IO.Stream stream)

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.Stream

Returns: Layer

crop(Rectangle rectangle)

public void crop(Rectangle rectangle)

Cropping the image.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle.

crop(int leftShift, int rightShift, int topShift, int bottomShift)

public void crop(int leftShift, int rightShift, int topShift, int bottomShift)

Crop image with shifts.

Parameters:

ParameterTypeDescription
leftShiftintThe left shift.
rightShiftintThe right shift.
topShiftintThe top shift.
bottomShiftintThe bottom shift.

dispose()

public final void dispose()

Disposes the current instance.

dither(int ditheringMethod, int bitsCount)

public void dither(int ditheringMethod, int bitsCount)

Performs dithering on the current image.

Parameters:

ParameterTypeDescription
ditheringMethodintThe dithering method.
bitsCountintThe final bits count for dithering.

dither(int ditheringMethod, int bitsCount, IColorPalette customPalette)

public void dither(int ditheringMethod, int bitsCount, IColorPalette customPalette)

Performs dithering on the current image.

Parameters:

ParameterTypeDescription
ditheringMethodintThe dithering method.
bitsCountintThe final bits count for dithering.
customPaletteIColorPaletteThe custom palette for dithering.

doAfterSave_internalized(System.IO.Stream stream)

public void doAfterSave_internalized(System.IO.Stream stream)

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.Stream

doCrop_internalized(Rectangle rectangle)

public void doCrop_internalized(Rectangle rectangle)

Cropping the image.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle.

doResize_internalized(int newWidth, int newHeight, ImageResizeSettings settings)

public void doResize_internalized(int newWidth, int newHeight, ImageResizeSettings settings)

Resizes the image.

Parameters:

ParameterTypeDescription
newWidthintThe new width.
newHeightintThe new height.
settingsImageResizeSettingsThe resize settings.

doResize_internalized(int newWidth, int newHeight, int resizeType)

public void doResize_internalized(int newWidth, int newHeight, int resizeType)

Parameters:

ParameterTypeDescription
newWidthint
newHeightint
resizeTypeint

doRotate(float angle, boolean resizeProportionally, Color backgroundColor)

public void doRotate(float angle, boolean resizeProportionally, Color backgroundColor)

Parameters:

ParameterTypeDescription
anglefloat
resizeProportionallyboolean
backgroundColorColor

doRotateFlip_internalized(int rotateFlipType)

public void doRotateFlip_internalized(int rotateFlipType)

Rotates, flips, or rotates and flips the image.

Parameters:

ParameterTypeDescription
rotateFlipTypeintThe rotate flip type.

drawImage(Point location, RasterImage image)

public final void drawImage(Point location, RasterImage image)

Draws the image on layer.

Parameters:

ParameterTypeDescription
locationPointThe location.
imageRasterImageThe image.

equals(Object obj)

public boolean equals(Object obj)

Determines whether the specified Object, is equal to this instance.

Parameters:

ParameterTypeDescription
objjava.lang.ObjectThe Object to compare with this instance.

Returns: boolean - true if the specified Object is equal to this instance; otherwise, false .

filter(Rectangle rectangle, FilterOptionsBase options)

public void filter(Rectangle rectangle, FilterOptionsBase options)

Filters the specified rectangle.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle.
optionsFilterOptionsBaseThe options.

findAssignableResource_internalized(System.Type type)

public final LayerResource findAssignableResource_internalized(System.Type type)

Finds the assignable resource.

Parameters:

ParameterTypeDescription
typecom.aspose.ms.System.TypeThe type.

Returns: LayerResource -

findPattResource_internalized()

public final PattResource findPattResource_internalized()

Finds the PattResource

Returns: PattResource - The found resource or null

findResource_internalized(int typeToolKey)

public final LayerResource findResource_internalized(int typeToolKey)

Finds the resource by unique key

Parameters:

ParameterTypeDescription
typeToolKeyintThe type tool key.

Returns: LayerResource - Found resource or null

getAbsoluteBounds_internalized()

public final Rectangle getAbsoluteBounds_internalized()

Gets or sets the absolute bounds.

Value: The absolute bounds.

Returns: Rectangle

getArgb32Pixel(int x, int y)

public int getArgb32Pixel(int x, int y)

Gets an image 32-bit ARGB pixel.

Parameters:

ParameterTypeDescription
xintThe pixel x location.
yintThe pixel y location.

Returns: int - The 32-bit ARGB pixel for the specified location.

getAutoAdjustPalette()

public boolean getAutoAdjustPalette()

Gets a value indicating whether automatic adjust palette.

Returns: boolean - true if enable automatic adjust palette; otherwise, false .

getBackgroundColor()

public Color getBackgroundColor()

Gets or sets a value for the background color.

Returns: Color

getBitsPerPixel()

public int getBitsPerPixel()

Gets the image bits per pixel count.

Value: The image bits per pixel count.

Returns: int

getBlendClippedElements()

public final boolean getBlendClippedElements()

Gets or sets the blending of clipped element.

Value: The blending of clipped element.

Returns: boolean

getBlendModeKey()

public long getBlendModeKey()

Gets or sets the blend mode key.

Value: The blend mode key.

Returns: long

getBlendModeSignature()

public final int getBlendModeSignature()

Gets the blend mode signature.

Value: The blend mode signature.

Returns: int

getBlendingOptions()

public final BlendingOptions getBlendingOptions()

Gets the blending options.

Value: The blending options.

Returns: BlendingOptions

getBottom()

public final int getBottom()

Gets or sets the bottom layer position.

Value: The bottom layer position.

Returns: int

getBounds()

public Rectangle getBounds()

Gets the image bounds.

Returns: Rectangle - The image bounds.

getBufferSizeHint()

public final int getBufferSizeHint()

Gets the buffer size hint which is defined max allowed size for all internal buffers.

Value: The buffer size hint, in megabytes. Non-positive value means no memory limitation for internal buffers

Returns: int - the buffer size hint which is defined max allowed size for all internal buffers.

getBytesPerRowForFullMask_internalized(int bitDepth)

public final int getBytesPerRowForFullMask_internalized(int bitDepth)

Gets the bytes per row for full mask mode.

Parameters:

ParameterTypeDescription
bitDepthintThe bit depth.

Returns: int - Bytes needed for storing 1 row

getBytesPerRowForMask_internalized(int bitDepth)

public final int getBytesPerRowForMask_internalized(int bitDepth)

Gets the bytes per row.

Parameters:

ParameterTypeDescription
bitDepthintThe bit depth.

Returns: int - Bytes needed for storing 1 row

getBytesPerRow_internalized(int bitDepth)

public final int getBytesPerRow_internalized(int bitDepth)

Gets the bytes per row.

Parameters:

ParameterTypeDescription
bitDepthintThe bit depth.

Returns: int - Bytes needed for storing 1 row

getChannelInformation()

public final ChannelInformation[] getChannelInformation()

Gets or sets the channel information.

Value: The channel information.

Returns: com.aspose.psd.fileformats.psd.layers.ChannelInformation[]

getChannelsCount()

public final int getChannelsCount()

Gets the layer’s channels count.

Value: The layer’s channels count.

Returns: int

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getClipping()

public final byte getClipping()

Gets or sets the layer clipping. 0 = base, 1 = non-base.

Value: The layer clipping.

Returns: byte

getContainer()

public Image getContainer()

Gets the Image container.

Value: The Image container.

If this property is not null it indicates the image is contained whithin another image.

Returns: Image

getDataStreamContainer()

public StreamContainer getDataStreamContainer()

Gets the object’s data stream.

Returns: StreamContainer - The object’s data stream.

getDeeplyAdjustPalette_internalized()

public boolean getDeeplyAdjustPalette_internalized()

Gets the deeply adjust palette.

Returns: boolean - The deeply adjust palette.

getDefaultArgb32Pixels(Rectangle rectangle)

public int[] getDefaultArgb32Pixels(Rectangle rectangle)

Gets the default 32-bit ARGB pixels array.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to get pixels for.

Returns: int[] - The default pixels array.

getDefaultOptions(Object[] args)

public ImageOptionsBase getDefaultOptions(Object[] args)

Gets the default options.

Parameters:

ParameterTypeDescription
argsjava.lang.Object[]The arguments.

Returns: ImageOptionsBase - Default options

getDefaultPixels(Rectangle rectangle, IPartialArgb32PixelLoader partialPixelLoader)

public void getDefaultPixels(Rectangle rectangle, IPartialArgb32PixelLoader partialPixelLoader)

Gets the default pixels array using partial pixel loader.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to get pixels for.
partialPixelLoaderIPartialArgb32PixelLoaderThe partial pixel loader.

getDefaultRawData(Rectangle rectangle, IPartialRawDataLoader partialRawDataLoader, RawDataSettings rawDataSettings)

public void getDefaultRawData(Rectangle rectangle, IPartialRawDataLoader partialRawDataLoader, RawDataSettings rawDataSettings)

Gets the default raw data array using partial pixel loader.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to get pixels for.
partialRawDataLoaderIPartialRawDataLoaderThe partial raw data loader.
rawDataSettingsRawDataSettingsThe raw data settings.

getDefaultRawData(Rectangle rectangle, RawDataSettings rawDataSettings)

public byte[] getDefaultRawData(Rectangle rectangle, RawDataSettings rawDataSettings)

Gets the default raw data array.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to get raw data for.
rawDataSettingsRawDataSettingsThe raw data settings.

Returns: byte[] - The default raw data array.

getDisplayName()

public final String getDisplayName()

Gets the display name of the layer.

Value: The display name of the layer.

Returns: java.lang.String

getDisposed()

public final boolean getDisposed()

Gets a value indicating whether this instance is disposed.

Returns: boolean - true if disposed; otherwise, false .

getExtraLength()

public final int getExtraLength()

Gets the layer extra information length in bytes.

Value: The extra layer length.

Returns: int

getFileFormat()

public long getFileFormat()

Gets a value of file format

Returns: long

getFileFormat(System.IO.Stream stream)

public static long getFileFormat(System.IO.Stream stream)

Gets the file format.

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.StreamThe stream.

The file format determined does not mean that the specified image may be loaded. Use one of the CanLoad method overloads to determine whether stream may be loaded. |

Returns: long - The determined file format.

getFileFormat(InputStream stream)

public static long getFileFormat(InputStream stream)

Gets the file format.

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe stream.

The file format determined does not mean that the specified image may be loaded. Use one of the CanLoad method overloads to determine whether stream may be loaded. |

Returns: long - The determined file format.

getFileFormat(String filePath)

public static long getFileFormat(String filePath)

Gets the file format.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe file path.

The file format determined does not mean that the specified image may be loaded. Use one of the CanLoad method overloads to determine whether file may be loaded. |

Returns: long - The determined file format.

getFillOpacity()

public final int getFillOpacity()

Gets or sets the fill opacity.

Returns: int

getFiller()

public final byte getFiller()

Gets or sets the layer filler.

Value: The layer filler.

Returns: byte

getFittingRectangle(Rectangle rectangle, int width, int height)

public static Rectangle getFittingRectangle(Rectangle rectangle, int width, int height)

Gets rectangle which fits the current image.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to get fitting rectangle for.
widthintThe object width.
heightintThe object height.

Returns: Rectangle - The fitting rectangle or exception if no fitting rectangle can be found.

getFittingRectangle(Rectangle rectangle, int[] pixels, int width, int height)

public static Rectangle getFittingRectangle(Rectangle rectangle, int[] pixels, int width, int height)

Gets rectangle which fits the current image.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to get fitting rectangle for.
pixelsint[]The 32-bit ARGB pixels.
widthintThe object width.
heightintThe object height.

Returns: Rectangle - The fitting rectangle or exception if no fitting rectangle can be found.

getFlags()

public final byte getFlags()

Gets or sets the layer flags. bit 0 = transparency protected; bit 1 = visible; bit 2 = obsolete; bit 3 = 1 for Photoshop 5.0 and later, tells if bit 4 has useful information; bit 4 = pixel data irrelevant to appearance of document.

Value: The layer flags.

Returns: byte

getFoldersHierarchy_internalized()

public final System.Collections.Generic.List<Layer> getFoldersHierarchy_internalized()

Gets the list of LayerGroup folders hierarchy of current layer.

Returns: com.aspose.ms.System.Collections.Generic.List<com.aspose.psd.fileformats.psd.layers.Layer> - Returns the list of LayerGroup folders hierarchy of current layer.

getFormatSpecificPalette_internalized()

public IColorPalette getFormatSpecificPalette_internalized()

Gets palette from format-specific places

Returns: IColorPalette - Format-specific IColorPalette .

getGUID_internalized()

public final String getGUID_internalized()

Gets the unique identifier of this Layer instance.

Returns: java.lang.String

getHeader_internalized()

public final PsdHeader getHeader_internalized()

Gets or sets the header.

Value: The header.

Returns: com.aspose.internal.fileformats.psd.sections.PsdHeader

getHeight()

public int getHeight()

Gets the image height.

Value: The image height.

Returns: int

getHorizontalResolution()

public double getHorizontalResolution()

Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage .

Returns: double - The horizontal resolution.

Note by default this value is always 96 since different platforms cannot return the screen resolution. You may consider using the SetResolution method for updating both resolution values in single call.

getImageOpacity()

public float getImageOpacity()

Gets opacity of this image.

Returns: float - The opacity value between 0.0 (fully transparent) and 1.0 (fully opaque).

getInnerDataTransformer_internalized()

public final IInnerDataTransformer getInnerDataTransformer_internalized()

Gets the inner data transformer.

Value: The inner data transformer.

Returns: com.aspose.internal.IInnerDataTransformer - the inner data transformer.

getInterruptMonitor()

public InterruptMonitor getInterruptMonitor()

Gets the interrupt monitor.

Returns: InterruptMonitor - the interrupt monitor.

getLayerBlendingRangesData()

public final LayerBlendingRangesData getLayerBlendingRangesData()

Gets or sets the layer blending ranges data.

Value: The layer blending ranges data.

Returns: LayerBlendingRangesData

getLayerCreationDateTime()

public final Date getLayerCreationDateTime()

Gets or sets the layer creation date time.

Value: The layer’s creation date time. If there is no data about creation DateTime then returns Unix Time first epoch

Returns: java.util.Date

getLayerCreationDateTime_internalized()

public final System.DateTime getLayerCreationDateTime_internalized()

Returns: com.aspose.ms.System.DateTime

getLayerLock()

public final int getLayerLock()

Gets or sets the layer lock. Note that if flag LayerFlags.TransparencyProtected is set it will be overwritten by layer lock flag. To return LayerFlags.TransparencyProtected flag need to apply for layer option layer.Flags |= LayerFlags.TransparencyProtected

Value: The layer lock.

Returns: int

getLayerMaskData()

public final LayerMaskData getLayerMaskData()

Gets or sets the layer mask data.

Value: The layer mask data.

Returns: LayerMaskData

getLayerOptions()

public final PsdOptions getLayerOptions()

Gets the layer options.

Value: The layer options.

Returns: PsdOptions

getLayerPalette_internalized()

public final IColorPalette getLayerPalette_internalized()

Gets or sets the layer palette.

Value: The layer palette.

Returns: IColorPalette

getLayerType_internalized()

public byte getLayerType_internalized()

Gets the type of the layer.

Value: The type of the layer.

Returns: byte

getLeft()

public final int getLeft()

Gets or sets the left layer position.

Value: The left layer position.

Returns: int

getLength()

public final int getLength()

Gets the overall layer length in bytes.

Returns: int

getMaxAllowedAllocationForPartialRotateSave_internalized()

public static int getMaxAllowedAllocationForPartialRotateSave_internalized()

Gets or sets the max allowed allocation for partial rotate save.

Returns: int - The max allowed allocation for partial rotate save.

getMemoryMgr_internalized()

public MemMgr getMemoryMgr_internalized()

Gets the memory manager.

Value: The memory manager.

Returns: com.aspose.internal.memorymanagement.MemMgr - the memory manager.

getModifyDate(boolean useDefault)

public Date getModifyDate(boolean useDefault)

Gets the date and time the resource image was last modified.

Parameters:

ParameterTypeDescription
useDefaultbooleanif set to true uses the information from FileInfo as default value.

Returns: java.util.Date - The date and time the resource image was last modified.

getModifyDate_internalized(boolean useDefault)

public System.DateTime getModifyDate_internalized(boolean useDefault)

Parameters:

ParameterTypeDescription
useDefaultboolean

Returns: com.aspose.ms.System.DateTime

getName()

public final String getName()

Gets or sets the layer name.

Value: The layer name.

Returns: java.lang.String

getOpacity()

public final byte getOpacity()

Gets or sets the layer opacity. 0 = transparent, 255 = opaque.

Value: The layer opacity.

Returns: byte

getOpacityTotal_internalized()

public final byte getOpacityTotal_internalized()

Gets the total opacity. The total opacity is the multiplication of the Layer Opacity and Layer Fill Opacity. It used for layer blending

Value: The total opacity.

Returns: byte

getOriginalOptions()

public ImageOptionsBase getOriginalOptions()

Gets the options based on the original file settings. This can be helpful to keep bit-depth and other parameters of the original image unchanged. For example, if we load a black-white PNG image with 1 bit per pixel and then save it using the DataStreamSupporter.Save(string) method, the output PNG image with 8-bit per pixel will be produced. To avoid it and save PNG image with 1-bit per pixel, use this method to get corresponding saving options and pass them to the Image.Save(string, ImageOptionsBase) method as the second parameter.

Returns: ImageOptionsBase - The options based on the original file settings.

getPaintableImage_internalized(ImageOptionsBase paintableOptions)

public Image getPaintableImage_internalized(ImageOptionsBase paintableOptions)

Gets the paintable image.

Parameters:

ParameterTypeDescription
paintableOptionsImageOptionsBase

Returns: Image - the paintable image.

getPalette()

public IColorPalette getPalette()

Gets the color palette. The color palette is not used when pixels are represented directly.

Returns: IColorPalette - The color palette.

getPixel(int x, int y)

public Color getPixel(int x, int y)

Gets an image pixel.

Parameters:

ParameterTypeDescription
xintThe pixel x location.
yintThe pixel y location.

Returns: Color - The pixel color for the specified location.

getPremultiplyComponents()

public boolean getPremultiplyComponents()

Gets or sets a value indicating whether the image components must be premultiplied.

Returns: boolean - true if the image components must be premultiplied; otherwise, false .

getPrivateFontCache_internalized()

public final PalPrivateFontCache getPrivateFontCache_internalized()

Creates the private font cache.

Returns: com.aspose.foundation.pal.PalPrivateFontCache - The private font cache.

getProgressEventHandler()

public final ProgressEventHandler getProgressEventHandler()

Gets the progress event handler information.

Returns: ProgressEventHandler - the progress event handler information.

getProgressEventHandlerInfo()

public final ProgressEventHandlerInfo getProgressEventHandlerInfo()

Gets the progress event handler information.

Value: The progress event handler information.

Returns: ProgressEventHandlerInfo - the progress event handler information.

getProportionalHeight(int width, int height, int newWidth)

public static int getProportionalHeight(int width, int height, int newWidth)

Gets a proportional height.

Parameters:

ParameterTypeDescription
widthintThe width.
heightintThe height.
newWidthintThe new width.

Returns: int - The proportional height.

getProportionalWidth(int width, int height, int newHeight)

public static int getProportionalWidth(int width, int height, int newHeight)

Gets a proportional width.

Parameters:

ParameterTypeDescription
widthintThe width.
heightintThe height.
newHeightintThe new height.

Returns: int - The proportional width.

getRawCustomColorConverter()

public IColorConverter getRawCustomColorConverter()

Gets or sets the custom color converter

Returns: IColorConverter - The custom color converter

getRawDataFormat()

public PixelDataFormat getRawDataFormat()

Gets the raw data format.

Returns: PixelDataFormat - The raw data format.

getRawDataSettings()

public RawDataSettings getRawDataSettings()

Gets the current raw data settings. Note when using these settings the data loads without conversion.

Returns: RawDataSettings

getRawFallbackIndex()

public int getRawFallbackIndex()

Gets or sets the fallback index to use when palette index is out of bounds

Returns: int - The fallback index to use when palette index is out of bounds

getRawIndexedColorConverter()

public IIndexedColorConverter getRawIndexedColorConverter()

Gets or sets the indexed color converter

Returns: IIndexedColorConverter - The indexed color converter

getRawLineSize()

public int getRawLineSize()

Gets the raw line size in bytes.

Returns: int - The raw line size in bytes.

getResources()

public final LayerResource[] getResources()

Gets or sets the layer resources.

Value: The layer resources.

Returns: com.aspose.psd.fileformats.psd.layers.LayerResource[]

getRight()

public final int getRight()

Gets or sets the right layer position.

Value: The right layer position.

Returns: int

getRotateMode()

public static int getRotateMode()

Gets or sets the rotate mode.

Returns: int - The rotate mode.

getSheetColorHighlight()

public final short getSheetColorHighlight()

Gets or sets the decorative sheet color highlight in layers’ list

Value: The sheet color highlight.

Returns: short

getSize()

public Size getSize()

Gets the image size.

Returns: Size - The image size.

getSkewAngle()

public final float getSkewAngle()

Gets the skew angle. This method is applicable to scanned text documents, to determine the skew angle when scanning.

Returns: float - The skew angle, in degrees.

getSourceImagePath_internalized()

public String getSourceImagePath_internalized()

Gets the file path of source image if it’s exist. Returns an empty string if can’t find the source path.

Returns: java.lang.String - The file path of source image.

getSyncRoot_internalized()

public final Object getSyncRoot_internalized()

Gets the synchronize root.

Value: The synchronize root.

Returns: java.lang.Object

getTop()

public final int getTop()

Gets or sets the top layer position.

Value: The top layer position.

Returns: int

getTransparentColor()

public Color getTransparentColor()

Gets the image transparent color.

Returns: Color

getUpdateXmpData()

public boolean getUpdateXmpData()

Gets or sets a value indicating whether to update the XMP metadata.

Returns: boolean - true if update the XMP metadata; otherwise, false .

getUseMemoryStrategy_internalized()

public boolean getUseMemoryStrategy_internalized()

Gets a value indicating whether object uses memory optimization strategy

Value: true if object uses memory optimization strategy; otherwise, false .

Returns: boolean - a value indicating whether object uses memory optimization strategy

getUseRawData()

public boolean getUseRawData()

Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.

Returns: boolean - true if use raw data loading when the raw data loading is available.; otherwise, false .

getUsedPalette_internalized()

public final IColorPalette getUsedPalette_internalized()

Gets the used palette.

Returns: IColorPalette - the used palette.

getVentureLicense_internalized()

public Object getVentureLicense_internalized()

Gets the venture license.

Returns: java.lang.Object - Teh venture license as object.

getVerticalResolution()

public double getVerticalResolution()

Gets or sets the vertical resolution, in pixels per inch, of this RasterImage .

Returns: double - The vertical resolution.

Note by default this value is always 96 since different platforms cannot return the screen resolution. You may consider using the SetResolution method for updating both resolution values in single call.

getWidth()

public int getWidth()

Gets the image width.

Value: The image width.

Returns: int

getXmpData()

public XmpPacketWrapper getXmpData()

Gets or sets the XMP metadata.

Returns: XmpPacketWrapper - The XMP metadata.

grayscale()

public void grayscale()

Transformation of an image to its grayscale representation

hasAlpha()

public boolean hasAlpha()

Gets a value indicating whether this instance has alpha.

Value: true if this instance has alpha; otherwise, false .

Returns: boolean

hasBackgroundColor()

public boolean hasBackgroundColor()

Gets a value indicating whether image has background color.

Returns: boolean

hasImageChanged_internalized()

public boolean hasImageChanged_internalized()

Gets or sets a value indicating whether this instance of image has changed after loading.

Returns: boolean - true if this instance has image changed; otherwise, false .

hasTransparentColor()

public boolean hasTransparentColor()

Gets a value indicating whether image has transparent color.

Returns: boolean

hashCode()

public int hashCode()

Returns a hash code for this instance.

Returns: int - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

incrementProgressMaxValue_internalized(int value)

public final void incrementProgressMaxValue_internalized(int value)

Gets or sets the progress max value

Value: The progress max value

Parameters:

ParameterTypeDescription
valueint

indicateProgress_internalized(EventType eventType)

public final void indicateProgress_internalized(EventType eventType)

Indicates the progress.

Parameters:

ParameterTypeDescription
eventTypeEventType

isCached()

public boolean isCached()

Gets a value indicating whether image data is cached currently.

Returns: boolean - true if image data is cached; otherwise, false .

isLayerValid_internalized()

public boolean isLayerValid_internalized()

Detects if layer is valid for saving to a file.

Returns: boolean -

isRawDataAvailable()

public boolean isRawDataAvailable()

Gets a value indicating whether raw data loading is available.

Returns: boolean - true if this raw data loading is available; otherwise, false .

isUsePalette()

public boolean isUsePalette()

Gets a value indicating whether the image palette is used.

Value: true if the palette is used in the image; otherwise, false .

Returns: boolean - a value indicating whether the image palette is used.

isVisible()

public final boolean isVisible()

Gets or sets a value indicating whether the layer is visible

Value: true if this instance is visible; otherwise, false .

Returns: boolean

isVisibleInGroup()

public boolean isVisibleInGroup()

Gets a value indicating whether this instance is visible in group(If layer is not in group it means root group).

Value: true if this instance is visible in group; otherwise, false .

Returns: boolean

load(InputStream stream)

public static Image load(InputStream stream)

Loads a new image from the specified stream.

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe stream to load image from.

Returns: Image - The loaded image.

load(InputStream stream, LoadOptions loadOptions)

public static Image load(InputStream stream, LoadOptions loadOptions)

Loads a new image from the specified stream.

Parameters:

ParameterTypeDescription
streamjava.io.InputStreamThe stream to load image from.
loadOptionsLoadOptionsThe load options.

Returns: Image - The loaded image.

load(RandomAccessFile file)

public static Image load(RandomAccessFile file)

Loads a new image from the specified stream.

Parameters:

ParameterTypeDescription
filejava.io.RandomAccessFileThe file to load image from.

Returns: Image - The loaded image.

load(RandomAccessFile file, LoadOptions loadOptions)

public static Image load(RandomAccessFile file, LoadOptions loadOptions)

Loads a new image from the specified stream.

Parameters:

ParameterTypeDescription
filejava.io.RandomAccessFileThe file to load image from.
loadOptionsLoadOptionsThe load options.

Returns: Image - The loaded image.

load(String filePath)

public static Image load(String filePath)

Loads a new image from the specified file.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe file path to load image from.

Returns: Image - The loaded image.

load(String filePath, LoadOptions loadOptions)

public static Image load(String filePath, LoadOptions loadOptions)

Loads a new image from the specified file.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe file path to load image from.
loadOptionsLoadOptionsThe load options.

Returns: Image - The loaded image.

loadArgb32Pixels(Rectangle rectangle)

public int[] loadArgb32Pixels(Rectangle rectangle)

Loads 32-bit ARGB pixels.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to load pixels from.

Returns: int[] - The loaded 32-bit ARGB pixels array.

loadArgb64Pixels(Rectangle rectangle)

public long[] loadArgb64Pixels(Rectangle rectangle)

Loads 64-bit ARGB pixels.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to load pixels from.

Returns: long[] - The loaded 64-bit ARGB pixels array.

loadCmyk32Pixels(Rectangle rectangle)

public int[] loadCmyk32Pixels(Rectangle rectangle)

Loads pixels in CMYK format.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to load pixels from.

Returns: int[] - The loaded CMYK pixels presentes as 32-bit inateger values.

loadCmykPixels(Rectangle rectangle)

public CmykColor[] loadCmykPixels(Rectangle rectangle)

Loads pixels in CMYK format. This method is deprecated. Please use more effective the loadCmyk32Pixels(Rectangle) method.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to load pixels from.

Returns: com.aspose.psd.CmykColor[] - The loaded CMYK pixels array.

loadInternal_internalized(System.IO.Stream stream)

public static Image loadInternal_internalized(System.IO.Stream stream)

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.Stream

Returns: Image

loadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)

public static Image loadInternal_internalized(System.IO.Stream stream, LoadOptions loadOptions)

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.Stream
loadOptionsLoadOptions

Returns: Image

loadPartialArgb32Pixels(Rectangle rectangle, IPartialArgb32PixelLoader partialPixelLoader)

public void loadPartialArgb32Pixels(Rectangle rectangle, IPartialArgb32PixelLoader partialPixelLoader)

Loads 32-bit ARGB pixels partially by packs.

Parameters:

ParameterTypeDescription
rectangleRectangleThe desired rectangle.
partialPixelLoaderIPartialArgb32PixelLoaderThe 32-bit ARGB pixel loader.

loadPartialPixels(Rectangle desiredRectangle, IPartialPixelLoader pixelLoader)

public void loadPartialPixels(Rectangle desiredRectangle, IPartialPixelLoader pixelLoader)

Loads pixels partially by packs.

Parameters:

ParameterTypeDescription
desiredRectangleRectangleThe desired rectangle.
pixelLoaderIPartialPixelLoaderThe pixel loader.

loadPixels(Rectangle rectangle)

public Color[] loadPixels(Rectangle rectangle)

Loads pixels.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to load pixels from.

Returns: com.aspose.psd.Color[] - The loaded pixels array.

loadRawData(Rectangle rectangle, RawDataSettings rawDataSettings, IPartialRawDataLoader rawDataLoader)

public void loadRawData(Rectangle rectangle, RawDataSettings rawDataSettings, IPartialRawDataLoader rawDataLoader)

Loads raw image data using the partial processing mechanism.

Parameters:

ParameterTypeDescription
rectangleRectangleThe desired rectangular area of the image to load data from.
rawDataSettingsRawDataSettingsThe raw data settings.
rawDataLoaderIPartialRawDataLoaderThe raw data loader.

loadRawData(Rectangle rectangle, Rectangle destImageBounds, RawDataSettings rawDataSettings, IPartialRawDataLoader rawDataLoader)

public void loadRawData(Rectangle rectangle, Rectangle destImageBounds, RawDataSettings rawDataSettings, IPartialRawDataLoader rawDataLoader)

Loads raw data.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to load raw data from.
destImageBoundsRectangleThe dest image bounds.
rawDataSettingsRawDataSettingsThe raw data settings to use for loaded data. Note if data is not in the format specified then data conversion will be performed.
rawDataLoaderIPartialRawDataLoaderThe raw data loader.

load_internalized(System.IO.Stream stream)

public static Image load_internalized(System.IO.Stream stream)

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.Stream

Returns: Image

load_internalized(System.IO.Stream stream, long startPosition)

public static Image load_internalized(System.IO.Stream stream, long startPosition)

Loads a new image from the specified stream.

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.StreamThe stream to load image from.
startPositionlongThe start position to load image from.

Returns: Image - The loaded image.

load_internalized(System.IO.Stream stream, long startPosition, LoadOptions loadOptions)

public static Image load_internalized(System.IO.Stream stream, long startPosition, LoadOptions loadOptions)

Loads a new image from the specified stream.

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.StreamThe stream to load image from.
startPositionlongThe start position to load image from.
loadOptionsLoadOptionsThe load options.

Returns: Image - The loaded image.

mergeLayerTo(Layer layerToMergeInto)

public void mergeLayerTo(Layer layerToMergeInto)

Merges the layer to specified layer

Parameters:

ParameterTypeDescription
layerToMergeIntoLayerThe layer to merge into.

normalizeAngle()

public final void normalizeAngle()

Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses .getSkewAngle and .rotate(float) methods.

normalizeAngle(boolean resizeProportionally, Color backgroundColor)

public void normalizeAngle(boolean resizeProportionally, Color backgroundColor)

Normalizes the angle. This method is applicable to scanned text documents to get rid of the skewed scan. This method uses .getSkewAngle and .rotate(float, boolean, Color) methods.

Parameters:

ParameterTypeDescription
resizeProportionallybooleanif set to true you will have your image size changed according to rotated rectangle (corner points) projections in other case that leaves dimensions untouched and only internal image contents are rotated.
backgroundColorColorColor of the background.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

onContainerSet_internalized()

public void onContainerSet_internalized()

Invoke when container of this Image was set.

readArgb32ScanLine(int scanLineIndex)

public int[] readArgb32ScanLine(int scanLineIndex)

Reads the whole scan line by the specified scan line index.

Parameters:

ParameterTypeDescription
scanLineIndexintZero based index of the scan line.

Returns: int[] - The scan line 32-bit ARGB color values array.

readScanLine(int scanLineIndex)

public Color[] readScanLine(int scanLineIndex)

Reads the whole scan line by the specified scan line index.

Parameters:

ParameterTypeDescription
scanLineIndexintZero based index of the scan line.

Returns: com.aspose.psd.Color[] - The scan line pixel color values array.

removeResource_internalized(LayerResource resource)

public final void removeResource_internalized(LayerResource resource)

Removes the resource.

Parameters:

ParameterTypeDescription
resourceLayerResourceThe resource.

replaceColor(Color oldColor, byte oldColorDiff, Color newColor)

public void replaceColor(Color oldColor, byte oldColorDiff, Color newColor)

Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.

Parameters:

ParameterTypeDescription
oldColorColorOld color to be replaced.
oldColorDiffbyteAllowed difference in old color to be able to widen replaced color tone.
newColorColorNew color to replace old color with.

replaceColor(int oldColorArgb, byte oldColorDiff, int newColorArgb)

public void replaceColor(int oldColorArgb, byte oldColorDiff, int newColorArgb)

Replaces one color to another with allowed difference and preserves original alpha value to save smooth edges.

Parameters:

ParameterTypeDescription
oldColorArgbintOld color ARGB value to be replaced.
oldColorDiffbyteAllowed difference in old color to be able to widen replaced color tone.
newColorArgbintNew color ARGB value to replace old color with.

replaceNonTransparentColors(Color newColor)

public void replaceNonTransparentColors(Color newColor)

Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.

Parameters:

ParameterTypeDescription
newColorColorNew color to replace non transparent colors with.

replaceNonTransparentColors(int newColorArgb)

public void replaceNonTransparentColors(int newColorArgb)

Replaces all non-transparent colors with new color and preserves original alpha value to save smooth edges. Note: if you use it on images without transparency, all colors will be replaced with a single one.

Parameters:

ParameterTypeDescription
newColorArgbintNew color ARGB value to replace non transparent colors with.

resize(int newWidth, int newHeight)

public void resize(int newWidth, int newHeight)

Resizes the image. The default ResizeType.LeftTopToLeftTop is used.

Parameters:

ParameterTypeDescription
newWidthintThe new width.
newHeightintThe new height.

resize(int newWidth, int newHeight, ImageResizeSettings settings)

public void resize(int newWidth, int newHeight, ImageResizeSettings settings)

Resizes the image.

Parameters:

ParameterTypeDescription
newWidthintThe new width.
newHeightintThe new height.
settingsImageResizeSettingsThe resize settings.

resize(int newWidth, int newHeight, int resizeType)

public void resize(int newWidth, int newHeight, int resizeType)

Resizes the image.

Parameters:

ParameterTypeDescription
newWidthintThe new width.
newHeightintThe new height.
resizeTypeintThe resize type.

resizeChannelsData_internalized(Rectangle rect)

public void resizeChannelsData_internalized(Rectangle rect)

Resizes the channels data

Parameters:

ParameterTypeDescription
rectRectangleThe rect.

resizeHeightProportionally(int newHeight)

public void resizeHeightProportionally(int newHeight)

Resizes the height proportionally.

Parameters:

ParameterTypeDescription
newHeightintThe new height.

resizeHeightProportionally(int newHeight, ImageResizeSettings settings)

public void resizeHeightProportionally(int newHeight, ImageResizeSettings settings)

Resizes the height proportionally.

Parameters:

ParameterTypeDescription
newHeightintThe new height.
settingsImageResizeSettingsThe image resize settings.

resizeHeightProportionally(int newHeight, int resizeType)

public void resizeHeightProportionally(int newHeight, int resizeType)

Resizes the height proportionally.

Parameters:

ParameterTypeDescription
newHeightintThe new height.
resizeTypeintType of the resize.

resizeWidthProportionally(int newWidth)

public void resizeWidthProportionally(int newWidth)

Resizes the width proportionally.

Parameters:

ParameterTypeDescription
newWidthintThe new width.

resizeWidthProportionally(int newWidth, ImageResizeSettings settings)

public void resizeWidthProportionally(int newWidth, ImageResizeSettings settings)

Resizes the width proportionally.

Parameters:

ParameterTypeDescription
newWidthintThe new width.
settingsImageResizeSettingsThe image resize settings.

resizeWidthProportionally(int newWidth, int resizeType)

public void resizeWidthProportionally(int newWidth, int resizeType)

Resizes the width proportionally.

Parameters:

ParameterTypeDescription
newWidthintThe new width.
resizeTypeintType of the resize.

resizeWithScale_internalized(double scaleX, double scaleY, int resizeType)

public final void resizeWithScale_internalized(double scaleX, double scaleY, int resizeType)

Resizes the layer with the specified inverse scale. (new width = old width / scale; new height = old height / scale)

Parameters:

ParameterTypeDescription
scaleXdoubleThe scale X.
scaleYdoubleThe scale Y.
resizeTypeintType of the resize.

rotate(float angle)

public void rotate(float angle)

Rotate image around the center.

Parameters:

ParameterTypeDescription
anglefloatThe rotate angle in degrees. Positive values will rotate clockwise.

rotate(float angle, boolean resizeProportionally, Color backgroundColor)

public void rotate(float angle, boolean resizeProportionally, Color backgroundColor)

Rotate image around the center.

Parameters:

ParameterTypeDescription
anglefloatThe rotate angle in degrees. Positive values will rotate clockwise.
resizeProportionallybooleanif set to true you will have your image size changed according to rotated rectangle (corner points) projections in other case that leaves dimensions untouched and only internal image contents are rotated.
backgroundColorColorColor of the background.

rotateFlip(int rotateFlipType)

public void rotateFlip(int rotateFlipType)

Rotates, flips, or rotates and flips the image.

Parameters:

ParameterTypeDescription
rotateFlipTypeint

save()

public final void save()

Saves the image data to the underlying stream.

save(System.IO.Stream stream)

public void save(System.IO.Stream stream)

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.Stream

save(OutputStream stream)

public void save(OutputStream stream)

Saves the object’s data to the specified stream.

Parameters:

ParameterTypeDescription
streamjava.io.OutputStreamThe stream to save the object’s data to.

save(OutputStream stream, ImageOptionsBase optionsBase)

public void save(OutputStream stream, ImageOptionsBase optionsBase)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

ParameterTypeDescription
streamjava.io.OutputStreamThe stream to save the image’s data to.
optionsBaseImageOptionsBaseThe save options.

save(OutputStream dstStream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

public void save(OutputStream dstStream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

ParameterTypeDescription
dstStreamjava.io.OutputStreamThe stream to save the image’s data to.
optionsBaseImageOptionsBaseThe save options.
boundsRectangleRectangleThe destination image bounds rectangle. Set the empty rectangle for use sourse bounds.

save(RandomAccessFile file)

public void save(RandomAccessFile file)

Saves the object’s data to the specified stream.

Parameters:

ParameterTypeDescription
filejava.io.RandomAccessFileThe stream to save the object’s data to.

save(RandomAccessFile file, ImageOptionsBase options)

public void save(RandomAccessFile file, ImageOptionsBase options)

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

ParameterTypeDescription
filejava.io.RandomAccessFileThe file to save the image’s data to.
optionsImageOptionsBaseThe options.

save(RandomAccessFile file, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

public void save(RandomAccessFile file, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

ParameterTypeDescription
filejava.io.RandomAccessFileThe file to save the image’s data to.
optionsBaseImageOptionsBaseThe save options.
boundsRectangleRectangleThe destination image bounds rectangle. Set the empty rectangle for use sourse bounds.

save(String filePath)

public void save(String filePath)

Saves the object’s data to the specified file location.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe file path to save the object’s data to.

save(String filePath, boolean overWrite)

public void save(String filePath, boolean overWrite)

Saves the object’s data to the specified file location.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe file path to save the object’s data to.
overWritebooleanif set to true over write the file contents, otherwise append will occur.

save(String filePath, ImageOptionsBase options)

public void save(String filePath, ImageOptionsBase options)

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe file path.
optionsImageOptionsBaseThe options.

save(String filePath, ImageOptionsBase options, Rectangle boundsRectangle)

public void save(String filePath, ImageOptionsBase options, Rectangle boundsRectangle)

Saves the object’s data to the specified file location in the specified file format according to save options.

Parameters:

ParameterTypeDescription
filePathjava.lang.StringThe file path.
optionsImageOptionsBaseThe options.
boundsRectangleRectangleThe destination image bounds rectangle. Set the empty rectangle for use sourse bounds.

saveArgb32Pixels(Rectangle rectangle, int[] pixels)

public void saveArgb32Pixels(Rectangle rectangle, int[] pixels)

Saves the 32-bit ARGB pixels.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to save pixels to.
pixelsint[]The 32-bit ARGB pixels array.

saveCmyk32Pixels(Rectangle rectangle, int[] pixels)

public void saveCmyk32Pixels(Rectangle rectangle, int[] pixels)

Saves the pixels.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to save pixels to.
pixelsint[]The CMYK pixels presented as the 32-bit integer values.

saveCmykPixels(Rectangle rectangle, CmykColor[] pixels)

public void saveCmykPixels(Rectangle rectangle, CmykColor[] pixels)

Saves the pixels. This method is deprecated. Please use more effective the saveCmyk32Pixels(Rectangle, int[]) method.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to save pixels to.
pixelsCmykColor[]The CMYK pixels array.

savePixels(Rectangle rectangle, Color[] pixels)

public void savePixels(Rectangle rectangle, Color[] pixels)

Saves the pixels.

Parameters:

ParameterTypeDescription
rectangleRectangleThe rectangle to save pixels to.
pixelsColor[]The pixels array.

saveRawData(byte[] data, int dataOffset, Rectangle rectangle, RawDataSettings rawDataSettings)

public void saveRawData(byte[] data, int dataOffset, Rectangle rectangle, RawDataSettings rawDataSettings)

Saves the raw data.

Parameters:

ParameterTypeDescription
databyte[]The raw data.
dataOffsetintThe starting raw data offset.
rectangleRectangleThe raw data rectangle.
rawDataSettingsRawDataSettingsThe raw data settings the data is in.

save_internalized(System.IO.Stream stream)

public void save_internalized(System.IO.Stream stream)

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.Stream

save_internalized(System.IO.Stream stream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

public void save_internalized(System.IO.Stream stream, ImageOptionsBase optionsBase, Rectangle boundsRectangle)

Saves the image’s data to the specified stream in the specified file format according to save options.

Parameters:

ParameterTypeDescription
streamcom.aspose.ms.System.IO.Stream
optionsBaseImageOptionsBase
boundsRectangleRectangle

save_internalized(StreamContainer streamContainer, int psdVersion, int bitDepth)

public final void save_internalized(StreamContainer streamContainer, int psdVersion, int bitDepth)

Saves data to the specified stream container.

Parameters:

ParameterTypeDescription
streamContainerStreamContainerThe stream container.
psdVersionintThe PSD version.
bitDepthintThe bit depth.

setAbsoluteBounds_internalized(Rectangle value)

public final void setAbsoluteBounds_internalized(Rectangle value)

Gets or sets the absolute bounds.

Value: The absolute bounds.

Parameters:

ParameterTypeDescription
valueRectangle

setArgb32Pixel(int x, int y, int argb32Color)

public void setArgb32Pixel(int x, int y, int argb32Color)

Sets an image 32-bit ARGB pixel for the specified position.

Parameters:

ParameterTypeDescription
xintThe pixel x location.
yintThe pixel y location.
argb32ColorintThe 32-bit ARGB pixel for the specified position.

setAutoAdjustPalette(boolean value)

public void setAutoAdjustPalette(boolean value)

Sets a value indicating whether automatic adjust palette.

Parameters:

ParameterTypeDescription
valuebooleantrue if enable automatic adjust palette; otherwise, false .

setBackgroundColor(boolean value)

public void setBackgroundColor(boolean value)

Gets or sets a value indicating whether image has background color.

Parameters:

ParameterTypeDescription
valueboolean

setBackgroundColor(Color value)

public void setBackgroundColor(Color value)

Gets or sets a value for the background color.

Parameters:

ParameterTypeDescription
valueColor

setBlendClippedElements(boolean value)

public final void setBlendClippedElements(boolean value)

Gets or sets the blending of clipped element.

Value: The blending of clipped element.

Parameters:

ParameterTypeDescription
valueboolean

setBlendModeKey(long value)

public void setBlendModeKey(long value)

Gets or sets the blend mode key.

Value: The blend mode key.

Parameters:

ParameterTypeDescription
valuelong

setBottom(int value)

public final void setBottom(int value)

Gets or sets the bottom layer position.

Value: The bottom layer position.

Parameters:

ParameterTypeDescription
valueint

setBufferSizeHint(int value)

public final void setBufferSizeHint(int value)

Sets the buffer size hint which is defined max allowed size for all internal buffers.

Value: The buffer size hint, in megabytes. Non-positive value means no memory limitation for internal buffers

Parameters:

ParameterTypeDescription
valueintthe buffer size hint which is defined max allowed size for all internal buffers.

setChannelInformation(ChannelInformation[] value)

public final void setChannelInformation(ChannelInformation[] value)

Gets or sets the channel information.

Value: The channel information.

Parameters:

ParameterTypeDescription
valueChannelInformation[]

setClipping(byte value)

public final void setClipping(byte value)

Gets or sets the layer clipping. 0 = base, 1 = non-base.

Value: The layer clipping.

Parameters:

ParameterTypeDescription
valuebyte

setContainer_internalized(Image container)

public void setContainer_internalized(Image container)

Sets the Image container.

Parameters:

ParameterTypeDescription
containerImageThe Image container.

setDataLoaderDirectly_internalized(IRasterImageArgb32PixelLoader loader)

public void setDataLoaderDirectly_internalized(IRasterImageArgb32PixelLoader loader)

Sets the data loader directly.

Parameters:

ParameterTypeDescription
loaderIRasterImageArgb32PixelLoaderThe data loader.

setDataStreamContainer(StreamContainer value)

public void setDataStreamContainer(StreamContainer value)

Sets the object’s data stream.

Parameters:

ParameterTypeDescription
valueStreamContainerThe object’s data stream.

setDisplayName(String value)

public final void setDisplayName(String value)

Gets or sets the display name of the layer.

Value: The display name of the layer.

Parameters:

ParameterTypeDescription
valuejava.lang.String

setFillOpacity(int value)

public final void setFillOpacity(int value)

Gets the fill opacity.

Parameters:

ParameterTypeDescription
valueint

setFiller(byte value)

public final void setFiller(byte value)

Gets or sets the layer filler.

Value: The layer filler.

Parameters:

ParameterTypeDescription
valuebyte

setFlags(byte value)

public final void setFlags(byte value)

Gets or sets the layer flags. bit 0 = transparency protected; bit 1 = visible; bit 2 = obsolete; bit 3 = 1 for Photoshop 5.0 and later, tells if bit 4 has useful information; bit 4 = pixel data irrelevant to appearance of document.

Value: The layer flags.

Parameters:

ParameterTypeDescription
valuebyte

setFormatSpecificPalette_internalized(IColorPalette newPalette)

public boolean setFormatSpecificPalette_internalized(IColorPalette newPalette)

Sets palette into format-specific places

Parameters:

ParameterTypeDescription
newPaletteIColorPaletteNew 32-bit ARGB palette.

Returns: boolean

setHeader_internalized(PsdHeader value)

public final void setHeader_internalized(PsdHeader value)

Gets or sets the header.

Value: The header.

Parameters:

ParameterTypeDescription
valuecom.aspose.internal.fileformats.psd.sections.PsdHeader

setHorizontalResolution(double value)

public void setHorizontalResolution(double value)

Gets or sets the horizontal resolution, in pixels per inch, of this RasterImage .

Parameters:

ParameterTypeDescription
valuedoubleThe horizontal resolution.

Note by default this value is always 96 since different platforms cannot return the screen resolution. You may consider using the SetResolution method for updating both resolution values in single call. |

setIgnoreAfterSave_internalized(boolean value)

public void setIgnoreAfterSave_internalized(boolean value)

Sets a value indicating whether [ignore after save].

Parameters:

ParameterTypeDescription
valuebooleantrue if [ignore after save]; otherwise, false .

setImageChanged_internalized(boolean value)

public void setImageChanged_internalized(boolean value)

Gets or sets a value indicating whether this instance of image has changed after loading.

Parameters:

ParameterTypeDescription
valuebooleantrue if this instance has image changed; otherwise, false .

setInnerDataTransformer_internalized(IInnerDataTransformer value)

public final void setInnerDataTransformer_internalized(IInnerDataTransformer value)

Sets the inner data transformer.

Value: The inner data transformer.

Parameters:

ParameterTypeDescription
valuecom.aspose.internal.IInnerDataTransformerthe inner data transformer.

setInterruptMonitor(InterruptMonitor value)

public void setInterruptMonitor(InterruptMonitor value)

Sets the interrupt monitor.

Parameters:

ParameterTypeDescription
valueInterruptMonitorthe interrupt monitor.

setLayerBlendingRangesData(LayerBlendingRangesData value)

public final void setLayerBlendingRangesData(LayerBlendingRangesData value)

Gets or sets the layer blending ranges data.

Value: The layer blending ranges data.

Parameters:

ParameterTypeDescription
valueLayerBlendingRangesData

setLayerCreationDateTime(Date value)

public final void setLayerCreationDateTime(Date value)

Gets or sets the layer creation date time.

Value: The layer’s creation date time. If there is no data about creation DateTime then returns Unix Time first epoch

Parameters:

ParameterTypeDescription
valuejava.util.Date

setLayerCreationDateTime_internalized(System.DateTime value)

public final void setLayerCreationDateTime_internalized(System.DateTime value)

Parameters:

ParameterTypeDescription
valuecom.aspose.ms.System.DateTime

setLayerLock(int value)

public final void setLayerLock(int value)

Gets or sets the layer lock (Note that if flag LayerFlags.TransparencyProtected is set it will be overritten by layer lock flag. To return LayerFlags.TransparencyProtected flag need to apply for layer option layer.Flags |= LayerFlags.TransparencyProtected

Value: The layer lock.

Parameters:

ParameterTypeDescription
valueint

setLayerMaskData(LayerMaskData value)

public final void setLayerMaskData(LayerMaskData value)

Gets or sets the layer mask data.

Value: The layer mask data.

Parameters:

ParameterTypeDescription
valueLayerMaskData

setLayerPalette_internalized(IColorPalette value)

public final void setLayerPalette_internalized(IColorPalette value)

Gets or sets the layer palette.

Value: The layer palette.

Parameters:

ParameterTypeDescription
valueIColorPalette

setLeft(int value)

public final void setLeft(int value)

Gets or sets the left layer position.

Value: The left layer position.

Parameters:

ParameterTypeDescription
valueint

setMaxAllowedAllocationForPartialRotateSave_internalized(int value)

public static void setMaxAllowedAllocationForPartialRotateSave_internalized(int value)

Gets or sets the max allowed allocation for partial rotate save.

Parameters:

ParameterTypeDescription
valueintThe max allowed allocation for partial rotate save.

setMemoryManager_internalized(MemMgr memoryManager, boolean needDispose)

public void setMemoryManager_internalized(MemMgr memoryManager, boolean needDispose)

Sets the memory manager.

Parameters:

ParameterTypeDescription
memoryManagercom.aspose.internal.memorymanagement.MemMgrThe memory manager.
needDisposebooleanif set to true [need dispose].

setName(String name)

public final void setName(String name)

Sets the layer name.

Parameters:

ParameterTypeDescription
namejava.lang.StringThe layer name.

setName_internalized(String value)

public final void setName_internalized(String value)

Gets or sets the layer name.

Value: The layer name.

Parameters:

ParameterTypeDescription
valuejava.lang.String

setOpacity(byte value)

public final void setOpacity(byte value)

Gets or sets the layer opacity. 0 = transparent, 255 = opaque.

Value: The layer opacity.

Parameters:

ParameterTypeDescription
valuebyte

setPalette(IColorPalette value)

public void setPalette(IColorPalette value)

Sets the color palette. The color palette is not used when pixels are represented directly.

Parameters:

ParameterTypeDescription
valueIColorPaletteThe color palette.

setPalette(IColorPalette palette, boolean updateColors)

public void setPalette(IColorPalette palette, boolean updateColors)

Sets the image palette.

Parameters:

ParameterTypeDescription
paletteIColorPaletteThe palette to set.
updateColorsbooleanif set to true colors will be updated according to the new palette; otherwise color indexes remain unchanged. Note that unchanged indexes may crash the image on loading if some indexes have no corresponding palette entries.

setPixel(int x, int y, Color color)

public void setPixel(int x, int y, Color color)

Sets an image pixel for the specified position.

Parameters:

ParameterTypeDescription
xintThe pixel x location.
yintThe pixel y location.
colorColorThe pixel color for the specified position.

setPremultiplyComponents(boolean value)

public void setPremultiplyComponents(boolean value)

Gets or sets a value indicating whether the image components must be premultiplied.

Parameters:

ParameterTypeDescription
valuebooleantrue if the image components must be premultiplied; otherwise, false .

setRawCustomColorConverter(IColorConverter value)

public void setRawCustomColorConverter(IColorConverter value)

Gets or sets the custom color converter

Parameters:

ParameterTypeDescription
valueIColorConverterThe custom color converter

setRawFallbackIndex(int value)

public void setRawFallbackIndex(int value)

Gets or sets the fallback index to use when palette index is out of bounds

Parameters:

ParameterTypeDescription
valueintThe fallback index to use when palette index is out of bounds

setRawIndexedColorConverter(IIndexedColorConverter value)

public void setRawIndexedColorConverter(IIndexedColorConverter value)

Gets or sets the indexed color converter

Parameters:

ParameterTypeDescription
valueIIndexedColorConverterThe indexed color converter

setResolution(double dpiX, double dpiY)

public void setResolution(double dpiX, double dpiY)

Sets the resolution for this RasterImage .

Parameters:

ParameterTypeDescription
dpiXdoubleThe horizontal resolution, in dots per inch, of the RasterImage .
dpiYdoubleThe vertical resolution, in dots per inch, of the RasterImage .

setResources(LayerResource[] value)

public final void setResources(LayerResource[] value)

Gets or sets the layer resources.

Value: The layer resources.

Parameters:

ParameterTypeDescription
valueLayerResource[]

setRight(int value)

public final void setRight(int value)

Gets or sets the right layer position.

Value: The right layer position.

Parameters:

ParameterTypeDescription
valueint

setRotateMode_internalized(int value)

public static void setRotateMode_internalized(int value)

Gets or sets the rotate mode.

Parameters:

ParameterTypeDescription
valueintThe rotate mode.

setSheetColorHighlight(short value)

public final void setSheetColorHighlight(short value)

Gets or sets the decorative sheet color highlight in layers’ list

Value: The sheet color highlight.

Parameters:

ParameterTypeDescription
valueshort

setTop(int value)

public final void setTop(int value)

Gets or sets the top layer position.

Value: The top layer position.

Parameters:

ParameterTypeDescription
valueint

setTransparentColor(boolean value)

public void setTransparentColor(boolean value)

Gets a value indicating whether image has transparent color.

Parameters:

ParameterTypeDescription
valueboolean

setTransparentColor(Color value)

public void setTransparentColor(Color value)

Gets the image transparent color.

Parameters:

ParameterTypeDescription
valueColor

setUpdateXmpData(boolean value)

public void setUpdateXmpData(boolean value)

Gets or sets a value indicating whether to update the XMP metadata.

Parameters:

ParameterTypeDescription
valuebooleantrue if update the XMP metadata; otherwise, false .

setUseRawData(boolean value)

public void setUseRawData(boolean value)

Gets or sets a value indicating whether to use raw data loading when the raw data loading is available.

Parameters:

ParameterTypeDescription
valuebooleantrue if use raw data loading when the raw data loading is available.; otherwise, false .

setVentureLicense_internalized(Object ventureLicense)

public void setVentureLicense_internalized(Object ventureLicense)

All Aspose products should implement this method. It is called by a GroupDocs product to indicate whether GroupDocs itself is licensed or not and specify a custom watermark. When GroupDocs is licensed, this document instance should behave as licensed too even if the Aspose product is not licensed.

Parameters:

ParameterTypeDescription
ventureLicensejava.lang.Objectlicense

setVerticalResolution(double value)

public void setVerticalResolution(double value)

Gets or sets the vertical resolution, in pixels per inch, of this RasterImage .

Parameters:

ParameterTypeDescription
valuedoubleThe vertical resolution.

Note by default this value is always 96 since different platforms cannot return the screen resolution. You may consider using the SetResolution method for updating both resolution values in single call. |

setVisible(boolean value)

public final void setVisible(boolean value)

Gets or sets a value indicating whether the layer is visible

Value: true if this instance is visible; otherwise, false .

Parameters:

ParameterTypeDescription
valueboolean

setXmpData(XmpPacketWrapper value)

public void setXmpData(XmpPacketWrapper value)

Gets or sets the XMP metadata.

Parameters:

ParameterTypeDescription
valueXmpPacketWrapperThe XMP metadata.

shallowCopy()

public final Layer shallowCopy()

Creates a shallow copy of the current Layer. Please for explanation.

Returns: Layer - A shallow copy of the current Layer.

toBitmap()

public BufferedImage toBitmap()

Converts raster image to the bitmap.

Returns: java.awt.image.BufferedImage - The bitmap

toBitmap_internalized()

public System.Drawing.Bitmap toBitmap_internalized()

Returns: com.aspose.ms.System.Drawing.Bitmap

toString()

public String toString()

Returns: java.lang.String

updateBlendingOptions_internalized(PattResource pattResource)

public final void updateBlendingOptions_internalized(PattResource pattResource)

Updates the blending options after layer or global resources change.

Parameters:

ParameterTypeDescription
pattResourcePattResource

wait()

public final void wait()

wait(long arg0)

public final void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int

writeArgb32ScanLine(int scanLineIndex, int[] argb32Pixels)

public void writeArgb32ScanLine(int scanLineIndex, int[] argb32Pixels)

Writes the whole scan line to the specified scan line index.

Parameters:

ParameterTypeDescription
scanLineIndexintZero based index of the scan line.
argb32Pixelsint[]The 32-bit ARGB colors array to write.

writeScanLine(int scanLineIndex, Color[] pixels)

public void writeScanLine(int scanLineIndex, Color[] pixels)

Writes the whole scan line to the specified scan line index.

Parameters:

ParameterTypeDescription
scanLineIndexintZero based index of the scan line.
pixelsColor[]The pixel colors array to write.