com.aspose.psd.fileformats.psd.layers

Class LayerGroup

java.lang.Object

com.aspose.psd.DisposableObject

com.aspose.psd.DataStreamSupporter

com.aspose.psd.Image

com.aspose.psd.RasterImage

com.aspose.psd.RasterCachedImage

com.aspose.psd.fileformats.psd.layers.Layer

com.aspose.psd.fileformats.psd.layers.LayerGroup

All Implemented Interfaces:

IObjectWithBounds, IRasterImageArgb32PixelLoader, IRasterImageRawDataLoader

public class LayerGroup
extends Layer

Group layer class

Code example:

An example of hiding inner layers for each layer group in a PSD file.

            
String inPsdFileName = "input.psd";
String outPsdFileName = "output.psd";
            
// Load a PSD file containing layers' hierarchy
PsdImage psdImage = (PsdImage)Image.load(inPsdFileName);
try
{
    // Hide containing layers for each layer group
    for (Layer layer : psdImage.getLayers())
    {
        if (layer instanceof LayerGroup)
        {
            layer.setVisible(false);
        }
    }
            
    // Save a copy of the loaded PSD file including the changes on the specified path
    psdImage.save(outPsdFileName);
}
finally
{
    psdImage.dispose();
}

Nested Class Summary

Nested classes/interfaces inherited from class com.aspose.psd.RasterCachedImage

RasterCachedImage.RotateTestMode

Field Summary

Fields inherited from class com.aspose.psd.fileformats.psd.layers.Layer

BlendSignature, LayerHeaderSize

Method Summary

Modifier and Type	Method and Description
void	addLayer(Layer layer) Adds the layer to the layer group.
void	addLayer(Layer layer, int index) Adds the layer to the layer group.
LayerGroup	addLayerGroup(String groupName, int index) Adds the layer group.
long	getBlendModeKey() Gets or sets the blend mode key.
int	getHeight() Gets height of the layers group.
Layer[]	getLayers() Gets the layers in layer group
int	getWidth() Gets width of the layers group.
void	setBlendModeKey(long value) Gets or sets the blend mode key.

Methods inherited from class com.aspose.psd.fileformats.psd.layers.Layer

addLayerMask, drawImage, equals, getBitsPerPixel, getBlendingOptions, getBlendModeSignature, getBottom, getChannelInformation, getChannelsCount, getClipping, getDisplayName, getExtraLength, getFiller, getFillOpacity, getFlags, getLayerBlendingRangesData, getLayerCreationDateTime, getLayerLock, getLayerMaskData, getLayerOptions, getLeft, getLength, getName, getOpacity, getResources, getRight, getSheetColorHighlight, getTop, hasAlpha, hashCode, isVisible, isVisibleInGroup, mergeLayerTo, save, save, save, save, setBottom, setChannelInformation, setClipping, setDisplayName, setFiller, setFillOpacity, setFlags, setLayerBlendingRangesData, setLayerCreationDateTime, setLayerLock, setLayerMaskData, setLeft, setName, setOpacity, setResources, setRight, setSheetColorHighlight, setTop, setVisible, shallowCopy

Methods inherited from class com.aspose.psd.RasterCachedImage

adjustBrightness, adjustContrast, adjustGamma, adjustGamma, binarizeBradley, binarizeBradley, binarizeFixed, binarizeOtsu, cacheData, crop, dither, doRotate, getRotateMode, grayscale, isCached, resize, resize, rotate, rotateFlip

Methods inherited from class com.aspose.psd.RasterImage

crop, dither, filter, getArgb32Pixel, getDefaultArgb32Pixels, getDefaultPixels, getDefaultRawData, getDefaultRawData, getHorizontalResolution, getImageOpacity, getModifyDate, getPixel, getPremultiplyComponents, getRawCustomColorConverter, getRawDataFormat, getRawDataSettings, getRawFallbackIndex, getRawIndexedColorConverter, getRawLineSize, getSkewAngle, getTransparentColor, getUpdateXmpData, getUseRawData, getVerticalResolution, getXmpData, hasTransparentColor, isRawDataAvailable, isUsePalette, loadArgb32Pixels, loadArgb64Pixels, loadCmyk32Pixels, loadCmykPixels, loadPartialArgb32Pixels, loadPartialPixels, loadPixels, loadRawData, loadRawData, normalizeAngle, normalizeAngle, readArgb32ScanLine, readScanLine, replaceColor, replaceColor, replaceNonTransparentColors, replaceNonTransparentColors, rotate, saveArgb32Pixels, saveCmyk32Pixels, saveCmykPixels, savePixels, saveRawData, setArgb32Pixel, setHorizontalResolution, setPalette, setPixel, setPremultiplyComponents, setRawCustomColorConverter, setRawFallbackIndex, setRawIndexedColorConverter, setResolution, setTransparentColor, setTransparentColor, setUpdateXmpData, setUseRawData, setVerticalResolution, setXmpData, toBitmap, writeArgb32ScanLine, writeScanLine

Methods inherited from class com.aspose.psd.Image

canLoad, canLoad, canLoad, canLoad, canSave, create, create, create, getBackgroundColor, getBounds, getBufferSizeHint, getContainer, getDefaultOptions, getFileFormat, getFileFormat, getFileFormat, getFittingRectangle, getFittingRectangle, getInterruptMonitor, getOriginalOptions, getPalette, getProgressEventHandler, getProgressEventHandlerInfo, getProportionalHeight, getProportionalWidth, getSize, hasBackgroundColor, isAutoAdjustPalette, load, load, load, load, load, load, resize, resizeHeightProportionally, resizeHeightProportionally, resizeHeightProportionally, resizeWidthProportionally, resizeWidthProportionally, resizeWidthProportionally, save, save, save, save, setAutoAdjustPalette, setBackgroundColor, setBackgroundColor, setBufferSizeHint, setInterruptMonitor, setPalette

Methods inherited from class com.aspose.psd.DataStreamSupporter

getDataStreamContainer, save, save, save, setDataStreamContainer

Methods inherited from class com.aspose.psd.DisposableObject

close, dispose, getDisposed

Method Detail

getBlendModeKey

public long getBlendModeKey()

Gets or sets the blend mode key.

Value: The blend mode key.

Overrides:

getBlendModeKey in class Layer

setBlendModeKey

public void setBlendModeKey(long value)

Gets or sets the blend mode key.

Value: The blend mode key.

Overrides:

setBlendModeKey in class Layer

getLayers

public final Layer[] getLayers()

Gets the layers in layer group

getWidth

public int getWidth()

Gets width of the layers group.

Specified by:

getWidth in interface IObjectWithBounds

Overrides:

getWidth in class Layer

Returns:

The image width.

getHeight

public int getHeight()

Gets height of the layers group.

Specified by:

getHeight in interface IObjectWithBounds

Overrides:

getHeight in class Layer

Returns:

The image height.

addLayer

public final void addLayer(Layer layer)

Adds the layer to the layer group.

Parameters:

layer - The layer.

addLayer

public final void addLayer(Layer layer,
                           int index)

Adds the layer to the layer group.

Parameters:

layer - The layer.

index - The index at which the layer will be inserted. Invalid values mean the end of the layers list.

addLayerGroup

public final LayerGroup addLayerGroup(String groupName,
                                      int index)

Adds the layer group.

Parameters:

groupName - Name of the group.

index - The index of the layer to insert after.

Returns:

Opening group layer

Code example:

This example demonstrates how to add a nested layer group to PSD programmatically.

String dstPsdPath = "output.psd";
            
// Create an image with the size of 1x1 pixels to work with
PsdImage psdImage = new PsdImage(1, 1);
try
{
    // Add a parent layer group ("true" means to open the layer group on start)
    LayerGroup group1 = psdImage.addLayerGroup("Group 1", 0, true);
    // Add a nested layer group
    LayerGroup group2 = group1.addLayerGroup("Group 2", 0);
            
    if (group1.getLayers().length != 2)
    {
        throw new RuntimeException("Group 1 must contain two layers of Group 2.");
    }
            
    // Verify that there are no exceptions on saving just created layer groups
    psdImage.save(dstPsdPath);
}
finally
{
    psdImage.dispose();
}