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