AFPPaintingState (Apache FOP 2.1 API)

java.lang.Object
- org.apache.fop.util.AbstractPaintingState
- - org.apache.fop.afp.AFPPaintingState

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class AFPPaintingState
extends AbstractPaintingState
```
This keeps information about the current painting state when writing to an AFP datastream.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.fop.util.AbstractPaintingState
  AbstractPaintingState.AbstractData, AbstractPaintingState.StateStack<E>

Constructor Summary

Constructors
Constructor Description

AFPPaintingState()

Constructors
Constructor	Description
`AFPPaintingState()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`canEmbedJpeg()`	Returns true if JPEGs can be embedded in an AFP document.
`java.lang.Object`	`clone()`
`float`	`getBitmapEncodingQuality()`	Gets the image encoding quality setting to use when encoding bitmap images.
`int`	`getBitsPerPixel()`	Returns the number of bits per pixel
`org.apache.xmlgraphics.java2d.color.ColorConverter`	`getColorConverter()`	Used to convert color in respect of the colorImages flag
`float`	`getDitheringQuality()`	Gets the dithering quality setting to use when converting images to monochrome images.
`boolean`	`getFS45()`	gets whether images should be FS45
`java.lang.String`	`getImageUri()`	Gets the uri of the current image
`protected int`	`getLandscapeRotation()`	Returns the landscape rotation
`float`	`getLineWidthCorrection()`	Returns the line width correction.
`AFPPageFonts`	`getPageFonts()`	Gets the current page fonts
`int`	`getPageHeight()`	Returns the page height
`protected org.apache.fop.afp.AFPPaintingState.AFPPagePaintingState`	`getPagePaintingState()`	Returns the painting state of the current page
`int`	`getPageRotation()`	Returns the page rotation
`int`	`getPageWidth()`	Returns the page width
`java.awt.Point`	`getPoint(int x, int y)`	Returns a point on the current page, taking the current painting state into account.
`protected int`	`getPortraitRotation()`	Returns the rotation to be used for portrait pages
`int`	`getResolution()`	Returns the output/device resolution.
`int`	`getRotation()`	Returns the currently derived rotation
`AFPUnitConverter`	`getUnitConverter()`	Returns the unit converter
`boolean`	`getWrapPSeg()`	Whether FS11 and SF45 non-inline images should be wrapped in a page segment
`protected AbstractPaintingState`	`instantiate()`	Instantiates a new state object
`protected AbstractPaintingState.AbstractData`	`instantiateData()`	Instantiates a new state data object
`boolean`	`isCMYKImagesSupported()`	Indicates whether CMYK images (IOCA FS45) are enabled.
`boolean`	`isColorImages()`	Returns true if color images are to be used
`boolean`	`isGOCAEnabled()`	Indicates whether GOCA is enabled or disabled.
`boolean`	`isNativeImagesSupported()`	Returns true if images are supported natively in this AFP environment
`boolean`	`isStrokeGOCAText()`	Indicates whether to stroke text in GOCA mode or to use text operators where possible.
`void`	`setBitmapEncodingQuality(float quality)`	Sets the image encoding quality setting to use when encoding bitmap images.
`void`	`setBitsPerPixel(int bitsPerPixel)`	Sets the number of bits used per pixel
`void`	`setCanEmbedJpeg(boolean canEmbed)`	Set whether or not JPEG images can be embedded within an AFP document.
`void`	`setCMYKImagesSupported(boolean value)`	Controls whether CMYK images (IOCA FS45) are enabled.
`void`	`setColorImages(boolean colorImages)`	Sets whether images are color or not and instantiates a ColorHandler
`void`	`setDitheringQuality(float quality)`	Sets the dithering quality setting to use when converting images to monochrome images.
`void`	`setFS45(boolean fs45)`	sets whether images should be FS45
`void`	`setGOCAEnabled(boolean enabled)`	Controls whether GOCA is enabled or disabled.
`void`	`setImageUri(java.lang.String uri)`	Sets the uri of the current image
`void`	`setLandscapeRotation(int rotation)`	Sets the rotation to be used for landscape pages, valid values are 0, 90, 180, 270 (default).
`void`	`setLineWidthCorrection(float correction)`	Sets the line width correction
`void`	`setNativeImagesSupported(boolean nativeImagesSupported)`	Sets whether images are natively supported or not in the AFP environment
`void`	`setPageHeight(int pageHeight)`	Sets the page height
`void`	`setPageWidth(int pageWidth)`	Sets the page width
`void`	`setPortraitRotation(int rotation)`	Sets the rotation to be used for portrait pages, valid values are 0 (default), 90, 180, 270.
`void`	`setResolution(int resolution)`	Sets the output/device resolution
`void`	`setStrokeGOCAText(boolean stroke)`	Controls whether to stroke text in GOCA mode or to use text operators where possible.
`void`	`setWrapPSeg(boolean pSeg)`	Sets whether FS11 and FS45 non-inline images should be wrapped in a page segment
`java.lang.String`	`toString()`

Methods inherited from class org.apache.fop.util.AbstractPaintingState
checkTransform, clear, clearTransform, concatenate, getBackColor, getBaseTransform, getColor, getData, getFontName, getFontSize, getLineWidth, getStateStack, getTransform, resetTransform, restore, restoreAll, save, saveAll, setBackColor, setColor, setDashArray, setData, setFontName, setFontSize, setLineWidth

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AFPPaintingState
```
public AFPPaintingState()
```
- Method Detail
  - setPortraitRotation
```
public void setPortraitRotation(int rotation)
```
    Sets the rotation to be used for portrait pages, valid values are 0 (default), 90, 180, 270.
    
    Parameters:
    
    rotation - The rotation in degrees.
  - getPortraitRotation
```
protected int getPortraitRotation()
```
    Returns the rotation to be used for portrait pages
    
    Returns:
    
    the rotation to be used for portrait pages
  - setLandscapeRotation
```
public void setLandscapeRotation(int rotation)
```
    Sets the rotation to be used for landscape pages, valid values are 0, 90, 180, 270 (default).
    
    Parameters:
    
    rotation - The rotation in degrees.
  - getLandscapeRotation
```
protected int getLandscapeRotation()
```
    Returns the landscape rotation
    
    Returns:
    
    the landscape rotation
  - setBitsPerPixel
```
public void setBitsPerPixel(int bitsPerPixel)
```
    Sets the number of bits used per pixel
    
    Parameters:
    
    bitsPerPixel - number of bits per pixel
  - getBitsPerPixel
```
public int getBitsPerPixel()
```
    Returns the number of bits per pixel
    
    Returns:
    
    the number of bits per pixel
  - setColorImages
```
public void setColorImages(boolean colorImages)
```
    Sets whether images are color or not and instantiates a ColorHandler
    
    Parameters:
    
    colorImages - color image output
  - isColorImages
```
public boolean isColorImages()
```
    Returns true if color images are to be used
    
    Returns:
    
    true if color images are to be used
  - getColorConverter
```
public org.apache.xmlgraphics.java2d.color.ColorConverter getColorConverter()
```
    Used to convert color in respect of the colorImages flag
    
    Returns:
    
    the color converter
  - setNativeImagesSupported
```
public void setNativeImagesSupported(boolean nativeImagesSupported)
```
    Sets whether images are natively supported or not in the AFP environment
    
    Parameters:
    
    nativeImagesSupported - true if images are natively supported in this AFP environment
  - isNativeImagesSupported
```
public boolean isNativeImagesSupported()
```
    Returns true if images are supported natively in this AFP environment
    
    Returns:
    
    true if images are supported natively in this AFP environment
  - setCanEmbedJpeg
```
public void setCanEmbedJpeg(boolean canEmbed)
```
    Set whether or not JPEG images can be embedded within an AFP document.
    
    Parameters:
    
    canEmbed - true if the JPEG image can be embedded
  - canEmbedJpeg
```
public boolean canEmbedJpeg()
```
    Returns true if JPEGs can be embedded in an AFP document.
    
    Returns:
    
    true if JPEG embedding is allowed
  - setCMYKImagesSupported
```
public void setCMYKImagesSupported(boolean value)
```
    Controls whether CMYK images (IOCA FS45) are enabled. By default, support is disabled for wider compatibility. When disabled, any CMYK image is converted to the selected color format.
    
    Parameters:
    
    value - true to enabled CMYK images
  - isCMYKImagesSupported
```
public boolean isCMYKImagesSupported()
```
    Indicates whether CMYK images (IOCA FS45) are enabled.
    
    Returns:
    
    true if IOCA FS45 is enabled
  - getDitheringQuality
```
public float getDitheringQuality()
```
    Gets the dithering quality setting to use when converting images to monochrome images.
    
    Returns:
    
    the dithering quality (a value between 0.0f and 1.0f)
  - setDitheringQuality
```
public void setDitheringQuality(float quality)
```
    Sets the dithering quality setting to use when converting images to monochrome images.
    
    Parameters:
    
    quality - Defines the desired quality level for the conversion. Valid values: a value between 0.0f (fastest) and 1.0f (best)
  - getBitmapEncodingQuality
```
public float getBitmapEncodingQuality()
```
    Gets the image encoding quality setting to use when encoding bitmap images.
    
    Returns:
    
    the encoding quality (a value between 0.0f and 1.0f, 1.0 meaning loss-less)
  - setBitmapEncodingQuality
```
public void setBitmapEncodingQuality(float quality)
```
    Sets the image encoding quality setting to use when encoding bitmap images.
    
    Parameters:
    
    quality - Defines the desired quality level for the conversion. Valid values: a value between 0.0f (lowest) and 1.0f (best, loss-less)
  - setResolution
```
public void setResolution(int resolution)
```
    Sets the output/device resolution
    
    Parameters:
    
    resolution - the output resolution (dpi)
  - setLineWidthCorrection
```
public void setLineWidthCorrection(float correction)
```
    Sets the line width correction
    
    Parameters:
    
    correction - the line width multiplying factor correction
  - getResolution
```
public int getResolution()
```
    Returns the output/device resolution.
    
    Returns:
    
    the resolution in dpi
  - getLineWidthCorrection
```
public float getLineWidthCorrection()
```
    Returns the line width correction.
    
    Returns:
    
    the correction
  - setGOCAEnabled
```
public void setGOCAEnabled(boolean enabled)
```
    Controls whether GOCA is enabled or disabled.
    
    Parameters:
    
    enabled - true if GOCA is enabled, false if it is disabled
  - isGOCAEnabled
```
public boolean isGOCAEnabled()
```
    Indicates whether GOCA is enabled or disabled.
    
    Returns:
    
    true if GOCA is enabled, false if GOCA is disabled
  - setStrokeGOCAText
```
public void setStrokeGOCAText(boolean stroke)
```
    Controls whether to stroke text in GOCA mode or to use text operators where possible.
    
    Parameters:
    
    stroke - true to stroke, false to paint with text operators where possible
  - isStrokeGOCAText
```
public boolean isStrokeGOCAText()
```
    Indicates whether to stroke text in GOCA mode or to use text operators where possible.
    
    Returns:
    
    true to stroke, false to paint with text operators where possible
  - getWrapPSeg
```
public boolean getWrapPSeg()
```
    Whether FS11 and SF45 non-inline images should be wrapped in a page segment
    
    Returns:
    
    true iff images should be wrapped
  - setWrapPSeg
```
public void setWrapPSeg(boolean pSeg)
```
    Sets whether FS11 and FS45 non-inline images should be wrapped in a page segment
    
    Parameters:
    
    pSeg - true iff images should be wrapped
  - getFS45
```
public boolean getFS45()
```
    gets whether images should be FS45
    
    Returns:
    
    true iff images should be FS45
  - setFS45
```
public void setFS45(boolean fs45)
```
    sets whether images should be FS45
    
    Parameters:
    
    fs45 - true iff images should be FS45
  - instantiateData
```
protected AbstractPaintingState.AbstractData instantiateData()
```
    Instantiates a new state data object
    
    Specified by:
    
    instantiateData in class AbstractPaintingState
    
    Returns:
    
    a new state data object
  - instantiate
```
protected AbstractPaintingState instantiate()
```
    Instantiates a new state object
    
    Specified by:
    
    instantiate in class AbstractPaintingState
    
    Returns:
    
    a new state object
  - getPagePaintingState
```
protected org.apache.fop.afp.AFPPaintingState.AFPPagePaintingState getPagePaintingState()
```
    Returns the painting state of the current page
    
    Returns:
    
    the painting state of the current page
  - getPageFonts
```
public AFPPageFonts getPageFonts()
```
    Gets the current page fonts
    
    Returns:
    
    the current page fonts
  - setPageWidth
```
public void setPageWidth(int pageWidth)
```
    Sets the page width
    
    Parameters:
    
    pageWidth - the page width
  - getPageWidth
```
public int getPageWidth()
```
    Returns the page width
    
    Returns:
    
    the page width
  - setPageHeight
```
public void setPageHeight(int pageHeight)
```
    Sets the page height
    
    Parameters:
    
    pageHeight - the page height
  - getPageHeight
```
public int getPageHeight()
```
    Returns the page height
    
    Returns:
    
    the page height
  - getPageRotation
```
public int getPageRotation()
```
    Returns the page rotation
    
    Returns:
    
    the page rotation
  - setImageUri
```
public void setImageUri(java.lang.String uri)
```
    Sets the uri of the current image
    
    Parameters:
    
    uri - the uri of the current image
  - getImageUri
```
public java.lang.String getImageUri()
```
    Gets the uri of the current image
    
    Returns:
    
    the uri of the current image
  - getRotation
```
public int getRotation()
```
    Returns the currently derived rotation
    
    Returns:
    
    the currently derived rotation
  - getUnitConverter
```
public AFPUnitConverter getUnitConverter()
```
    Returns the unit converter
    
    Returns:
    
    the unit converter
  - getPoint
```
public java.awt.Point getPoint(int x,
                               int y)
```
    Returns a point on the current page, taking the current painting state into account.
    
    Parameters:
    
    x - the X-coordinate
    
    y - the Y-coordinate
    
    Returns:
    
    a point on the current page
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class AbstractPaintingState
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class AbstractPaintingState

Class AFPPaintingState

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.fop.util.AbstractPaintingState

Constructor Summary

Method Summary

Methods inherited from class org.apache.fop.util.AbstractPaintingState

Methods inherited from class java.lang.Object

Constructor Detail

AFPPaintingState

Method Detail

setPortraitRotation

getPortraitRotation

setLandscapeRotation

getLandscapeRotation

setBitsPerPixel

getBitsPerPixel

setColorImages

isColorImages

getColorConverter

setNativeImagesSupported

isNativeImagesSupported

setCanEmbedJpeg

canEmbedJpeg

setCMYKImagesSupported

isCMYKImagesSupported

getDitheringQuality

setDitheringQuality

getBitmapEncodingQuality

setBitmapEncodingQuality

setResolution

setLineWidthCorrection

getResolution

getLineWidthCorrection

setGOCAEnabled

isGOCAEnabled

setStrokeGOCAText

isStrokeGOCAText

getWrapPSeg

setWrapPSeg

getFS45

setFS45

instantiateData

instantiate

getPagePaintingState

getPageFonts

setPageWidth

getPageWidth

setPageHeight

getPageHeight

getPageRotation

setImageUri

getImageUri

getRotation

getUnitConverter

getPoint

clone

toString