Package com.itextpdf.layout.properties
Class BackgroundPosition
- java.lang.Object
-
- com.itextpdf.layout.properties.BackgroundPosition
-
public class BackgroundPosition extends java.lang.Object
Class to hold background-position property.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BackgroundPosition.PositionX
A specialized enum containing positions in x-dimension (horizontal positions).static class
BackgroundPosition.PositionY
A specialized enum containing positions in y-dimension (vertical positions).
-
Field Summary
Fields Modifier and Type Field Description private static double
EPS
private static int
FULL_VALUE
private static int
HALF_VALUE
private BackgroundPosition.PositionX
positionX
private BackgroundPosition.PositionY
positionY
private UnitValue
xShift
private UnitValue
yShift
-
Constructor Summary
Constructors Constructor Description BackgroundPosition()
Creates a newBackgroundPosition
instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
calculatePositionValues(float fullWidth, float fullHeight, UnitValue outXValue, UnitValue outYValue)
Converts all percentage and enum values to point equivalent.private static float
calculateValue(UnitValue value, float fullValue)
boolean
equals(java.lang.Object o)
BackgroundPosition.PositionX
getPositionX()
Gets horizontal position.BackgroundPosition.PositionY
getPositionY()
Gets vertical position.UnitValue
getXShift()
Gets horizontal shift.UnitValue
getYShift()
Gets vertical shift.int
hashCode()
private int
parsePositionXToUnitValueAndReturnMultiplier(UnitValue outValue)
Parses positionX toUnitValue
.private int
parsePositionYToUnitValueAndReturnMultiplier(UnitValue outValue)
Parses positionY toUnitValue
.BackgroundPosition
setPositionX(BackgroundPosition.PositionX xPosition)
Sets horizontal position.BackgroundPosition
setPositionY(BackgroundPosition.PositionY yPosition)
Sets vertical position.BackgroundPosition
setXShift(UnitValue xShift)
Sets horizontal shift.BackgroundPosition
setYShift(UnitValue yShift)
Sets vertical shift.
-
-
-
Field Detail
-
EPS
private static final double EPS
- See Also:
- Constant Field Values
-
FULL_VALUE
private static final int FULL_VALUE
- See Also:
- Constant Field Values
-
HALF_VALUE
private static final int HALF_VALUE
- See Also:
- Constant Field Values
-
positionX
private BackgroundPosition.PositionX positionX
-
positionY
private BackgroundPosition.PositionY positionY
-
xShift
private UnitValue xShift
-
yShift
private UnitValue yShift
-
-
Constructor Detail
-
BackgroundPosition
public BackgroundPosition()
Creates a newBackgroundPosition
instance. Fills it with default values.
-
-
Method Detail
-
calculatePositionValues
public void calculatePositionValues(float fullWidth, float fullHeight, UnitValue outXValue, UnitValue outYValue)
Converts all percentage and enum values to point equivalent.
-
getPositionX
public BackgroundPosition.PositionX getPositionX()
Gets horizontal position.- Returns:
- position in x-dimension
-
setPositionX
public BackgroundPosition setPositionX(BackgroundPosition.PositionX xPosition)
Sets horizontal position.- Parameters:
xPosition
- position in x-dimension- Returns:
BackgroundPosition
-
getPositionY
public BackgroundPosition.PositionY getPositionY()
Gets vertical position.- Returns:
- position in y-dimension
-
setPositionY
public BackgroundPosition setPositionY(BackgroundPosition.PositionY yPosition)
Sets vertical position.- Parameters:
yPosition
- position in y-dimension- Returns:
BackgroundPosition
-
getXShift
public UnitValue getXShift()
Gets horizontal shift.- Returns:
- shift in x-dimension from left
-
setXShift
public BackgroundPosition setXShift(UnitValue xShift)
Sets horizontal shift.- Parameters:
xShift
- shift in x-dimension from left- Returns:
BackgroundPosition
-
getYShift
public UnitValue getYShift()
Gets vertical shift.- Returns:
- shift in y-dimension from top
-
setYShift
public BackgroundPosition setYShift(UnitValue yShift)
Sets vertical shift.- Parameters:
yShift
- shift in y-dimension- Returns:
BackgroundPosition
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
- Returns:
- true if every field equals. False otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- object's hashCode.
-
parsePositionXToUnitValueAndReturnMultiplier
private int parsePositionXToUnitValueAndReturnMultiplier(UnitValue outValue)
Parses positionX toUnitValue
.- Parameters:
outValue
-UnitValue
in which positionX will be parsed- Returns:
- multiplier by which the xShift will be multiplied
-
parsePositionYToUnitValueAndReturnMultiplier
private int parsePositionYToUnitValueAndReturnMultiplier(UnitValue outValue)
Parses positionY toUnitValue
.- Parameters:
outValue
-UnitValue
in which positionY will be parsed- Returns:
- multiplier by which the yShift will be multiplied
-
calculateValue
private static float calculateValue(UnitValue value, float fullValue)
-
-