\src\Utils\Graphics2D\Shapes\Styles\TextStyle.inc
inherited
Classes
\Utils\Graphics2D\Shapes\Styles\TextStyle
This class implements a style for texts.
- Implements
- \Utils\Graphics2D\Shapes\Styles\IStyle
Constants
LINE_PADDING
= 3constant additional padding for calculating the line height with a given font size (always plus 3)
Properties
string
$family= ''Times''
the name of the font family
'Times'Details- Type
- string
int
$size= ''12''
the font size in pixel
'12'Details- Type
- int
Methods
__construct(
string $family
=
'Times', int $size
=
12, \Utils\Color\Color $color
=
null
)
:
voidThis acts as the constructor of the class.
| Name | Type | Description |
|---|---|---|
| $family | string | the name of the font family |
| $size | int | the font size in pixel |
| $color | \Utils\Color\Color | the font color |
__get(
string $memberName
)
:
mixedThis method is a magic getter method for the class.
| Name | Type | Description |
|---|---|---|
| $memberName | string | the name of the member to get |
| Type | Description |
|---|---|
| mixed | the value of the member |
- Todo
- replace this with Trait in PHP 5.4
__set(
string $memberName, mixed $value
)
:
voidThis method is a magic setter method for the class.
| Name | Type | Description |
|---|---|---|
| $memberName | string | the name of the member to get |
| $value | mixed | the new value of the member |
- Todo
- replace this with Trait in PHP 5.4
__toString(
)
:
stringThis method returns a string representation of the text style.
| Type | Description |
|---|---|
| string |
getHash(
)
:
stringThis method returns a "hash" of this TextStyle.
| Type | Description |
|---|---|
| string | a "hash" of this TextStyle, consisting of the concatination of the fontFamily and size members of this TextStyle |
getLineHeight(
)
:
intThis method returns the line height for this TextStyle.
| Type | Description |
|---|---|
| int | the line height for this TextStyle in pixels |
pixelToPoint(
int $pixel
)
:
floatThis method converts from pixel to points unit.
| Name | Type | Description |
|---|---|---|
| $pixel | int | the value in pixels |
| Type | Description |
|---|---|
| float | the value in points |
toCssClass(
string $className
)
:
stringThis method converts this TextStyle into a CSS class definition, with the given class name.
| Name | Type | Description |
|---|---|---|
| $className | string | the class name of the CSS class definition |
| Type | Description |
|---|---|
| string | a CSS class definition with the given class name of this TextStlye |