interface AlignableHeaderFooterInterface in Entity Print 8.2
An interface for print engines that support a header and footer.
Hierarchy
- interface \Drupal\entity_print\Plugin\EntityPrint\PrintEngine\AlignableHeaderFooterInterface
Expanded class hierarchy of AlignableHeaderFooterInterface
All classes that implement AlignableHeaderFooterInterface
File
- src/
Plugin/ EntityPrint/ PrintEngine/ AlignableHeaderFooterInterface.php, line 8
Namespace
Drupal\entity_print\Plugin\EntityPrint\PrintEngineView source
interface AlignableHeaderFooterInterface {
/**
* Align the text to the left.
*/
const ALIGN_LEFT = 'left';
/**
* Align the text to the right.
*/
const ALIGN_RIGHT = 'right';
/**
* Align the text in the center.
*/
const ALIGN_CENTER = 'center';
/**
* Sets the header text.
*
* @param string $text
* The plain text to add to the header.
* @param string $alignment
* One of the align constants.
*
* @return $this
* The pdf engine.
*/
public function setHeaderText($text, $alignment);
/**
* Sets the footer text.
*
* @param string $text
* The plain text to add to the footer.
* @param string $alignment
* One of the align constants.
*
* @return $this
* The pdf engine.
*/
public function setFooterText($text, $alignment);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AlignableHeaderFooterInterface:: |
constant | Align the text in the center. | ||
AlignableHeaderFooterInterface:: |
constant | Align the text to the left. | ||
AlignableHeaderFooterInterface:: |
constant | Align the text to the right. | ||
AlignableHeaderFooterInterface:: |
public | function | Sets the footer text. | 1 |
AlignableHeaderFooterInterface:: |
public | function | Sets the header text. | 1 |