TiffOptions

Inheritance: java.lang.Object, com.aspose.psd.DisposableObject, com.aspose.psd.ImageOptionsBase

public class TiffOptions extends ImageOptionsBase

The tiff file format options. Note that width and height tags will get overwritten on image creation by width and height parameters so there is no need to specify them directly. Note that many options return a default value but that does not mean that this option is set explicitly as a tag value. To verify the tag is present use Tags property or the corresponding IsTagPresent method.

WARNING! never modify tiff options during save since this may cause side effects and hard to find bugs. The following line was specially left commented since it caused incorrect determination of data beginning. The passed options did not contain spp (although the options are not correct in such case but still this scenario causes errors) and the next line caused +spp tag +bpp tag added and when options were written after data completely written they have overwritten the data beginning for uncompressed codec!!! See TiffUncompressedCodec.Encode. this.Options.SamplesPerPixel = 3;

Constructors

Constructor	Description
TiffOptions(int expectedFormat, int byteOrder)	Initializes a new instance of the TiffOptions class.
TiffOptions(int expectedFormat)	Initializes a new instance of the TiffOptions class.
TiffOptions(TiffOptions options)	Initializes a new instance of the TiffOptions class.
TiffOptions(TiffDataType[] tags)	Initializes a new instance of the TiffOptions class.

Methods

Method	Description
addTag(TiffDataType tagToAdd)	Adds a new tag.
addTags(TiffDataType[] tagsToAdd)	Adds the tags.
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)
getAlphaStorage()	Gets or sets the alpha storage option.
getArtist()	Gets or sets the artist.
getBackgroundColor_internalized()	Gets or sets the color of the background.
getBitsPerPixel()	Gets the bits per pixel.
getBitsPerSample()	Gets the bits per sample.
getBufferSizeHint()	Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
getByteOrder()	Gets or sets a value indicating the tiff byte order.
getCache_internalized(int tag)	Gets the cache.
getClass()
getColorMap()	Gets or sets the color map.
getCompressedQuality()	Gets compressed image quality.
getCompression()	Gets the compression.
getCopyright()	Gets the copyright.
getDateTime()	Gets or sets the date and time.
getDefaultMemoryAllocationLimit()	Gets or sets the default memory allocation limit.
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.
getDocumentName()	Gets or sets the name of the document.
getExifIfd()	Gets or sets the pointer to EXIF IFD.
getExtraSampleCount_internalized()	Gets the extra sample count.
getExtraSamples_internalized()	Gets the extra samples values.
getFaxT4Options()	Gets or sets the fax t4 options.
getFileStandard()	Gets or sets the TIFF file standard.
getFillOrder()	Gets or sets the byte bits fill order.
getFullFrame()	Gets a value indicating whether [full frame].
getHalfToneHints()	Gets or sets the halftone hints.
getIccProfile()	Gets the icc profile stream.
getIccProfile_internalized()
getImageDescription()	Gets or sets the image description.
getImageLength()	Gets or sets the image length.
getImageWidth()	Gets or sets the image width.
getInkNames()	Gets or sets the ink names.
getMaxSampleValue()	Gets or sets the max sample value.
getMinSampleValue()	Gets or sets the min sample value.
getMultiPageOptions()	The multipage options
getOrientation()	Gets or sets the orientation.
getPageName()	Gets or sets the page name.
getPageNumber()	Gets or sets the page number tag.
getPalette()	Gets or sets the color palette.
getPhotometric()	Gets or sets the photometric.
getPlanarConfiguration()	Gets or sets the planar configuration.
getPredictor()	Gets or sets the predictor for LZW compression.
getPremultiplyComponents()	Gets or sets a value indicating whether components must be premultiplied.
getProgressEventHandler()	Gets or sets the progress event handler.
getResolutionSettings()	Gets or sets the resolution settings.
getResolutionUnit()	Gets or sets the resolution unit.
getRowsPerStrip()	Gets or sets the rows per strip.
getSampleFormat()	Gets or sets the sample format.
getSamplesPerPixel()	Gets the samples per pixel.
getScannerManufacturer()	Gets or sets the scanner manufacturer.
getScannerModel()	Gets or sets the scanner model.
getSmaxSampleValue()	Gets or sets the max sample value.
getSminSampleValue()	Gets or sets the min sample value.
getSoftwareType()	Gets or sets the software type.
getSource()	Gets or sets the source to create image in.
getStripByteCounts()	Gets or sets the strip byte counts.
getStripOffsets()	Gets or sets the strip offsets.
getSubFileType()	Gets or sets a general indication of the kind of data contained in this subfile.
getTagByType(int tagKey)	Gets the instance of the tag by type.
getTags()	Gets or sets the tags.
getTargetPrinter()	Gets or sets the target printer.
getThreshholding()	Gets or sets the threshholding.
getTileByteCounts()	Gets or sets the tile byte counts.
getTileLength()	Gets ot sets tile length.
getTileOffsets()	Gets or sets the tile offsets.
getTileWidth()	Gets ot sets tile width.
getTotalPages()	Gets the total pages.
getValidTagCount()	Gets the valid tag count.
getValidTagsCount(TiffDataType[] tags)	Gets the valid tags count.
getVectorRasterizationOptions()	Gets or sets the vector rasterization options.
getXPAuthor()	Gets image author, which used by Windows Explorer.
getXPComment()	Gets comment on image, which used by Windows Explorer.
getXPKeywords()	Gets subject image, which used by Windows Explorer.
getXPSubject()	Gets information about image, which used by Windows Explorer.
getXPTitle()	Gets information about image, which used by Windows Explorer.
getXmpData()	Gets or sets the XMP metadata container.
getXposition()	Gets or sets the x position.
getXresolution()	Gets or sets the x resolution.
getYCbCrCoefficients()	Gets or sets the YCbCrCoefficients.
getYCbCrSubsampling()	Gets or sets the subsampling factors for YCbCr photometric.
getYposition()	Gets or sets the y position.
getYresolution()	Gets or sets the y resolution.
hashCode()
isExtraSamplesPresent()	Gets a value indicating whether the extra samples is present.
isTagPresent(int tag)	Determines whether tag is present in the options or not.
isTiled()	Gets a value indicating whether image is tiled.
isValid()	Gets a value indicating whether the TiffOptions have been properly configured.
notify()
notifyAll()
removeTag(int tag)	Removes the tag.
setAlphaStorage(int value)	Gets or sets the alpha storage option.
setArtist(String value)	Gets or sets the artist.
setBackgroundColor_internalized(Color value)	Gets or sets the color of the background.
setBitsPerSample(int[] value)	Sets the bits per sample.
setBufferSizeHint(int value)	Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
setByteOrder(int value)	Gets or sets a value indicating the tiff byte order.
setColorMap(int[] value)	Gets or sets the color map.
setCompressedQuality(int value)	Sets compressed image quality.
setCompression(int value)	Sets the compression.
setCopyright(String value)	Sets the copyright.
setDateTime(String value)	Gets or sets the date and time.
setDefaultMemoryAllocationLimit(int value)	Gets or sets the default memory allocation limit.
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).
setDocumentName(String value)	Gets or sets the name of the document.
setExtraSamples_internalized(int[] value)	Sets the extra samples values.
setFaxT4Options(long value)	Gets or sets the fax t4 options.
setFileStandard(int value)	Gets or sets the TIFF file standard.
setFillOrder(int value)	Gets or sets the byte bits fill order.
setFullFrame(boolean value)	Sets a value indicating whether [full frame].
setHalfToneHints(int[] value)	Gets or sets the halftone hints.
setIccProfile(byte[] value)	Sets the icc profile stream.
setIgnoreAfterCreate_internalized(boolean value)	Gets or sets a value indicating whether ignore after create event.
setImageDescription(String value)	Gets or sets the image description.
setImageLength(long value)	Gets or sets the image length.
setImageWidth(long value)	Gets or sets the image width.
setInkNames(String value)	Gets or sets the ink names.
setMaxSampleValue(int[] value)	Gets or sets the max sample value.
setMinSampleValue(int[] value)	Gets or sets the min sample value.
setMultiPageOptions(MultiPageOptions value)	The multipage options
setOrientation(int value)	Gets or sets the orientation.
setPageName(String value)	Gets or sets the page name.
setPageNumber(int[] value)	Gets or sets the page number tag.
setPalette(IColorPalette value)	Gets or sets the color palette.
setPhotometric(int value)	Gets or sets the photometric.
setPlanarConfiguration(int value)	Gets or sets the planar configuration.
setPredictor(int value)	Gets or sets the predictor for LZW compression.
setPremultiplyComponents(boolean value)	Gets or sets a value indicating whether components must be premultiplied.
setProgressEventHandler(ProgressEventHandler value)	Gets or sets the progress event handler.
setResolutionSettings(ResolutionSetting value)	Gets or sets the resolution settings.
setResolutionUnit(int value)	Gets or sets the resolution unit.
setRowsPerStrip(long value)	Gets or sets the rows per strip.
setSampleFormat(int[] value)	Gets or sets the sample format.
setScannerManufacturer(String value)	Gets or sets the scanner manufacturer.
setScannerModel(String value)	Gets or sets the scanner model.
setSmaxSampleValue(long[] value)	Gets or sets the max sample value.
setSminSampleValue(long[] value)	Gets or sets the min sample value.
setSoftwareType(String value)	Gets or sets the software type.
setSource(Source value)	Gets or sets the source to create image in.
setStripByteCounts(long[] value)	Gets or sets the strip byte counts.
setStripOffsets(long[] value)	Gets or sets the strip offsets.
setSubFileType(long value)	Gets or sets a general indication of the kind of data contained in this subfile.
setTags(TiffDataType[] value)	Gets or sets the tags.
setTargetPrinter(String value)	Gets or sets the target printer.
setThreshholding(int value)	Gets or sets the threshholding.
setTileByteCounts(long[] value)	Gets or sets the tile byte counts.
setTileLength(long value)	Gets ot sets tile length.
setTileOffsets(long[] value)	Gets or sets the tile offsets.
setTileWidth(long value)	Gets ot sets tile width.
setVectorRasterizationOptions(VectorRasterizationOptions value)	Gets or sets the vector rasterization options.
setXPAuthor(String value)	Sets image author, which used by Windows Explorer.
setXPComment(String value)	Sets comment on image, which used by Windows Explorer.
setXPKeywords(String value)	Sets subject image, which used by Windows Explorer.
setXPSubject(String value)	Sets information about image, which used by Windows Explorer.
setXPTitle(String value)	Sets information about image, which used by Windows Explorer.
setXmpData(XmpPacketWrapper value)	Gets or sets the XMP metadata container.
setXposition(TiffRational value)	Gets or sets the x position.
setXresolution(TiffRational value)	Gets or sets the x resolution.
setYCbCrCoefficients(TiffRational[] value)	Gets or sets the YCbCrCoefficients.
setYCbCrSubsampling(int[] value)	Gets or sets the subsampling factors for YCbCr photometric.
setYposition(TiffRational value)	Gets or sets the y position.
setYresolution(TiffRational value)	Gets or sets the y resolution.
toString()
validate()	Validates if options have valid combination of tags
wait()
wait(long arg0)
wait(long arg0, int arg1)

TiffOptions(int expectedFormat, int byteOrder)

public TiffOptions(int expectedFormat, int byteOrder)

Initializes a new instance of the TiffOptions class.

Parameters:

Parameter	Type	Description
expectedFormat	int	The expected tiff file format.
byteOrder	int	The tiff file format byte order to use.

TiffOptions(int expectedFormat)

public TiffOptions(int expectedFormat)

Initializes a new instance of the TiffOptions class. By default little endian convention is used.

Parameters:

Parameter	Type	Description
expectedFormat	int	The expected tiff file format.

TiffOptions(TiffOptions options)

public TiffOptions(TiffOptions options)

Initializes a new instance of the TiffOptions class.

Parameters:

Parameter	Type	Description
options	TiffOptions	The options to copy from.

TiffOptions(TiffDataType[] tags)

public TiffOptions(TiffDataType[] tags)

Initializes a new instance of the TiffOptions class.

Parameters:

Parameter	Type	Description
tags	TiffDataType[]	The tags to initialize options with.

addTag(TiffDataType tagToAdd)

public void addTag(TiffDataType tagToAdd)

Adds a new tag.

Parameters:

Parameter	Type	Description
tagToAdd	TiffDataType	The tag to add.

addTags(TiffDataType[] tagsToAdd)

public void addTags(TiffDataType[] tagsToAdd)

Adds the tags.

Parameters:

Parameter	Type	Description
tagsToAdd	TiffDataType[]	The tags to add.

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

getAlphaStorage()

public int getAlphaStorage()

Gets or sets the alpha storage option. Options other than TiffAlphaStorage.Unspecified are used when there are more than 3 SamplesPerPixel defined.

Returns: int - The alpha storage option.

getArtist()

public String getArtist()

Gets or sets the artist.

Returns: java.lang.String - The artist.

getBackgroundColor_internalized()

public Color getBackgroundColor_internalized()

Gets or sets the color of the background. Used for internal purposes to store image’s backround color.

Returns: Color - The color of the background.

getBitsPerPixel()

public int getBitsPerPixel()

Gets the bits per pixel.

Returns: int - The bits per pixel.

getBitsPerSample()

public int[] getBitsPerSample()

Gets the bits per sample.

Returns: int[] - The bits per sample value.

When setting this value keep in mind that it will also set SamplesPerPixel value to array length. These 2 properties are very tightly coupled so may be set alltogether only.

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

getByteOrder()

public int getByteOrder()

Gets or sets a value indicating the tiff byte order.

Returns: int

getCache_internalized(int tag)

public long[] getCache_internalized(int tag)

Gets the cache.

Parameters:

Parameter	Type	Description
tag	int	The tag (which is an array type).

Returns: long[] - The tag value.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getColorMap()

public int[] getColorMap()

Gets or sets the color map.

Returns: int[] - The color map.

getCompressedQuality()

public final int getCompressedQuality()

Gets compressed image quality. Used with the Jpeg compression.

Returns: int - compressed image quality.

getCompression()

public int getCompression()

Gets the compression.

Returns: int - The compression.

getCopyright()

public String getCopyright()

Gets the copyright.

Returns: java.lang.String - The copyright.

getDateTime()

public String getDateTime()

Gets or sets the date and time.

Returns: java.lang.String - The date and time.

getDefaultMemoryAllocationLimit()

public int getDefaultMemoryAllocationLimit()

Gets or sets the default memory allocation limit.

Returns: int - The default memory allocation limit.

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 .

getDocumentName()

public String getDocumentName()

Gets or sets the name of the document.

Returns: java.lang.String - The name of the document.

getExifIfd()

public TiffExifIfd getExifIfd()

Gets or sets the pointer to EXIF IFD.

Returns: TiffExifIfd - The pointer to EXIF IFD.

getExtraSampleCount_internalized()

public final long getExtraSampleCount_internalized()

Gets the extra sample count.

Value: The extra sample count.

Returns: long - the extra sample count.

getExtraSamples_internalized()

public final int[] getExtraSamples_internalized()

Gets the extra samples values.

Value: The extra samples value.

Returns: int[] - the extra samples values.

getFaxT4Options()

public long getFaxT4Options()

Gets or sets the fax t4 options.

Returns: long - The fax t4 options.

getFileStandard()

public int getFileStandard()

Gets or sets the TIFF file standard.

Returns: int - The TIFF file standard.

getFillOrder()

public int getFillOrder()

Gets or sets the byte bits fill order.

Returns: int - The byte bits fill order.

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].

getHalfToneHints()

public int[] getHalfToneHints()

Gets or sets the halftone hints.

Returns: int[] - The halftone hints.

getIccProfile()

public byte[] getIccProfile()

Gets the icc profile stream.

Returns: byte[] - The icc profile.

getIccProfile_internalized()

public System.IO.MemoryStream getIccProfile_internalized()

Returns: com.aspose.ms.System.IO.MemoryStream

getImageDescription()

public String getImageDescription()

Gets or sets the image description.

Returns: java.lang.String - The image description.

getImageLength()

public long getImageLength()

Gets or sets the image length.

Returns: long - The image length.

getImageWidth()

public long getImageWidth()

Gets or sets the image width.

Returns: long - The image width.

getInkNames()

public String getInkNames()

Gets or sets the ink names.

Returns: java.lang.String - The ink names.

getMaxSampleValue()

public int[] getMaxSampleValue()

Gets or sets the max sample value.

Returns: int[] - The max sample value.

getMinSampleValue()

public int[] getMinSampleValue()

Gets or sets the min sample value.

Returns: int[] - The min sample value.

getMultiPageOptions()

public final MultiPageOptions getMultiPageOptions()

The multipage options

Returns: MultiPageOptions

getOrientation()

public int getOrientation()

Gets or sets the orientation.

Returns: int - The orientation.

getPageName()

public String getPageName()

Gets or sets the page name.

Returns: java.lang.String - The page name.

getPageNumber()

public int[] getPageNumber()

Gets or sets the page number tag.

Returns: int[] - The page number tag.

getPalette()

public IColorPalette getPalette()

Gets or sets the color palette.

Returns: IColorPalette - The color palette.

getPhotometric()

public int getPhotometric()

Gets or sets the photometric.

Returns: int - The photometric.

getPlanarConfiguration()

public int getPlanarConfiguration()

Gets or sets the planar configuration.

Returns: int - The planar configuration.

getPredictor()

public int getPredictor()

Gets or sets the predictor for LZW compression.

Returns: int - The predictor type.

getPremultiplyComponents()

public boolean getPremultiplyComponents()

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

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

getProgressEventHandler()

public final ProgressEventHandler getProgressEventHandler()

Gets or sets the progress event handler.

Value: The progress event handler.

Returns: ProgressEventHandler

getResolutionSettings()

public ResolutionSetting getResolutionSettings()

Gets or sets the resolution settings.

Returns: ResolutionSetting

getResolutionUnit()

public int getResolutionUnit()

Gets or sets the resolution unit.

Returns: int - The resolution unit.

getRowsPerStrip()

public long getRowsPerStrip()

Gets or sets the rows per strip.

Returns: long - The rows per strip.

getSampleFormat()

public int[] getSampleFormat()

Gets or sets the sample format.

Returns: int[] - The sample format.

getSamplesPerPixel()

public int getSamplesPerPixel()

Gets the samples per pixel. To change this property value use the BitsPerSample property setter.

Returns: int - The samples per pixel.

getScannerManufacturer()

public String getScannerManufacturer()

Gets or sets the scanner manufacturer.

Returns: java.lang.String - The scanner manufacturer.

getScannerModel()

public String getScannerModel()

Gets or sets the scanner model.

Returns: java.lang.String - The scanner model.

getSmaxSampleValue()

public long[] getSmaxSampleValue()

Gets or sets the max sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).

Returns: long[] - The max sample value.

getSminSampleValue()

public long[] getSminSampleValue()

Gets or sets the min sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).

Returns: long[] - The min sample value.

getSoftwareType()

public String getSoftwareType()

Gets or sets the software type.

Returns: java.lang.String - The software type.

getSource()

public final Source getSource()

Gets or sets the source to create image in.

Value: The source to create image in.

Returns: Source

getStripByteCounts()

public long[] getStripByteCounts()

Gets or sets the strip byte counts.

Returns: long[] - The strip byte counts.

getStripOffsets()

public long[] getStripOffsets()

Gets or sets the strip offsets.

Returns: long[] - The strip offsets.

getSubFileType()

public long getSubFileType()

Gets or sets a general indication of the kind of data contained in this subfile.

Returns: long - The general indication of the kind of data contained in this subfile.

getTagByType(int tagKey)

public TiffDataType getTagByType(int tagKey)

Gets the instance of the tag by type.

Parameters:

Parameter	Type	Description
tagKey	int	The tag key.

Returns: TiffDataType - Instance of the tag if exists or null otherwise.

getTags()

public TiffDataType[] getTags()

Gets or sets the tags.

Returns: com.aspose.psd.fileformats.tiff.TiffDataType[] - The tags.

getTargetPrinter()

public String getTargetPrinter()

Gets or sets the target printer.

Returns: java.lang.String - The target printer.

getThreshholding()

public int getThreshholding()

Gets or sets the threshholding.

Returns: int - The threshholding.

getTileByteCounts()

public long[] getTileByteCounts()

Gets or sets the tile byte counts.

Returns: long[]

getTileLength()

public long getTileLength()

Gets ot sets tile length.

Returns: long

getTileOffsets()

public long[] getTileOffsets()

Gets or sets the tile offsets.

Returns: long[]

getTileWidth()

public long getTileWidth()

Gets ot sets tile width.

Returns: long

getTotalPages()

public int getTotalPages()

Gets the total pages.

Returns: int - The total pages.

getValidTagCount()

public int getValidTagCount()

Gets the valid tag count. This is not the total tags count but the number of tags which may be preserved.

Returns: int - The valid tag count.

getValidTagsCount(TiffDataType[] tags)

public static int getValidTagsCount(TiffDataType[] tags)

Gets the valid tags count.

Parameters:

Parameter	Type	Description
tags	TiffDataType[]	The tags to validate.

Returns: int - The valid tags count.

getVectorRasterizationOptions()

public final VectorRasterizationOptions getVectorRasterizationOptions()

Gets or sets the vector rasterization options.

Value: The vector rasterization options.

Returns: VectorRasterizationOptions

getXPAuthor()

public final String getXPAuthor()

Gets image author, which used by Windows Explorer.

Value: Image Author, used by Windows Explorer. The XPAuthor ( #getXPAuthor /.setXPAuthor(String)) is ignored by Windows Explorer if the Artist (.getArtist/.setArtist(String)) tag exists.

Returns: java.lang.String - image author, which used by Windows Explorer.

getXPComment()

public final String getXPComment()

Gets comment on image, which used by Windows Explorer.

Value: Comment on image, used by Windows Explorer.

Returns: java.lang.String - comment on image, which used by Windows Explorer.

getXPKeywords()

public final String getXPKeywords()

Gets subject image, which used by Windows Explorer.

Value: Subject image, used by Windows Explorer.

Returns: java.lang.String - subject image, which used by Windows Explorer.

getXPSubject()

public final String getXPSubject()

Gets information about image, which used by Windows Explorer.

Value: Information about image, used by Windows Explorer.

Returns: java.lang.String - information about image, which used by Windows Explorer.

getXPTitle()

public final String getXPTitle()

Gets information about image, which used by Windows Explorer.

Value: Information about image, used by Windows Explorer. The XPTitle ( #getXPTitle /.setXPTitle(String)) is ignored by Windows Explorer if the ImageDescription (.getImageDescription/.setImageDescription(String)) tag exists.

Returns: java.lang.String - information about image, which used by Windows Explorer.

getXmpData()

public XmpPacketWrapper getXmpData()

Gets or sets the XMP metadata container.

Returns: XmpPacketWrapper - The XMP data container.

getXposition()

public TiffRational getXposition()

Gets or sets the x position.

Returns: TiffRational - The x position.

getXresolution()

public TiffRational getXresolution()

Gets or sets the x resolution.

Returns: TiffRational - The x resolution.

getYCbCrCoefficients()

public TiffRational[] getYCbCrCoefficients()

Gets or sets the YCbCrCoefficients.

Returns: com.aspose.psd.fileformats.tiff.TiffRational[] - The YCbCrCoefficients.

getYCbCrSubsampling()

public int[] getYCbCrSubsampling()

Gets or sets the subsampling factors for YCbCr photometric.

Returns: int[] - The subsampling factors for YCbCr photometric.

getYposition()

public TiffRational getYposition()

Gets or sets the y position.

Returns: TiffRational - The y position.

getYresolution()

public TiffRational getYresolution()

Gets or sets the y resolution.

Returns: TiffRational - The y resolution.

hashCode()

public native int hashCode()

Returns: int

isExtraSamplesPresent()

public boolean isExtraSamplesPresent()

Gets a value indicating whether the extra samples is present.

Returns: boolean - true if the extra samples is present; otherwise, false .

isTagPresent(int tag)

public boolean isTagPresent(int tag)

Determines whether tag is present in the options or not.

Parameters:

Parameter	Type	Description
tag	int	The tag id to check.

Returns: boolean - true if tag is present; otherwise, false .

isTiled()

public boolean isTiled()

Gets a value indicating whether image is tiled.

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

isValid()

public boolean isValid()

Gets a value indicating whether the TiffOptions have been properly configured. Use Validate method as to find the failure reason.

Returns: boolean - true if TiffOptions are properly configured; otherwise, false .

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

removeTag(int tag)

public boolean removeTag(int tag)

Removes the tag.

Parameters:

Parameter	Type	Description
tag	int	The tag to remove.

Returns: boolean - true if successfully removed

setAlphaStorage(int value)

public void setAlphaStorage(int value)

Gets or sets the alpha storage option. Options other than TiffAlphaStorage.Unspecified are used when there are more than 3 SamplesPerPixel defined.

Parameters:

Parameter	Type	Description
value	int	The alpha storage option.

setArtist(String value)

public void setArtist(String value)

Gets or sets the artist.

Parameters:

Parameter	Type	Description
value	java.lang.String	The artist.

setBackgroundColor_internalized(Color value)

public void setBackgroundColor_internalized(Color value)

Gets or sets the color of the background. Used for internal purposes to store image’s backround color.

Parameters:

Parameter	Type	Description
value	Color	The color of the background.

setBitsPerSample(int[] value)

public void setBitsPerSample(int[] value)

Sets the bits per sample.

Parameters:

Parameter	Type	Description
value	int[]	The bits per sample value.

When setting this value keep in mind that it will also set SamplesPerPixel value to array length. These 2 properties are very tightly coupled so may be set alltogether only. |

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

setByteOrder(int value)

public void setByteOrder(int value)

Gets or sets a value indicating the tiff byte order.

Parameters:

Parameter	Type	Description
value	int

setColorMap(int[] value)

public void setColorMap(int[] value)

Gets or sets the color map.

Parameters:

Parameter	Type	Description
value	int[]	The color map.

setCompressedQuality(int value)

public final void setCompressedQuality(int value)

Sets compressed image quality. Used with the Jpeg compression.

Parameters:

Parameter	Type	Description
value	int	compressed image quality.

setCompression(int value)

public void setCompression(int value)

Sets the compression.

Parameters:

Parameter	Type	Description
value	int	The compression.

setCopyright(String value)

public void setCopyright(String value)

Sets the copyright.

Parameters:

Parameter	Type	Description
value	java.lang.String	The copyright.

setDateTime(String value)

public void setDateTime(String value)

Gets or sets the date and time.

Parameters:

Parameter	Type	Description
value	java.lang.String	The date and time.

setDefaultMemoryAllocationLimit(int value)

public void setDefaultMemoryAllocationLimit(int value)

Gets or sets the default memory allocation limit.

Parameters:

Parameter	Type	Description
value	int	The default memory allocation limit.

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

setDocumentName(String value)

public void setDocumentName(String value)

Gets or sets the name of the document.

Parameters:

Parameter	Type	Description
value	java.lang.String	The name of the document.

setExtraSamples_internalized(int[] value)

public void setExtraSamples_internalized(int[] value)

Sets the extra samples values.

Parameters:

Parameter	Type	Description
value	int[]	The extra samples value.

setFaxT4Options(long value)

public void setFaxT4Options(long value)

Gets or sets the fax t4 options.

Parameters:

Parameter	Type	Description
value	long	The fax t4 options.

setFileStandard(int value)

public void setFileStandard(int value)

Gets or sets the TIFF file standard.

Parameters:

Parameter	Type	Description
value	int	The TIFF file standard.

setFillOrder(int value)

public void setFillOrder(int value)

Gets or sets the byte bits fill order.

Parameters:

Parameter	Type	Description
value	int	The byte bits fill order.

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].

setHalfToneHints(int[] value)

public void setHalfToneHints(int[] value)

Gets or sets the halftone hints.

Parameters:

Parameter	Type	Description
value	int[]	The halftone hints.

setIccProfile(byte[] value)

public void setIccProfile(byte[] value)

Sets the icc profile stream.

Parameters:

Parameter	Type	Description
value	byte[]	The icc profile.

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

setImageDescription(String value)

public void setImageDescription(String value)

Gets or sets the image description.

Parameters:

Parameter	Type	Description
value	java.lang.String	The image description.

setImageLength(long value)

public void setImageLength(long value)

Gets or sets the image length.

Parameters:

Parameter	Type	Description
value	long	The image length.

setImageWidth(long value)

public void setImageWidth(long value)

Gets or sets the image width.

Parameters:

Parameter	Type	Description
value	long	The image width.

setInkNames(String value)

public void setInkNames(String value)

Gets or sets the ink names.

Parameters:

Parameter	Type	Description
value	java.lang.String	The ink names.

setMaxSampleValue(int[] value)

public void setMaxSampleValue(int[] value)

Gets or sets the max sample value.

Parameters:

Parameter	Type	Description
value	int[]	The max sample value.

setMinSampleValue(int[] value)

public void setMinSampleValue(int[] value)

Gets or sets the min sample value.

Parameters:

Parameter	Type	Description
value	int[]	The min sample value.

setMultiPageOptions(MultiPageOptions value)

public final void setMultiPageOptions(MultiPageOptions value)

The multipage options

Parameters:

Parameter	Type	Description
value	MultiPageOptions

setOrientation(int value)

public void setOrientation(int value)

Gets or sets the orientation.

Parameters:

Parameter	Type	Description
value	int	The orientation.

setPageName(String value)

public void setPageName(String value)

Gets or sets the page name.

Parameters:

Parameter	Type	Description
value	java.lang.String	The page name.

setPageNumber(int[] value)

public void setPageNumber(int[] value)

Gets or sets the page number tag.

Parameters:

Parameter	Type	Description
value	int[]	The page number tag.

setPalette(IColorPalette value)

public void setPalette(IColorPalette value)

Gets or sets the color palette.

Parameters:

Parameter	Type	Description
value	IColorPalette	The color palette.

setPhotometric(int value)

public void setPhotometric(int value)

Gets or sets the photometric.

Parameters:

Parameter	Type	Description
value	int	The photometric.

setPlanarConfiguration(int value)

public void setPlanarConfiguration(int value)

Gets or sets the planar configuration.

Parameters:

Parameter	Type	Description
value	int	The planar configuration.

setPredictor(int value)

public void setPredictor(int value)

Gets or sets the predictor for LZW compression.

Parameters:

Parameter	Type	Description
value	int	The predictor type.

setPremultiplyComponents(boolean value)

public void setPremultiplyComponents(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean	true if components must be premultiplied; otherwise, false .

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

setResolutionSettings(ResolutionSetting value)

public void setResolutionSettings(ResolutionSetting value)

Gets or sets the resolution settings.

Parameters:

Parameter	Type	Description
value	ResolutionSetting

setResolutionUnit(int value)

public void setResolutionUnit(int value)

Gets or sets the resolution unit.

Parameters:

Parameter	Type	Description
value	int	The resolution unit.

setRowsPerStrip(long value)

public void setRowsPerStrip(long value)

Gets or sets the rows per strip.

Parameters:

Parameter	Type	Description
value	long	The rows per strip.

setSampleFormat(int[] value)

public void setSampleFormat(int[] value)

Gets or sets the sample format.

Parameters:

Parameter	Type	Description
value	int[]	The sample format.

setScannerManufacturer(String value)

public void setScannerManufacturer(String value)

Gets or sets the scanner manufacturer.

Parameters:

Parameter	Type	Description
value	java.lang.String	The scanner manufacturer.

setScannerModel(String value)

public void setScannerModel(String value)

Gets or sets the scanner model.

Parameters:

Parameter	Type	Description
value	java.lang.String	The scanner model.

setSmaxSampleValue(long[] value)

public void setSmaxSampleValue(long[] value)

Gets or sets the max sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).

Parameters:

Parameter	Type	Description
value	long[]	The max sample value.

setSminSampleValue(long[] value)

public void setSminSampleValue(long[] value)

Gets or sets the min sample value. The value has a field type which best matches the sample data (Byte, Short or Long type).

Parameters:

Parameter	Type	Description
value	long[]	The min sample value.

setSoftwareType(String value)

public void setSoftwareType(String value)

Gets or sets the software type.

Parameters:

Parameter	Type	Description
value	java.lang.String	The software type.

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

setStripByteCounts(long[] value)

public void setStripByteCounts(long[] value)

Gets or sets the strip byte counts.

Parameters:

Parameter	Type	Description
value	long[]	The strip byte counts.

setStripOffsets(long[] value)

public void setStripOffsets(long[] value)

Gets or sets the strip offsets.

Parameters:

Parameter	Type	Description
value	long[]	The strip offsets.

setSubFileType(long value)

public void setSubFileType(long value)

Gets or sets a general indication of the kind of data contained in this subfile.

Parameters:

Parameter	Type	Description
value	long	The general indication of the kind of data contained in this subfile.

setTags(TiffDataType[] value)

public void setTags(TiffDataType[] value)

Gets or sets the tags.

Parameters:

Parameter	Type	Description
value	TiffDataType[]	The tags.

setTargetPrinter(String value)

public void setTargetPrinter(String value)

Gets or sets the target printer.

Parameters:

Parameter	Type	Description
value	java.lang.String	The target printer.

setThreshholding(int value)

public void setThreshholding(int value)

Gets or sets the threshholding.

Parameters:

Parameter	Type	Description
value	int	The threshholding.

setTileByteCounts(long[] value)

public void setTileByteCounts(long[] value)

Gets or sets the tile byte counts.

Parameters:

Parameter	Type	Description
value	long[]

setTileLength(long value)

public void setTileLength(long value)

Gets ot sets tile length.

Parameters:

Parameter	Type	Description
value	long

setTileOffsets(long[] value)

public void setTileOffsets(long[] value)

Gets or sets the tile offsets.

Parameters:

Parameter	Type	Description
value	long[]

setTileWidth(long value)

public void setTileWidth(long value)

Gets ot sets tile width.

Parameters:

Parameter	Type	Description
value	long

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

setXPAuthor(String value)

public final void setXPAuthor(String value)

Sets image author, which used by Windows Explorer.

Value: Image Author, used by Windows Explorer. The XPAuthor (.getXPAuthor/ #setXPAuthor(String) ) is ignored by Windows Explorer if the Artist (.getArtist/.setArtist(String)) tag exists.

Parameters:

Parameter	Type	Description
value	java.lang.String	image author, which used by Windows Explorer.

setXPComment(String value)

public final void setXPComment(String value)

Sets comment on image, which used by Windows Explorer.

Value: Comment on image, used by Windows Explorer.

Parameters:

Parameter	Type	Description
value	java.lang.String	comment on image, which used by Windows Explorer.

setXPKeywords(String value)

public final void setXPKeywords(String value)

Sets subject image, which used by Windows Explorer.

Value: Subject image, used by Windows Explorer.

Parameters:

Parameter	Type	Description
value	java.lang.String	subject image, which used by Windows Explorer.

setXPSubject(String value)

public final void setXPSubject(String value)

Sets information about image, which used by Windows Explorer.

Value: Information about image, used by Windows Explorer.

Parameters:

Parameter	Type	Description
value	java.lang.String	information about image, which used by Windows Explorer.

setXPTitle(String value)

public final void setXPTitle(String value)

Sets information about image, which used by Windows Explorer.

Value: Information about image, used by Windows Explorer. The XPTitle (.getXPTitle/ #setXPTitle(String) ) is ignored by Windows Explorer if the ImageDescription (.getImageDescription/.setImageDescription(String)) tag exists.

Parameters:

Parameter	Type	Description
value	java.lang.String	information about image, which used by Windows Explorer.

setXmpData(XmpPacketWrapper value)

public void setXmpData(XmpPacketWrapper value)

Gets or sets the XMP metadata container.

Parameters:

Parameter	Type	Description
value	XmpPacketWrapper	The XMP data container.

setXposition(TiffRational value)

public void setXposition(TiffRational value)

Gets or sets the x position.

Parameters:

Parameter	Type	Description
value	TiffRational	The x position.

setXresolution(TiffRational value)

public void setXresolution(TiffRational value)

Gets or sets the x resolution.

Parameters:

Parameter	Type	Description
value	TiffRational	The x resolution.

setYCbCrCoefficients(TiffRational[] value)

public void setYCbCrCoefficients(TiffRational[] value)

Gets or sets the YCbCrCoefficients.

Parameters:

Parameter	Type	Description
value	TiffRational[]	The YCbCrCoefficients.

setYCbCrSubsampling(int[] value)

public void setYCbCrSubsampling(int[] value)

Gets or sets the subsampling factors for YCbCr photometric.

Parameters:

Parameter	Type	Description
value	int[]	The subsampling factors for YCbCr photometric.

setYposition(TiffRational value)

public void setYposition(TiffRational value)

Gets or sets the y position.

Parameters:

Parameter	Type	Description
value	TiffRational	The y position.

setYresolution(TiffRational value)

public void setYresolution(TiffRational value)

Gets or sets the y resolution.

Parameters:

Parameter	Type	Description
value	TiffRational	The y resolution.

toString()

public String toString()

Returns: java.lang.String

validate()

public void validate()

Validates if options have valid combination of tags

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