PsdOptions
Inheritance: java.lang.Object, com.aspose.psd.DisposableObject, com.aspose.psd.ImageOptionsBase
public class PsdOptions extends ImageOptionsBase
The psd file format create options.
Constructors
| Constructor | Description |
|---|---|
| PsdOptions() | Initializes a new instance of the PsdOptions class. |
| PsdOptions(PsdOptions options) | Initializes a new instance of the PsdOptions class. |
| PsdOptions(PsdImage image) | Initializes a new instance of the PsdOptions class. |
Methods
| Method | Description |
|---|---|
| clone() | |
| close() | Implements the Closable interface and can be used in the try-with-resources statement since JDK 1.7. |
| deepClone() | Clones this instance. |
| deepClone_internalized() | Clones this instance. |
| dispose() | Disposes the current instance. |
| equals(Object arg0) | |
| getBackgroundContents() | Gets or sets the color of background. |
| getBufferSizeHint() | Gets or sets the buffer size hint which is defined max allowed size for all internal buffers. |
| getChannelBitsCount() | Gets or sets the bits count per color channel. |
| getChannelsCount() | Gets or sets the color channels count. |
| getClass() | |
| getColorMode() | Gets or sets the psd color mode. |
| getCompressionMethod() | Gets or sets the psd compression method. |
| getDefaultReplacementFont() | Gets or sets the default replacement font (font that will be used to draw text when exporting to raster, if existing layer font in PSD file is not presented in system). |
| getDisposed() | Gets a value indicating whether this instance is disposed. |
| getFullFrame() | Gets a value indicating whether [full frame]. |
| getMultiPageOptions() | The multipage options |
| getPalette() | Gets or sets the color palette. |
| getProgressEventHandler() | Gets or sets the progress event handler. |
| getPsdVersion() | Gets or sets the file format version. |
| getRefreshImagePreviewData() | Gets or sets a value indicating whether [refresh image preview data] - option used to maximize compatibility with another PSD image viewers. |
| getRemoveGlobalTextEngineResource() | Gets or sets a value indicating whether - Remove the global text engine resource - Used for some text-layered psd files, in only case, when they can not be opened in Adobe Photoshop after processing (mostly for absent fonts text layers related). |
| getResolutionSettings() | Gets or sets the resolution settings. |
| getResources() | Gets or sets the psd resources. |
| getSource() | Gets or sets the source to create image in. |
| getUpdateMetadata() | Gets or sets a value indicating whether [update metadata]. |
| getVectorRasterizationOptions() | Gets or sets the vector rasterization options. |
| getVersion() | Gets or sets the psd file version. |
| getXmpData() | Get or set XMP data container |
| hashCode() | |
| isColorModeSet() | Shows if ColorMode property has been assigned. |
| notify() | |
| notifyAll() | |
| setBackgroundContents(RawColor value) | Gets or sets the color of background. |
| setBufferSizeHint(int value) | Gets or sets the buffer size hint which is defined max allowed size for all internal buffers. |
| setChannelBitsCount(short value) | Gets or sets the bits count per color channel. |
| setChannelsCount(short value) | Gets or sets the color channels count. |
| setColorMode(short value) | Gets or sets the psd color mode. |
| setCompressionMethod(short value) | Gets or sets the psd compression method. |
| setDefaultReplacementFont(String value) | Gets or sets the default replacement font (font that will be used to draw text when exporting to raster, if existing layer font in PSD file is not presented in system). |
| setFullFrame(boolean value) | Sets a value indicating whether [full frame]. |
| setIgnoreAfterCreate_internalized(boolean value) | Gets or sets a value indicating whether ignore after create event. |
| setMultiPageOptions(MultiPageOptions value) | The multipage options |
| setPalette(IColorPalette value) | Gets or sets the color palette. |
| setProgressEventHandler(ProgressEventHandler value) | Gets or sets the progress event handler. |
| setPsdVersion(byte value) | Gets or sets the file format version. |
| setRefreshImagePreviewData(boolean value) | Gets or sets a value indicating whether [refresh image preview data] - option used to maximize compatibility with another PSD image viewers. |
| setRemoveGlobalTextEngineResource(boolean value) | Gets or sets a value indicating whether - Remove the global text engine resource - Used for some text-layered psd files, in only case, when they can not be opened in Adobe Photoshop after processing (mostly for absent fonts text layers related). |
| setResolutionSettings(ResolutionSetting value) | Gets or sets the resolution settings. |
| setResources(ResourceBlock[] value) | Gets or sets the psd resources. |
| setSource(Source value) | Gets or sets the source to create image in. |
| setUpdateMetadata(boolean value) | Gets or sets a value indicating whether [update metadata]. |
| setVectorRasterizationOptions(VectorRasterizationOptions value) | Gets or sets the vector rasterization options. |
| setVersion(int value) | Gets or sets the psd file version. |
| setXmpData(XmpPacketWrapper value) | Get or set XMP data container |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
PsdOptions()
public PsdOptions()
Initializes a new instance of the PsdOptions class.
PsdOptions(PsdOptions options)
public PsdOptions(PsdOptions options)
Initializes a new instance of the PsdOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | PsdOptions | The options. |
PsdOptions(PsdImage image)
public PsdOptions(PsdImage image)
Initializes a new instance of the PsdOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| image | PsdImage | The image. |
clone()
public ImageOptionsBase clone()
Returns: ImageOptionsBase
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.
deepClone()
public ImageOptionsBase deepClone()
Clones this instance.
Returns: ImageOptionsBase - Returns shallow copy of this instance
deepClone_internalized()
public ImageOptionsBase deepClone_internalized()
Clones this instance.
Returns: ImageOptionsBase - Returns shallow copy of this instance
dispose()
public final void dispose()
Disposes the current instance.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getBackgroundContents()
public final RawColor getBackgroundContents()
Gets or sets the color of background. It can be seen under transparent objects.
Returns: RawColor
getBufferSizeHint()
public final int getBufferSizeHint()
Gets or 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
Returns: int
getChannelBitsCount()
public final short getChannelBitsCount()
Gets or sets the bits count per color channel.
Value: The bits count per color channel.
Returns: short
getChannelsCount()
public final short getChannelsCount()
Gets or sets the color channels count.
Value: The color channels count.
Returns: short
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getColorMode()
public final short getColorMode()
Gets or sets the psd color mode.
Value: The color mode.
Returns: short
getCompressionMethod()
public final short getCompressionMethod()
Gets or sets the psd compression method.
Value: The compression method.
Returns: short
getDefaultReplacementFont()
public String getDefaultReplacementFont()
Gets or sets the default replacement font (font that will be used to draw text when exporting to raster, if existing layer font in PSD file is not presented in system). To take proper name of default font can be used next code snippet: System.Drawing.Text.InstalledFontCollection col = new System.Drawing.Text.InstalledFontCollection(); System.Drawing.FontFamily[] families = col.Families; string defaultFontName = families[0].Name; PsdLoadOptions psdLoadOptions = new PsdLoadOptions() { DefaultReplacementFont = defaultFontName });
Value: The default replacement font.
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 .
getFullFrame()
public final boolean getFullFrame()
Gets a value indicating whether [full frame].
Value: true if [full frame]; otherwise, false .
Returns: boolean - a value indicating whether [full frame].
getMultiPageOptions()
public final MultiPageOptions getMultiPageOptions()
The multipage options
Returns: MultiPageOptions
getPalette()
public IColorPalette getPalette()
Gets or sets the color palette.
Value: The color palette.
Returns: IColorPalette
getProgressEventHandler()
public final ProgressEventHandler getProgressEventHandler()
Gets or sets the progress event handler.
Value: The progress event handler.
Returns: ProgressEventHandler
getPsdVersion()
public final byte getPsdVersion()
Gets or sets the file format version. It can be PSD or PSB.
Value: The file format version.
Returns: byte
getRefreshImagePreviewData()
public final boolean getRefreshImagePreviewData()
Gets or sets a value indicating whether [refresh image preview data] - option used to maximize compatibility with another PSD image viewers. Please note, text layers drawing to final layout is not supported for Compact Framework platform
Value: true if [refresh image preview data]; otherwise, false .
Returns: boolean
getRemoveGlobalTextEngineResource()
public final boolean getRemoveGlobalTextEngineResource()
Gets or sets a value indicating whether - Remove the global text engine resource - Used for some text-layered psd files, in only case, when they can not be opened in Adobe Photoshop after processing (mostly for absent fonts text layers related). After using this option, user need to Make next in opened in Photoshop file: Menu “Text” -> “Process absent fonts”. After that operation all text will appear again. Please note, that this operation may cause some final layout changes.
Value: true if [remove global text engine resource]; otherwise, false .
Returns: boolean
getResolutionSettings()
public ResolutionSetting getResolutionSettings()
Gets or sets the resolution settings.
Returns: ResolutionSetting
getResources()
public final ResourceBlock[] getResources()
Gets or sets the psd resources.
Value: The psd resources.
Returns: com.aspose.psd.fileformats.psd.ResourceBlock[]
getSource()
public final Source getSource()
Gets or sets the source to create image in.
Value: The source to create image in.
Returns: Source
getUpdateMetadata()
public final boolean getUpdateMetadata()
Gets or sets a value indicating whether [update metadata]. If the value is true, the metadata will be updated while saving an image.
Value: true if [update metadata]; otherwise, false .
Returns: boolean
getVectorRasterizationOptions()
public final VectorRasterizationOptions getVectorRasterizationOptions()
Gets or sets the vector rasterization options.
Value: The vector rasterization options.
Returns: VectorRasterizationOptions
getVersion()
public final int getVersion()
Gets or sets the psd file version.
Value: The psd file version.
Returns: int
getXmpData()
public XmpPacketWrapper getXmpData()
Get or set XMP data container
Returns: XmpPacketWrapper
hashCode()
public native int hashCode()
Returns: int
isColorModeSet()
public final boolean isColorModeSet()
Shows if ColorMode property has been assigned.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setBackgroundContents(RawColor value)
public final void setBackgroundContents(RawColor value)
Gets or sets the color of background. It can be seen under transparent objects.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | RawColor |
setBufferSizeHint(int value)
public final void setBufferSizeHint(int value)
Gets or 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:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setChannelBitsCount(short value)
public final void setChannelBitsCount(short value)
Gets or sets the bits count per color channel.
Value: The bits count per color channel.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | short |
setChannelsCount(short value)
public final void setChannelsCount(short value)
Gets or sets the color channels count.
Value: The color channels count.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | short |
setColorMode(short value)
public final void setColorMode(short value)
Gets or sets the psd color mode.
Value: The color mode.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | short |
setCompressionMethod(short value)
public final void setCompressionMethod(short value)
Gets or sets the psd compression method.
Value: The compression method.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | short |
setDefaultReplacementFont(String value)
public void setDefaultReplacementFont(String value)
Gets or sets the default replacement font (font that will be used to draw text when exporting to raster, if existing layer font in PSD file is not presented in system). To take proper name of default font can be used next code snippet: System.Drawing.Text.InstalledFontCollection col = new System.Drawing.Text.InstalledFontCollection(); System.Drawing.FontFamily[] families = col.Families; string defaultFontName = families[0].Name; PsdLoadOptions psdLoadOptions = new PsdLoadOptions() { DefaultReplacementFont = defaultFontName });
Value: The default replacement font.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setFullFrame(boolean value)
public final void setFullFrame(boolean value)
Sets a value indicating whether [full frame].
Value: true if [full frame]; otherwise, false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether [full frame]. |
setIgnoreAfterCreate_internalized(boolean value)
public final void setIgnoreAfterCreate_internalized(boolean value)
Gets or sets a value indicating whether ignore after create event.
Value: true if ignore after create event; otherwise, false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setMultiPageOptions(MultiPageOptions value)
public final void setMultiPageOptions(MultiPageOptions value)
The multipage options
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | MultiPageOptions |
setPalette(IColorPalette value)
public void setPalette(IColorPalette value)
Gets or sets the color palette.
Value: The color palette.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IColorPalette |
setProgressEventHandler(ProgressEventHandler value)
public final void setProgressEventHandler(ProgressEventHandler value)
Gets or sets the progress event handler.
Value: The progress event handler.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ProgressEventHandler |
setPsdVersion(byte value)
public final void setPsdVersion(byte value)
Gets or sets the file format version. It can be PSD or PSB.
Value: The file format version.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte |
setRefreshImagePreviewData(boolean value)
public final void setRefreshImagePreviewData(boolean value)
Gets or sets a value indicating whether [refresh image preview data] - option used to maximize compatibility with another PSD image viewers. Please note, text layers drawing to final layout is not supported for Compact Framework platform
Value: true if [refresh image preview data]; otherwise, false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setRemoveGlobalTextEngineResource(boolean value)
public final void setRemoveGlobalTextEngineResource(boolean value)
Gets or sets a value indicating whether - Remove the global text engine resource - Used for some text-layered psd files, in only case, when they can not be opened in Adobe Photoshop after processing (mostly for absent fonts text layers related). After using this option, user need to Make next in opened in Photoshop file: Menu “Text” -> “Process absent fonts”. After that operation all text will appear again. Please note, that this operation may cause some final layout changes.
Value: true if [remove global text engine resource]; otherwise, false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setResolutionSettings(ResolutionSetting value)
public void setResolutionSettings(ResolutionSetting value)
Gets or sets the resolution settings.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ResolutionSetting |
setResources(ResourceBlock[] value)
public final void setResources(ResourceBlock[] value)
Gets or sets the psd resources.
Value: The psd resources.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ResourceBlock[] |
setSource(Source value)
public final void setSource(Source value)
Gets or sets the source to create image in.
Value: The source to create image in.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Source |
setUpdateMetadata(boolean value)
public final void setUpdateMetadata(boolean value)
Gets or sets a value indicating whether [update metadata]. If the value is true, the metadata will be updated while saving an image.
Value: true if [update metadata]; otherwise, false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setVectorRasterizationOptions(VectorRasterizationOptions value)
public final void setVectorRasterizationOptions(VectorRasterizationOptions value)
Gets or sets the vector rasterization options.
Value: The vector rasterization options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | VectorRasterizationOptions |
setVersion(int value)
public final void setVersion(int value)
Gets or sets the psd file version.
Value: The psd file version.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setXmpData(XmpPacketWrapper value)
public void setXmpData(XmpPacketWrapper value)
Get or set XMP data container
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | XmpPacketWrapper |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |