com.aspose.cad.jasperreports.tiff

Constructor Detail

• ASTiffExportParametersBean

  public ASTiffExportParametersBean()

  Instantiates a new Tiff export parameters.

Method Detail

• getFileStandard

  public TiffFileStandardsEnum getFileStandard()

  Gets or sets the TIFF file standard.

  Returns:

  The TIFF file standard.

• setFileStandard

  public void setFileStandard(TiffFileStandardsEnum value)

  Gets or sets the TIFF file standard.

  Parameters:

  value - The TIFF file standard.

• getPremultiplyComponents

  public boolean getPremultiplyComponents()

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

  Returns:

  true if components must be premultiplied; otherwise, false.

• setPremultiplyComponents

  public void setPremultiplyComponents(boolean value)

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

  Parameters:

  value - true if components must be premultiplied; otherwise, false.

• getYCbCrSubsampling

  public int[] getYCbCrSubsampling()

  Gets or sets the subsampling factors for YCbCr photometric.

  Returns:

  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

• setYCbCrSubsampling

  public void setYCbCrSubsampling(int[] value)

  Gets or sets the subsampling factors for YCbCr photometric.

  Parameters:

  value - 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

  public com.aspose.cad.fileformats.tiff.TiffRational[] getYCbCrCoefficients()

  Gets or sets the YCbCrCoefficients.

  Returns:

  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

• setYCbCrCoefficients

  public void setYCbCrCoefficients(com.aspose.cad.fileformats.tiff.TiffRational[] value)

  Gets or sets the YCbCrCoefficients.

  Parameters:

  value - 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

  public String getArtist()

  Gets or sets the artist.

  Returns:

  The artist.

• setArtist

  public void setArtist(String value)

  Gets or sets the artist.

  Parameters:

  value - The artist.

• getByteOrder

  public TiffByteOrderEnum getByteOrder()

  Gets or sets a value indicating the tiff byte order.

  Returns:

• setByteOrder

  public void setByteOrder(TiffByteOrderEnum value)

  Gets or sets a value indicating the tiff byte order.

  Parameters:

  value -

• getIccProfile

  public byte[] getIccProfile()

  Gets the icc profile stream.

  Returns:

  The icc profile.

• setIccProfile

  public void setIccProfile(byte[] value)

  Sets the icc profile stream.

  Parameters:

  value - The icc profile.

• getBitsPerSample

  public int[] getBitsPerSample()

  Gets the bits per sample.

  Returns:

  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.

• setBitsPerSample

  public void setBitsPerSample(int[] value)

  Sets the bits per sample.

  Parameters:

  value - 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

  public int[] getExtraSamples()

  Gets the extra samples values.

  Returns:

  The extra samples value.

• getCompression

  public TiffCompressionsEnum getCompression()

  Gets the compression.

  Returns:

  The compression.

• setCompression

  public void setCompression(TiffCompressionsEnum compression)

  Sets the compression.

  Parameters:

  compression - The compression.

• getCopyright

  public String getCopyright()

  Gets the copyright.

  Returns:

  The copyright.

• setCopyright

  public void setCopyright(String value)

  Sets the copyright.

  Parameters:

  value - The copyright.

• getColorMap

  public int[] getColorMap()

  Gets or sets the color map.

  Returns:

  The color map.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

  com.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).

• setColorMap

  public void setColorMap(int[] value)

  Gets or sets the color map.

  Parameters:

  value - The color map.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

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

  public com.aspose.cad.IColorPalette getPalette()

  Gets or sets the color palette.

  Overrides:

  getPalette in class ImageExportParameters

  Returns:

  The color palette.

• setPalette

  public void setPalette(com.aspose.cad.IColorPalette value)

  Gets or sets the color palette.

  Overrides:

  setPalette in class ImageExportParameters

  Parameters:

  value - The color palette.

• getDateTime

  public String getDateTime()

  Gets or sets the date and time.

  Returns:

  The date and time.

• setDateTime

  public void setDateTime(String value)

  Gets or sets the date and time.

  Parameters:

  value - The date and time.

• getDocumentName

  public String getDocumentName()

  Gets or sets the name of the document.

  Returns:

  The name of the document.

• setDocumentName

  public void setDocumentName(String value)

  Gets or sets the name of the document.

  Parameters:

  value - The name of the document.

• getAlphaStorage

  public TiffAlphaStorageEnum getAlphaStorage()

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

  Returns:

  The alpha storage option.

• setAlphaStorage

  public void setAlphaStorage(TiffAlphaStorageEnum alphaStorage)

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

  Parameters:

  alphaStorage - The alpha storage option.

• isExtraSamplesPresent

  public boolean isExtraSamplesPresent()

  Gets a value indicating whether the extra samples is present.

  Returns:

  true if the extra samples is present; otherwise, false.

• getFillOrder

  public TiffFillOrdersEnum getFillOrder()

  Gets or sets the byte bits fill order.

  Returns:

  The byte bits fill order.

• setFillOrder

  public void setFillOrder(TiffFillOrdersEnum fillOrder)

  Gets or sets the byte bits fill order.

  Parameters:

  fillOrder - The byte bits fill order.

• getHalfToneHints

  public int[] getHalfToneHints()

  Gets or sets the halftone hints.

  Returns:

  The halftone hints.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

  com.aspose.ms.System.ArgumentOutOfRangeException - value;Halftone hints array length must be equal to 2.

• setHalfToneHints

  public void setHalfToneHints(int[] value)

  Gets or sets the halftone hints.

  Parameters:

  value - The halftone hints.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

  com.aspose.ms.System.ArgumentOutOfRangeException - value;Halftone hints array length must be equal to 2.

• getImageDescription

  public String getImageDescription()

  Gets or sets the image description.

  Returns:

  The image description.

• setImageDescription

  public void setImageDescription(String value)

  Gets or sets the image description.

  Parameters:

  value - The image description.

• getInkNames

  public String getInkNames()

  Gets or sets the ink names.

  Returns:

  The ink names.

• setInkNames

  public void setInkNames(String value)

  Gets or sets the ink names.

  Parameters:

  value - The ink names.

• getScannerManufacturer

  public String getScannerManufacturer()

  Gets or sets the scanner manufacturer.

  Returns:

  The scanner manufacturer.

• setScannerManufacturer

  public void setScannerManufacturer(String value)

  Gets or sets the scanner manufacturer.

  Parameters:

  value - The scanner manufacturer.

• getMaxSampleValue

  public int[] getMaxSampleValue()

  Gets or sets the max sample value.

  Returns:

  The max sample value.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

  com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.

• setMaxSampleValue

  public void setMaxSampleValue(int[] value)

  Gets or sets the max sample value.

  Parameters:

  value - The max sample value.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

  com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.

• getMinSampleValue

  public int[] getMinSampleValue()

  Gets or sets the min sample value.

  Returns:

  The min sample value.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

  com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.

• setMinSampleValue

  public void setMinSampleValue(int[] value)

  Gets or sets the min sample value.

  Parameters:

  value - The min sample value.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

  com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.

• getScannerModel

  public String getScannerModel()

  Gets or sets the scanner model.

  Returns:

  The scanner model.

• setScannerModel

  public void setScannerModel(String value)

  Gets or sets the scanner model.

  Parameters:

  value - The scanner model.

• getOrientation

  public TiffOrientationsEnum getOrientation()

  Gets or sets the orientation.

  Returns:

  The orientation.

• setOrientation

  public void setOrientation(TiffOrientationsEnum orientation)

  Gets or sets the orientation.

  Parameters:

  orientation - The orientation.

• getPageName

  public String getPageName()

  Gets or sets the page name.

  Returns:

  The page name.

• setPageName

  public void setPageName(String value)

  Gets or sets the page name.

  Parameters:

  value - The page name.

• getPageNumber

  public int[] getPageNumber()

  Gets or sets the page number tag.

  Returns:

  The page number tag.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

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

• setPageNumber

  public void setPageNumber(int[] value)

  Gets or sets the page number tag.

  Parameters:

  value - The page number tag.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

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

  public TiffPhotometricsEnum getPhotometric()

  Gets or sets the photometric.

  Returns:

  The photometric.

  See Also:

  TiffPhotometrics

• setPhotometric

  public void setPhotometric(TiffPhotometricsEnum photometric)

  Gets or sets the photometric.

  Parameters:

  photometric - The photometric.

• getPlanarConfiguration

  public TiffPlanarConfigsEnum getPlanarConfiguration()

  Gets or sets the planar configuration.

  Returns:

  The planar configuration.

• setPlanarConfiguration

  public void setPlanarConfiguration(TiffPlanarConfigsEnum planarConfiguration)

  Gets or sets the planar configuration.

  Parameters:

  planarConfiguration - The planar configuration.

• getResolutionUnit

  public TiffResolutionUnitsEnum getResolutionUnit()

  Gets or sets the resolution unit.

  Returns:

  The resolution unit.

• setResolutionUnit

  public void setResolutionUnit(TiffResolutionUnitsEnum resolutionUnitsEnum)

  Gets or sets the resolution unit.

  Parameters:

  resolutionUnitsEnum - The resolution unit.

• getRowsPerStrip

  public long getRowsPerStrip()

  Gets or sets the rows per strip.

  Returns:

  The rows per strip.

• setRowsPerStrip

  public void setRowsPerStrip(long value)

  Gets or sets the rows per strip.

  Parameters:

  value - The rows per strip.

• getTileWidth

  public long getTileWidth()

  Gets ot sets tile width.

• setTileWidth

  public void setTileWidth(long value)

  Gets ot sets tile width.

• getTileLength

  public long getTileLength()

  Gets ot sets tile length.

• setTileLength

  public void setTileLength(long value)

  Gets ot sets tile length.

• getSampleFormat

  public TiffSampleFormatsEnum[] getSampleFormat()

  Gets or sets the sample format.

  Returns:

  The sample format.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

  com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.

• setSampleFormat

  public void setSampleFormat(TiffSampleFormatsEnum[] sampleFormats)

  Gets or sets the sample format.

  Parameters:

  sampleFormats - The sample format.

  Throws:

  com.aspose.ms.System.ArgumentNullException - value

  com.aspose.ms.System.ArgumentOutOfRangeException - value;The array length must correspond to the samples per pixel count.

• getSamplesPerPixel

  public int getSamplesPerPixel()

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

  Returns:

  The samples per pixel.

• 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:

  The max sample value.

• setSmaxSampleValue

  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:

  value - 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:

  The min sample value.

• setSminSampleValue

  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:

  value - The min sample value.

• getSoftwareType

  public String getSoftwareType()

  Gets or sets the software type.

  Returns:

  The software type.

• setSoftwareType

  public void setSoftwareType(String value)

  Gets or sets the software type.

  Parameters:

  value - The software type.

• getStripByteCounts

  public long[] getStripByteCounts()

  Gets or sets the strip byte counts.

  Returns:

  The strip byte counts.

• setStripByteCounts

  public void setStripByteCounts(long[] value)

  Gets or sets the strip byte counts.

  Parameters:

  value - The strip byte counts.

• getStripOffsets

  public long[] getStripOffsets()

  Gets or sets the strip offsets.

  Returns:

  The strip offsets.

• setStripOffsets

  public void setStripOffsets(long[] value)

  Gets or sets the strip offsets.

  Parameters:

  value - The strip offsets.

• getTileByteCounts

  public long[] getTileByteCounts()

  Gets or sets the tile byte counts.

• setTileByteCounts

  public void setTileByteCounts(long[] value)

  Gets or sets the tile byte counts.

• getTileOffsets

  public long[] getTileOffsets()

  Gets or sets the tile offsets.

• setTileOffsets

  public void setTileOffsets(long[] value)

  Gets or sets the tile offsets.

• getSubFileType

  public TiffNewSubFileTypesEnum getSubFileType()

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

  Returns:

  The general indication of the kind of data contained in this subfile.

• setSubFileType

  public void setSubFileType(TiffNewSubFileTypesEnum subFileType)

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

  Parameters:

  subFileType - The general indication of the kind of data contained in this subfile.

• getTargetPrinter

  public String getTargetPrinter()

  Gets or sets the target printer.

  Returns:

  The target printer.

• setTargetPrinter

  public void setTargetPrinter(String value)

  Gets or sets the target printer.

  Parameters:

  value - The target printer.

• getThreshholding

  public TiffThresholdsEnum getThreshholding()

  Gets or sets the threshholding.

  Returns:

  The threshholding.

• setThreshholding

  public void setThreshholding(TiffThresholdsEnum threshholding)

  Gets or sets the threshholding.

  Parameters:

  threshholding - The threshholding.

• getTotalPages

  public int getTotalPages()

  Gets the total pages.

  Returns:

  The total pages.

• getXposition

  public com.aspose.cad.fileformats.tiff.TiffRational getXposition()

  Gets or sets the x position.

  Returns:

  The x position.

• setXposition

  public void setXposition(com.aspose.cad.fileformats.tiff.TiffRational value)

  Gets or sets the x position.

  Parameters:

  value - The x position.

• getResolutionSettings

  public com.aspose.cad.ResolutionSetting getResolutionSettings()

  Gets or sets the resolution settings.

  Overrides:

  getResolutionSettings in class ImageExportParameters

  Returns:

  the resolution settings

• setResolutionSettings

  public void setResolutionSettings(com.aspose.cad.ResolutionSetting value)

  Gets or sets the resolution settings.

  Overrides:

  setResolutionSettings in class ImageExportParameters

  Parameters:

  value - the value

• getXresolution

  public com.aspose.cad.fileformats.tiff.TiffRational getXresolution()

  Gets or sets the x resolution.

  Returns:

  The x resolution.

• setXresolution

  public void setXresolution(com.aspose.cad.fileformats.tiff.TiffRational value)

  Gets or sets the x resolution.

  Parameters:

  value - The x resolution.

• getYposition

  public com.aspose.cad.fileformats.tiff.TiffRational getYposition()

  Gets or sets the y position.

  Returns:

  The y position.

• setYposition

  public void setYposition(com.aspose.cad.fileformats.tiff.TiffRational value)

  Gets or sets the y position.

  Parameters:

  value - The y position.

• getYresolution

  public com.aspose.cad.fileformats.tiff.TiffRational getYresolution()

  Gets or sets the y resolution.

  Returns:

  The y resolution.

• setYresolution

  public void setYresolution(com.aspose.cad.fileformats.tiff.TiffRational value)

  Gets or sets the y resolution.

  Parameters:

  value - The y resolution.

• getFaxT4Options

  public Group3OptionsEnum getFaxT4Options()

  Gets or sets the fax t4 options.

  Returns:

  The fax t4 options.

• setFaxT4Options

  public void setFaxT4Options(Group3OptionsEnum value)

  Gets or sets the fax t4 options.

  Parameters:

  value - The fax t4 options.

• getPredictor

  public TiffPredictorEnum getPredictor()

  Gets or sets the predictor for LZW compression.

  Returns:

  The predictor type.

• setPredictor

  public void setPredictor(TiffPredictorEnum predictor)

  Gets or sets the predictor for LZW compression.

  Parameters:

  predictor - The predictor type.

• getImageLength

  public long getImageLength()

  Gets or sets the image length.

  Returns:

  The image length.

• setImageLength

  public void setImageLength(long value)

  Gets or sets the image length.

  Parameters:

  value - The image length.

• getImageWidth

  public long getImageWidth()

  Gets or sets the image width.

  Returns:

  The image width.

• setImageWidth

  public void setImageWidth(long value)

  Gets or sets the image width.

  Parameters:

  value - The image width.

• getExifIfd

  public com.aspose.cad.fileformats.tiff.TiffExifIfd getExifIfd()

  Gets or sets the pointer to EXIF IFD.

  Returns:

  The pointer to EXIF IFD.

• getTags

  public com.aspose.cad.fileformats.tiff.TiffDataType[] getTags()

  Gets or sets the tags.

  Returns:

  The tags.

• setTags

  public void setTags(com.aspose.cad.fileformats.tiff.TiffDataType[] value)

  Gets or sets the tags.

  Parameters:

  value - The tags.

• 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:

  The valid tag count.

• getBitsPerPixel

  public int getBitsPerPixel()

  Gets the bits per pixel.

  Returns:

  The bits per pixel.

• removeTag

  public boolean removeTag(int tag)

  Removes the tag.

  Parameters:

  tag - The tag to remove.

  Returns:

  true if successfully removed

• removeTag

  public boolean removeTag(TiffTagsEnum tag)

• addTags

  public void addTags(com.aspose.cad.fileformats.tiff.TiffDataType[] tagsToAdd)

  Adds the tags.

  Parameters:

  tagsToAdd - The tags to add.

• addTag

  public void addTag(com.aspose.cad.fileformats.tiff.TiffDataType tagToAdd)

  Adds a new tag.

  Parameters:

  tagToAdd - The tag to add.

• getTagByType

  public com.aspose.cad.fileformats.tiff.TiffDataType getTagByType(TiffTagsEnum tagKey)

  Gets the instance of the tag by type.

  Parameters:

  tagKey - The tag key.

  Returns:

  Instance of the tag if exists or null otherwise.

• getExpectedFormat

  public TiffExpectedFormatEnum getExpectedFormat()

  Gets expected tiff file format.

  Returns:

  expected tiff file format.

• setExpectedFormat

  public void setExpectedFormat(TiffExpectedFormatEnum expectedFormat)

  Gets expected tiff file format.

  Parameters:

  expectedFormat - Expected tiff file format..

• setPropertyValues

  public void setPropertyValues(Object object)

  Specified by:

  setPropertyValues in interface com.jaspersoft.jasperserver.api.engine.jasperreports.common.ExportParameters

  Overrides:

  setPropertyValues in class ImageExportParameters