com.itextpdf.layout.properties

Class BackgroundSize

java.lang.Object

com.itextpdf.layout.properties.BackgroundSize

public class BackgroundSize
extends Object

Class to hold background-size property.

Constructor Summary

Constructors

Constructor and Description
BackgroundSize() Creates a new BackgroundSize instance.

Method Summary

Modifier and Type	Method and Description
UnitValue	getBackgroundHeightSize() Gets the background height property of the image.
UnitValue	getBackgroundWidthSize() Gets the background width property of the image.
boolean	isContain() Returns value of the "contain" property.
boolean	isCover() Returns value of the "cover" property.
boolean	isSpecificSize() Returns is size has specific property.
void	setBackgroundSizeToContain() Clears all size values and sets the "contain" property true.
void	setBackgroundSizeToCover() Clears all size values and sets the "cover" property true.
void	setBackgroundSizeToValues(UnitValue width, UnitValue height) Clears all current properties and sets new width and height values.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundSize

public BackgroundSize()

Creates a new BackgroundSize instance. The "cover" and "contain" properties are not set.

Method Detail

setBackgroundSizeToValues

public void setBackgroundSizeToValues(UnitValue width,
                                      UnitValue height)

Clears all current properties and sets new width and height values. One of the parameters can be null. Note that in this case null property will be scaled so that it becomes proportionally equal with the non-null value. If both parameters are set to null, then the default image size will be used.

Parameters:

width - a UnitValue object

height - a UnitValue object

setBackgroundSizeToContain

public void setBackgroundSizeToContain()

Clears all size values and sets the "contain" property true.

See Also:

contain

setBackgroundSizeToCover

public void setBackgroundSizeToCover()

Clears all size values and sets the "cover" property true.

See Also:

cover

getBackgroundWidthSize

public UnitValue getBackgroundWidthSize()

Gets the background width property of the image.

Returns:

the UnitValue width for this image.

See Also:

backgroundWidthSize

getBackgroundHeightSize

public UnitValue getBackgroundHeightSize()

Gets the background height property of the image.

Returns:

the UnitValue height for this image.

See Also:

backgroundHeightSize

isSpecificSize

public boolean isSpecificSize()

Returns is size has specific property.

Returns:

true if size set to "contain" or "cover", otherwise false.

isContain

public boolean isContain()

Returns value of the "contain" property.

Returns:

true if property "contain" is set to the size, otherwise false.

See Also:

contain

isCover

public boolean isCover()

Returns value of the "cover" property.

Returns:

true if property "cover" is set to the size, otherwise false.

See Also:

cover