CPDFGeneration.layout

Class CStyle

java.lang.Object

CPDFGeneration.layout.CElementPropertyContainer

CPDFGeneration.layout.CStyle

All Implemented Interfaces:

CIElement

public class CStyle
extends CElementPropertyContainer

Field Summary

Fields inherited from class CPDFGeneration.layout.CElementPropertyContainer

elementPtr

Constructor Summary

Constructors

Constructor and Description
CStyle(long ptr) Create a style object with native pointer.

Method Summary

Modifier and Type	Method and Description
CUnitValue	getHeight() Get height.
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 for this style.
CUnitValue	getWidth() Get width.
boolean	isAbsolute() Check whether this style uses absolute positioning.
void	release() Release the native style resources held by this object.
CStyle	setHeight(CUnitValue height) Set height using a unit value.
CStyle	setHeight(float height) Set height in points.
CStyle	setMargin(float commonMargin) Set all margins using the same value.
CStyle	setMarginBottom(float value) Set bottom margin (commonly in points).
CStyle	setMarginLeft(float value) Set left margin (commonly in points).
CStyle	setMarginRight(float value) Set right margin (commonly in points).
CStyle	setMargins(float marginTop, float marginRight, float marginBottom, float marginLeft) Set margins for each side.
CStyle	setMarginTop(float value) Set top margin (commonly in points).
CStyle	setMaxHeight(CUnitValue maxHeight) Set maximum height using a unit value.
CStyle	setMaxHeight(float maxHeight) Set maximum height in points.
CStyle	setMaxWidth(CUnitValue maxWidth) Set maximum width using a unit value.
CStyle	setMaxWidth(float maxWidth) Set maximum width in points.
CStyle	setMinHeight(CUnitValue minHeight) Set minimum height using a unit value.
CStyle	setMinHeight(float minHeight) Set minimum height in points.
CStyle	setMinWidth(CUnitValue minWidth) Set minimum width using a unit value.
CStyle	setMinWidth(float minWidth) Set minimum width in points.
CStyle	setPadding(float commonPadding) Set all paddings using the same value.
CStyle	setPaddingBottom(float value) Set bottom padding (commonly in points).
CStyle	setPaddingLeft(float value) Set left padding (commonly in points).
CStyle	setPaddingRight(float value) Set right padding (commonly in points).
CStyle	setPaddings(float paddingTop, float paddingRight, float paddingBottom, float paddingLeft) Set paddings for each side.
CStyle	setPaddingTop(float value) Set top padding (commonly in points).
CStyle	setVerticalAlignment(CVerticalAlignment verticalAlignment) Set vertical alignment.
CStyle	setWidth(CUnitValue width) Set width using a unit value.
CStyle	setWidth(float width) Set width in points.

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

CStyle

public CStyle(long ptr)

Create a style object with native pointer.

Parameters:

ptr - Native style pointer/handle.

Method Detail

release

public void release()

Release the native style resources held by this object.

After calling this method, the current instance should not be used anymore.

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.

setMarginLeft

public CStyle setMarginLeft(float value)

Set left margin (commonly in points). This method supports chaining.

Parameters:

value - Left margin value.

Returns:

This CStyle instance.

setMarginRight

public CStyle setMarginRight(float value)

Set right margin (commonly in points). This method supports chaining.

Parameters:

value - Right margin value.

Returns:

This CStyle instance.

setMarginTop

public CStyle setMarginTop(float value)

Set top margin (commonly in points). This method supports chaining.

Parameters:

value - Top margin value.

Returns:

This CStyle instance.

setMarginBottom

public CStyle setMarginBottom(float value)

Set bottom margin (commonly in points). This method supports chaining.

Parameters:

value - Bottom margin value.

Returns:

This CStyle instance.

setMargin

public CStyle setMargin(float commonMargin)

Set all margins using the same value. This method supports chaining.

Parameters:

commonMargin - Margin applied to all sides.

Returns:

This CStyle instance.

setMargins

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

Set margins for each side. This method supports chaining.

Parameters:

marginTop - Top margin.

marginRight - Right margin.

marginBottom - Bottom margin.

marginLeft - Left margin.

Returns:

This CStyle instance.

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.

setPaddingLeft

public CStyle setPaddingLeft(float value)

Set left padding (commonly in points). This method supports chaining.

Parameters:

value - Left padding value.

Returns:

This CStyle instance.

setPaddingRight

public CStyle setPaddingRight(float value)

Set right padding (commonly in points). This method supports chaining.

Parameters:

value - Right padding value.

Returns:

This CStyle instance.

setPaddingTop

public CStyle setPaddingTop(float value)

Set top padding (commonly in points). This method supports chaining.

Parameters:

value - Top padding value.

Returns:

This CStyle instance.

setPaddingBottom

public CStyle setPaddingBottom(float value)

Set bottom padding (commonly in points). This method supports chaining.

Parameters:

value - Bottom padding value.

Returns:

This CStyle instance.

setPadding

public CStyle setPadding(float commonPadding)

Set all paddings using the same value. This method supports chaining.

Parameters:

commonPadding - Padding applied to all sides.

Returns:

This CStyle instance.

setPaddings

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

Set paddings for each side. This method supports chaining.

Parameters:

paddingTop - Top padding.

paddingRight - Right padding.

paddingBottom - Bottom padding.

paddingLeft - Left padding.

Returns:

This CStyle instance.

setVerticalAlignment

public CStyle setVerticalAlignment(CVerticalAlignment verticalAlignment)

Set vertical alignment. This method supports chaining.

Parameters:

verticalAlignment - Vertical alignment enum.

Returns:

This CStyle instance.

setWidth

public CStyle setWidth(float width)

Set width in points. This method supports chaining.

Parameters:

width - Width value in points.

Returns:

This CStyle instance.

setWidth

public CStyle setWidth(CUnitValue width)

Set width using a unit value. This method supports chaining.

Parameters:

width - Width as CUnitValue.

Returns:

This CStyle instance.

getWidth

public CUnitValue getWidth()

Get width.

Returns:

Width as CUnitValue.

setHeight

public CStyle setHeight(float height)

Set height in points. This method supports chaining.

Parameters:

height - Height value in points.

Returns:

This CStyle instance.

setHeight

public CStyle setHeight(CUnitValue height)

Set height using a unit value. This method supports chaining.

Parameters:

height - Height as CUnitValue.

Returns:

This CStyle instance.

getHeight

public CUnitValue getHeight()

Get height.

Returns:

Height as CUnitValue.

setMaxHeight

public CStyle setMaxHeight(float maxHeight)

Set maximum height in points. This method supports chaining.

Parameters:

maxHeight - Maximum height value in points.

Returns:

This CStyle instance.

setMaxHeight

public CStyle setMaxHeight(CUnitValue maxHeight)

Set maximum height using a unit value. This method supports chaining.

Parameters:

maxHeight - Maximum height as CUnitValue.

Returns:

This CStyle instance.

setMinHeight

public CStyle setMinHeight(float minHeight)

Set minimum height in points. This method supports chaining.

Parameters:

minHeight - Minimum height value in points.

Returns:

This CStyle instance.

setMinHeight

public CStyle setMinHeight(CUnitValue minHeight)

Set minimum height using a unit value. This method supports chaining.

Parameters:

minHeight - Minimum height as CUnitValue.

Returns:

This CStyle instance.

setMaxWidth

public CStyle setMaxWidth(float maxWidth)

Set maximum width in points. This method supports chaining.

Parameters:

maxWidth - Maximum width value in points.

Returns:

This CStyle instance.

setMaxWidth

public CStyle setMaxWidth(CUnitValue maxWidth)

Set maximum width using a unit value. This method supports chaining.

Parameters:

maxWidth - Maximum width as CUnitValue.

Returns:

This CStyle instance.

setMinWidth

public CStyle setMinWidth(float minWidth)

Set minimum width in points. This method supports chaining.

Parameters:

minWidth - Minimum width value in points.

Returns:

This CStyle instance.

setMinWidth

public CStyle setMinWidth(CUnitValue minWidth)

Set minimum width using a unit value. This method supports chaining.

Parameters:

minWidth - Minimum width as CUnitValue.

Returns:

This CStyle instance.

getType

public CElementType getType()

Get element type for this style.

Returns:

Element type enum mapped from native type id.

isAbsolute

public boolean isAbsolute()

Check whether this style uses absolute positioning.

Returns:

true if absolute positioning is enabled, otherwise false.