Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2declare(strict_types=1);
3/**
4 * Pop PHP Framework (https://www.popphp.org/)
5 *
6 * @link       https://github.com/popphp/popphp-framework
7 * @author     Nick Sagona, III <nick@popphp.org>
8 * @copyright  Copyright (c) 2009-2026 Nick Sagona, III
9 * @license    https://www.popphp.org/license     New BSD License
10 */
11
12/**
13 * @namespace
14 */
15namespace Pop\Pdf\Document\Page\Text;
16
17/**
18 * Pdf page text alignment interface
19 *
20 * @category   Pop
21 * @package    Pop\Pdf
22 * @author     Nick Sagona, III <nick@popphp.org>
23 * @copyright  Copyright (c) 2009-2026 Nick Sagona, III
24 * @license    https://www.popphp.org/license     New BSD License
25 * @version    6.0.0
26 */
27interface AlignmentInterface
28{
29
30    /**
31     * Set alignment
32     *
33     * @param  string $alignment
34     * @return AlignmentInterface
35     */
36    public function setAlignment(string $alignment): AlignmentInterface;
37
38    /**
39     * Set the left X boundary
40     *
41     * @param  int $x
42     * @return AlignmentInterface
43     */
44    public function setLeftX(int $x): AlignmentInterface;
45
46    /**
47     * Set the right X boundary
48     *
49     * @param  int $x
50     * @return AlignmentInterface
51     */
52    public function setRightX(int $x): AlignmentInterface;
53
54    /**
55     * Set the leading
56     *
57     * @param  int $leading
58     * @return AlignmentInterface
59     */
60    public function setLeading(int $leading): AlignmentInterface;
61
62    /**
63     * Get character wrap boundary
64     *
65     * @return string
66     */
67    public function getAlignment(): string;
68
69    /**
70     * Get left X
71     *
72     * @return int
73     */
74    public function getLeftX(): int;
75
76    /**
77     * Get left X
78     *
79     * @return int
80     */
81    public function getRightX(): int;
82
83    /**
84     * Get the leading
85     *
86     * @return int
87     */
88    public function getLeading(): int;
89
90    /**
91     * Has left X
92     *
93     * @return bool
94     */
95    public function hasLeftX(): bool;
96
97    /**
98     * Has right X
99     *
100     * @return bool
101     */
102    public function hasRightX(): bool;
103
104    /**
105     * Has leading
106     *
107     * @return bool
108     */
109    public function hasLeading(): bool;
110
111    /**
112     * Is LEFT alignment
113     *
114     * @return bool
115     */
116    public function isLeft(): bool;
117
118    /**
119     * Is RIGHT alignment
120     *
121     * @return bool
122     */
123    public function isRight(): bool;
124
125}