CPDFGeneration.layout

Class CImage

java.lang.Object

CPDFGeneration.layout.CElementPropertyContainer

CPDFGeneration.layout.CAbstractElement

CPDFGeneration.layout.CImage

All Implemented Interfaces:

CIElement

public class CImage
extends CAbstractElement

Field Summary

Fields inherited from class CPDFGeneration.layout.CElementPropertyContainer

elementPtr

Constructor Summary

Constructors

Constructor and Description
CImage(long ptr) Create an image element with native pointer.

Method Summary

Modifier and Type	Method and Description
CUnitValue	getHeight() Get height of this image element.
float	getImageHeight() Get the intrinsic image height (before scaling).
float	getImageScaledHeight() Get scaled image height.
float	getImageScaledWidth() Get scaled image width.
float	getImageWidth() Get the intrinsic image width (before scaling).
CUnitValue	getMarginBottom() Get bottom margin.
CUnitValue	getMarginLeft() Get left margin.
CUnitValue	getMarginRight() Get right margin.
CUnitValue	getMarginTop() Get top margin.
CUnitValue	getPaddingBottom() Get bottom padding.
CUnitValue	getPaddingLeft() Get left padding.
CUnitValue	getPaddingRight() Get right padding.
CUnitValue	getPaddingTop() Get top padding.
CElementType	getType() Get element type.
CUnitValue	getWidth() Get width of this image element.
void	scale(float horizontalScale, float verticalScale) Scale the image element by the specified factors.
void	scaleAbsolute(float fitWidth, float fitHeight) Scale the image using absolute sizing to fit within a bounding box (implementation-defined behavior).
void	scaleToFit(float fitWidth, float fitHeight) Scale the image to fit within a bounding box (implementation-defined behavior).
void	setAbsolutePosition(float left, float bottom) Set absolute position for this image element.
void	setAutoScale(boolean autoScale) Enable/disable auto scaling.
void	setAutoScaleHeight(boolean autoScale) Enable/disable auto scaling based on height.
void	setAutoScaleWidth(boolean autoScale) Enable/disable auto scaling based on width.
void	setHeight(CUnitValue height) Set image element height with unit value.
void	setHeight(float height) Set image element height in points.
void	setMargin(float margin) Set all margins using the same value.
void	setMarginBottom(float marginBottom) Set bottom margin.
void	setMarginLeft(float marginLeft) Set left margin.
void	setMarginRight(float marginRight) Set right margin.
void	setMargins(float marginTop, float marginRight, float marginBottom, float marginLeft) Set margins for each side.
void	setMarginTop(float marginTop) Set top margin.
void	setMaxHeight(CUnitValue maxHeight) Set maximum height with unit value.
void	setMaxHeight(float maxHeight) Set maximum height in points.
void	setMaxWidth(CUnitValue maxWidth) Set maximum width with unit value.
void	setMaxWidth(float maxWidth) Set maximum width in points.
void	setMinHeight(CUnitValue minHeight) Set minimum height with unit value.
void	setMinHeight(float minHeight) Set minimum height in points.
void	setMinWidth(CUnitValue minWidth) Set minimum width with unit value.
void	setMinWidth(float minWidth) Set minimum width in points.
void	setPadding(float padding) Set all paddings using the same value.
void	setPaddingBottom(float paddingBottom) Set bottom padding.
void	setPaddingLeft(float paddingLeft) Set left padding.
void	setPaddingRight(float paddingRight) Set right padding.
void	setPaddings(float paddingTop, float paddingRight, float paddingBottom, float paddingLeft) Set paddings for each side.
void	setPaddingTop(float paddingTop) Set top padding.
void	setWidth(CUnitValue width) Set image element width with unit value.
void	setWidth(float width) Set image element width in points.

Methods inherited from class CPDFGeneration.layout.CAbstractElement

addStyle, getChildren, getStyles, hasProperty, isAbsolute, isEmpty

Methods inherited from class CPDFGeneration.layout.CElementPropertyContainer

deleteProperty, getProperties, getStrokeColor, getStrokeWidth, hasProperty, setAbsolutePosition, setAbsolutePosition, setBackgroundColor, setBackgroundImage, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setFontColor, setFontFamily, setFontSize, setFontStyle, setFontWeight, setHorizontalAlignment, setInlineVerticalAlignment, setOpacity, setStrokeColor, setStrokeWidth, setTextAlignment, setUnderline, setWordSpacing

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CImage

public CImage(long ptr)

Create an image element with native pointer.

Parameters:

ptr - Native image pointer/handle.

Method Detail

getType

public CElementType getType()

Get element type.

Returns:

CElementType.ELEMENT_IMAGE.

setAbsolutePosition

public void setAbsolutePosition(float left,
                                float bottom)

Set absolute position for this image element.

Parameters:

left - Left position.

bottom - Bottom position.

setMarginLeft

public void setMarginLeft(float marginLeft)

Set left margin.

Parameters:

marginLeft - Left margin value.

setMarginRight

public void setMarginRight(float marginRight)

Set right margin.

Parameters:

marginRight - Right margin value.

setMarginTop

public void setMarginTop(float marginTop)

Set top margin.

Parameters:

marginTop - Top margin value.

setMarginBottom

public void setMarginBottom(float marginBottom)

Set bottom margin.

Parameters:

marginBottom - Bottom margin value.

setMargin

public void setMargin(float margin)

Set all margins using the same value.

Parameters:

margin - Margin value applied to all sides.

setMargins

public void setMargins(float marginTop,
                       float marginRight,
                       float marginBottom,
                       float marginLeft)

Set margins for each side.

Parameters:

marginTop - Top margin.

marginRight - Right margin.

marginBottom - Bottom margin.

marginLeft - Left margin.

getMarginLeft

public CUnitValue getMarginLeft()

Get left margin.

Returns:

Left margin as CUnitValue.

getMarginRight

public CUnitValue getMarginRight()

Get right margin.

Returns:

Right margin as CUnitValue.

getMarginTop

public CUnitValue getMarginTop()

Get top margin.

Returns:

Top margin as CUnitValue.

getMarginBottom

public CUnitValue getMarginBottom()

Get bottom margin.

Returns:

Bottom margin as CUnitValue.

setPaddingLeft

public void setPaddingLeft(float paddingLeft)

Set left padding.

Parameters:

paddingLeft - Left padding value.

setPaddingRight

public void setPaddingRight(float paddingRight)

Set right padding.

Parameters:

paddingRight - Right padding value.

setPaddingTop

public void setPaddingTop(float paddingTop)

Set top padding.

Parameters:

paddingTop - Top padding value.

setPaddingBottom

public void setPaddingBottom(float paddingBottom)

Set bottom padding.

Parameters:

paddingBottom - Bottom padding value.

setPadding

public void setPadding(float padding)

Set all paddings using the same value.

Parameters:

padding - Padding value applied to all sides.

setPaddings

public void setPaddings(float paddingTop,
                        float paddingRight,
                        float paddingBottom,
                        float paddingLeft)

Set paddings for each side.

Parameters:

paddingTop - Top padding.

paddingRight - Right padding.

paddingBottom - Bottom padding.

paddingLeft - Left padding.

getPaddingLeft

public CUnitValue getPaddingLeft()

Get left padding.

Returns:

Left padding as CUnitValue.

getPaddingRight

public CUnitValue getPaddingRight()

Get right padding.

Returns:

Right padding as CUnitValue.

getPaddingTop

public CUnitValue getPaddingTop()

Get top padding.

Returns:

Top padding as CUnitValue.

getPaddingBottom

public CUnitValue getPaddingBottom()

Get bottom padding.

Returns:

Bottom padding as CUnitValue.

scale

public void scale(float horizontalScale,
                  float verticalScale)

Scale the image element by the specified factors.

Parameters:

horizontalScale - Horizontal scale factor.

verticalScale - Vertical scale factor.

scaleToFit

public void scaleToFit(float fitWidth,
                       float fitHeight)

Scale the image to fit within a bounding box (implementation-defined behavior).

Parameters:

fitWidth - Target fit width.

fitHeight - Target fit height.

scaleAbsolute

public void scaleAbsolute(float fitWidth,
                          float fitHeight)

Scale the image using absolute sizing to fit within a bounding box (implementation-defined behavior).

Parameters:

fitWidth - Target fit width.

fitHeight - Target fit height.

setAutoScale

public void setAutoScale(boolean autoScale)

Enable/disable auto scaling.

Parameters:

autoScale - true to enable auto scaling, false to disable.

setAutoScaleHeight

public void setAutoScaleHeight(boolean autoScale)

Enable/disable auto scaling based on height.

Parameters:

autoScale - true to enable, false to disable.

setAutoScaleWidth

public void setAutoScaleWidth(boolean autoScale)

Enable/disable auto scaling based on width.

Parameters:

autoScale - true to enable, false to disable.

getImageScaledHeight

public float getImageScaledHeight()

Get scaled image height.

Returns:

Scaled height.

getImageScaledWidth

public float getImageScaledWidth()

Get scaled image width.

Returns:

Scaled width.

setWidth

public void setWidth(float width)

Set image element width in points.

Parameters:

width - Width value in points.

setHeight

public void setHeight(float height)

Set image element height in points.

Parameters:

height - Height value in points.

setWidth

public void setWidth(CUnitValue width)

Set image element width with unit value.

Parameters:

width - Width as CUnitValue.

setHeight

public void setHeight(CUnitValue height)

Set image element height with unit value.

Parameters:

height - Height as CUnitValue.

getWidth

public CUnitValue getWidth()

Get width of this image element.

Returns:

Width as CUnitValue.

getHeight

public CUnitValue getHeight()

Get height of this image element.

Returns:

Height as CUnitValue.

setMaxWidth

public void setMaxWidth(float maxWidth)

Set maximum width in points.

Parameters:

maxWidth - Maximum width value in points.

setMaxWidth

public void setMaxWidth(CUnitValue maxWidth)

Set maximum width with unit value.

Parameters:

maxWidth - Maximum width as CUnitValue.

setMinWidth

public void setMinWidth(float minWidth)

Set minimum width in points.

Parameters:

minWidth - Minimum width value in points.

setMinWidth

public void setMinWidth(CUnitValue minWidth)

Set minimum width with unit value.

Parameters:

minWidth - Minimum width as CUnitValue.

setMaxHeight

public void setMaxHeight(float maxHeight)

Set maximum height in points.

Parameters:

maxHeight - Maximum height value in points.

setMaxHeight

public void setMaxHeight(CUnitValue maxHeight)

Set maximum height with unit value.

Parameters:

maxHeight - Maximum height as CUnitValue.

setMinHeight

public void setMinHeight(float minHeight)

Set minimum height in points.

Parameters:

minHeight - Minimum height value in points.

setMinHeight

public void setMinHeight(CUnitValue minHeight)

Set minimum height with unit value.

Parameters:

minHeight - Minimum height as CUnitValue.

getImageWidth

public float getImageWidth()

Get the intrinsic image width (before scaling).

Returns:

Image width.

getImageHeight

public float getImageHeight()

Get the intrinsic image height (before scaling).

Returns:

Image height.