ASTiffExportConfiguration
Inheritance: java.lang.Object, ImageExportConfiguration
The TIFF file format export configuration.
Methods
| Method | Description |
|---|---|
| getFileStandard() | Gets or sets the TIFF file standard. |
| getPremultiplyComponents() | Gets or sets a value indicating whether components must be premultiplied. |
| getYCbCrSubsampling() | Gets or sets the subsampling factors for YCbCr photometric. |
| getYCbCrCoefficients() | Gets or sets the YCbCrCoefficients. |
| getArtist() | Gets or sets the artist. |
| getByteOrder() | Gets or sets a value indicating the tiff byte order. |
| getIccProfile() | Gets the icc profile stream. |
| getBitsPerSample() | Gets the bits per sample. |
| getExtraSamples() | Gets the extra samples values. |
| getCompression() | Gets the compression. |
| getCopyright() | Gets the copyright. |
| getColorMap() | Gets or sets the color map. |
| getPalette() | Gets or sets the color palette. |
| getDateTime() | Gets or sets the date and time. |
| getDocumentName() | Gets or sets the name of the document. |
| getAlphaStorage() | Gets or sets the alpha storage option. Options other than TiffAlphaStorage.Unspecified are used when there are more than 3 SamplesPerPixel defined. |
| isExtraSamplesPresent() | Gets a value indicating whether the extra samples is present. |
| getFillOrder() | Gets or sets the byte bits fill order. |
| getHalfToneHints() | Gets or sets the halftone hints. |
| getImageDescription() | Gets or sets the image description. |
| getInkNames() | |
| getScannerManufacturer() | Gets or sets the scanner manufacturer. |
| getMaxSampleValue() | Gets or sets the max sample value. |
| getMinSampleValue() | Gets or sets the min sample value. |
| getScannerModel() | Gets or sets the scanner model. |
| getOrientation() | Gets or sets the orientation. |
| getPageName() | Gets or sets the page name. |
| getPageNumber() | Gets or sets the page number tag. |
| getPhotometric() | Gets or sets the photometric. |
| getPlanarConfiguration() | Gets or sets the planar configuration. |
| getResolutionUnit() | Gets or sets the resolution unit. |
| getRowsPerStrip() | Gets or sets the rows per strip. |
| getTileWidth() | Gets ot sets tile width. |
| getTileLength() | Gets ot sets tile length. |
| getSampleFormat() | Gets or sets the sample format. |
| getSamplesPerPixel() | Gets the samples per pixel. To change this property value use the BitsPerSample property setter. |
| 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). |
| 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). |
| getSoftwareType() | Gets or sets the software type. |
| getStripByteCounts() | Gets or sets the strip byte counts. |
| getStripOffsets() | Gets or sets the strip offsets. |
| getTileByteCounts() | Gets or sets the tile byte counts. |
| getTileOffsets() | Gets or sets the tile offsets. |
| getSubFileType() | Gets or sets a general indication of the kind of data contained in this subfile. |
| getTargetPrinter() | Gets or sets the target printer. |
| getThreshholding() | Gets or sets the threshholding. |
| getTotalPages() | Gets the total pages. |
| getXposition() | Gets or sets the x position. |
| getResolutionSettings() | Gets or sets the resolution settings. |
| getXresolution() | Gets or sets the x resolution. |
| getYposition() | Gets or sets the y position. |
| getYresolution() | Gets or sets the y resolution. |
| getFaxT4Options() | Gets or sets the fax t4 options. |
| getPredictor() | Gets or sets the predictor for LZW compression. |
| getImageLength() | Gets or sets the image length. |
| getImageWidth() | Gets or sets the image width. |
| getExifIfd() | Gets or sets the pointer to EXIF IFD. |
| getTags() | Gets or sets the tags. |
| getValidTagCount() | Gets the valid tag count. This is not the total tags count but the number of tags which may be preserved. |
| getBitsPerPixel() | Gets the bits per pixel. |
| getTagByType(TiffTagsEnum tagKey) | Gets the instance of the tag by type. |
| getExpectedFormat() |
getFileStandard()
TiffFileStandardsEnum getFileStandard()
Gets or sets the TIFF file standard.
Returns: TiffFileStandardsEnum - The TIFF file standard.
getPremultiplyComponents()
boolean getPremultiplyComponents()
Gets or sets a value indicating whether components must be premultiplied.
Returns: boolean - true if components must be premultiplied; otherwise, false .
getYCbCrSubsampling()
int[] getYCbCrSubsampling()
Gets or sets the subsampling factors for YCbCr photometric.
Returns: int[] - The subsampling factors for YCbCr photometric.
Throws:
com.aspose.cad.cadexceptions.imageformats.TiffImageException- Invalid field length. YCbCrSubsampling field must contain two values.com.aspose.ms.System.ArgumentNullException- value
getYCbCrCoefficients()
com.aspose.cad.fileformats.tiff.TiffRational[] getYCbCrCoefficients()
Gets or sets the YCbCrCoefficients.
Returns: com.aspose.cad.fileformats.tiff.TiffRational[] - The YCbCrCoefficients.
Throws:
com.aspose.cad.cadexceptions.imageformats.TiffImageException- Invalid count of rational coefficient values. Must be equal to 3.com.aspose.ms.System.ArgumentNullException- value
getArtist()
String getArtist()
Gets or sets the artist.
Returns: String - The artist.
getByteOrder()
TiffByteOrderEnum getByteOrder()
Gets or sets a value indicating the tiff byte order.
Returns: TiffByteOrderEnum
getIccProfile()
byte[] getIccProfile()
Gets the icc profile stream.
Returns: byte[] - The icc profile.
getBitsPerSample()
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.
getExtraSamples()
int[] getExtraSamples()
Gets the extra samples values.
Returns: int[] - The extra samples value.
getCompression()
TiffCompressionsEnum getCompression()
Gets the compression.
Returns: TiffCompressionsEnum - The compression.
getCopyright()
String getCopyright()
Gets the copyright.
Returns: String - The copyright.
getColorMap()
int[] getColorMap()
Gets or sets the color map.
Returns: int[] - The color map.
Throws:
com.aspose.ms.System.ArgumentNullException- valuecom.aspose.cad.cadexceptions.imageformats.TiffImageException- The color map may be defined for samples per pixel equal to 1 only. or The bits per sample are not defined.com.aspose.ms.System.ArgumentOutOfRangeException- value;The array length must correspond to the followign formula: 3 * (2**BitsPerSample).
getPalette()
com.aspose.cad.IColorPalette getPalette()
Gets or sets the color palette.
Returns: com.aspose.cad.IColorPalette - The color palette.
getDateTime()
String getDateTime()
Gets or sets the date and time.
Returns: String - The date and time.
getDocumentName()
String getDocumentName()
Gets or sets the name of the document.
Returns: String - The name of the document.
getAlphaStorage()
TiffAlphaStorageEnum getAlphaStorage()
Gets or sets the alpha storage option. Options other than TiffAlphaStorage.Unspecified are used when there are more than 3 SamplesPerPixel defined.
Returns: TiffAlphaStorageEnum - The alpha storage option.
isExtraSamplesPresent()
boolean isExtraSamplesPresent()
Gets a value indicating whether the extra samples is present.
Returns: boolean - true if the extra samples is present; otherwise, false .
getFillOrder()
TiffFillOrdersEnum getFillOrder()
Gets or sets the byte bits fill order.
Returns: TiffFillOrdersEnum - The byte bits fill order.
getHalfToneHints()
int[] getHalfToneHints()
Gets or sets the halftone hints.
Returns: int[] - The halftone hints.
Throws:
com.aspose.ms.System.ArgumentNullException- valuecom.aspose.ms.System.ArgumentOutOfRangeException- value;Halftone hints array length must be equal to 2.
getImageDescription()
String getImageDescription()
Gets or sets the image description.
Returns: String - The image description.
getInkNames()
String getInkNames()
Returns: String
getScannerManufacturer()
String getScannerManufacturer()
Gets or sets the scanner manufacturer.
Returns: String - The scanner manufacturer.
getMaxSampleValue()
int[] getMaxSampleValue()
Gets or sets the max sample value.
Returns: int[] - The max sample value.
Throws:
com.aspose.ms.System.ArgumentNullException- valuecom.aspose.ms.System.ArgumentOutOfRangeException- value;The array length must correspond to the samples per pixel count.
getMinSampleValue()
int[] getMinSampleValue()
Gets or sets the min sample value.
Returns: int[] - The min sample value.
Throws:
com.aspose.ms.System.ArgumentNullException- valuecom.aspose.ms.System.ArgumentOutOfRangeException- value;The array length must correspond to the samples per pixel count.
getScannerModel()
String getScannerModel()
Gets or sets the scanner model.
Returns: String - The scanner model.
getOrientation()
TiffOrientationsEnum getOrientation()
Gets or sets the orientation.
Returns: TiffOrientationsEnum - The orientation.
getPageName()
String getPageName()
Gets or sets the page name.
Returns: String - The page name.
getPageNumber()
int[] getPageNumber()
Gets or sets the page number tag.
Returns: int[] - The page number tag.
Throws:
com.aspose.ms.System.ArgumentNullException- valuecom.aspose.ms.System.ArgumentOutOfRangeException- value;Expected 2 values in the array: PageNumber[0] is the page number and PageNumber[1] is the total number of pages in the document.
getPhotometric()
TiffPhotometricsEnum getPhotometric()
Gets or sets the photometric.
Returns: TiffPhotometricsEnum - The photometric.
getPlanarConfiguration()
TiffPlanarConfigsEnum getPlanarConfiguration()
Gets or sets the planar configuration.
Returns: TiffPlanarConfigsEnum - The planar configuration.
getResolutionUnit()
TiffResolutionUnitsEnum getResolutionUnit()
Gets or sets the resolution unit.
Returns: TiffResolutionUnitsEnum - The resolution unit.
getRowsPerStrip()
long getRowsPerStrip()
Gets or sets the rows per strip.
Returns: long - The rows per strip.
getTileWidth()
long getTileWidth()
Gets ot sets tile width.
Returns: long
getTileLength()
long getTileLength()
Gets ot sets tile length.
Returns: long
getSampleFormat()
TiffSampleFormatsEnum[] getSampleFormat()
Gets or sets the sample format.
Returns: TiffSampleFormatsEnum[] - The sample format.
Throws:
com.aspose.ms.System.ArgumentNullException- valuecom.aspose.ms.System.ArgumentOutOfRangeException- value;The array length must correspond to the samples per pixel count.
getSamplesPerPixel()
int getSamplesPerPixel()
Gets the samples per pixel. To change this property value use the BitsPerSample property setter.
Returns: int - The samples per pixel.
getSmaxSampleValue()
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()
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()
String getSoftwareType()
Gets or sets the software type.
Returns: String - The software type.
getStripByteCounts()
long[] getStripByteCounts()
Gets or sets the strip byte counts.
Returns: long[] - The strip byte counts.
getStripOffsets()
long[] getStripOffsets()
Gets or sets the strip offsets.
Returns: long[] - The strip offsets.
getTileByteCounts()
long[] getTileByteCounts()
Gets or sets the tile byte counts.
Returns: long[]
getTileOffsets()
long[] getTileOffsets()
Gets or sets the tile offsets.
Returns: long[]
getSubFileType()
TiffNewSubFileTypesEnum getSubFileType()
Gets or sets a general indication of the kind of data contained in this subfile.
Returns: TiffNewSubFileTypesEnum - The general indication of the kind of data contained in this subfile.
getTargetPrinter()
String getTargetPrinter()
Gets or sets the target printer.
Returns: String - The target printer.
getThreshholding()
TiffThresholdsEnum getThreshholding()
Gets or sets the threshholding.
Returns: TiffThresholdsEnum - The threshholding.
getTotalPages()
int getTotalPages()
Gets the total pages.
Returns: int - The total pages.
getXposition()
com.aspose.cad.fileformats.tiff.TiffRational getXposition()
Gets or sets the x position.
Returns: com.aspose.cad.fileformats.tiff.TiffRational - The x position.
getResolutionSettings()
com.aspose.cad.ResolutionSetting getResolutionSettings()
Gets or sets the resolution settings.
Returns: com.aspose.cad.ResolutionSetting
getXresolution()
com.aspose.cad.fileformats.tiff.TiffRational getXresolution()
Gets or sets the x resolution.
Returns: com.aspose.cad.fileformats.tiff.TiffRational - The x resolution.
getYposition()
com.aspose.cad.fileformats.tiff.TiffRational getYposition()
Gets or sets the y position.
Returns: com.aspose.cad.fileformats.tiff.TiffRational - The y position.
getYresolution()
com.aspose.cad.fileformats.tiff.TiffRational getYresolution()
Gets or sets the y resolution.
Returns: com.aspose.cad.fileformats.tiff.TiffRational - The y resolution.
getFaxT4Options()
Group3OptionsEnum getFaxT4Options()
Gets or sets the fax t4 options.
Returns: Group3OptionsEnum - The fax t4 options.
getPredictor()
TiffPredictorEnum getPredictor()
Gets or sets the predictor for LZW compression.
Returns: TiffPredictorEnum - The predictor type.
getImageLength()
long getImageLength()
Gets or sets the image length.
Returns: long - The image length.
getImageWidth()
long getImageWidth()
Gets or sets the image width.
Returns: long - The image width.
getExifIfd()
com.aspose.cad.fileformats.tiff.TiffExifIfd getExifIfd()
Gets or sets the pointer to EXIF IFD.
Returns: com.aspose.cad.fileformats.tiff.TiffExifIfd - The pointer to EXIF IFD.
getTags()
com.aspose.cad.fileformats.tiff.TiffDataType[] getTags()
Gets or sets the tags.
Returns: com.aspose.cad.fileformats.tiff.TiffDataType[] - The tags.
getValidTagCount()
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.
getBitsPerPixel()
int getBitsPerPixel()
Gets the bits per pixel.
Returns: int - The bits per pixel.
getTagByType(TiffTagsEnum tagKey)
com.aspose.cad.fileformats.tiff.TiffDataType getTagByType(TiffTagsEnum tagKey)
Gets the instance of the tag by type.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| tagKey | TiffTagsEnum | The tag key. |
Returns: com.aspose.cad.fileformats.tiff.TiffDataType - Instance of the tag if exists or null otherwise.
getExpectedFormat()
TiffExpectedFormatEnum getExpectedFormat()
Returns: TiffExpectedFormatEnum