Dompdf\FrameDecorator\ListBullet
Decorates frames for list bullet rendering
Synopsis
class ListBullet
extends AbstractFrameDecorator
{
- // constants
- const BULLET_PADDING = 1;
- const BULLET_THICKNESS = 0.04;
- const BULLET_DESCENT = 0.3;
- const BULLET_SIZE = 0.35;
- // Inherited constants from AbstractFrameDecorator
- const DEFAULT_COUNTER = "-dompdf-default-counter";
- // members
- public static array $BULLET_TYPES = ;
- // Inherited members from AbstractFrameDecorator
- public array $_counters;
- protected Frame $_root;
- protected Frame $_frame;
- protected AbstractPositioner $_positioner;
- protected AbstractFrameReflower $_reflower;
- protected Dompdf $_dompdf;
- // Inherited members from Frame
- protected DOMText $_node;
- protected $_id;
- public static integer $ID_COUNTER;
- protected Style $_style;
- protected Style $_original_style;
- protected Frame $_parent;
- protected $_frame_list;
- protected Frame $_first_child;
- protected Frame $_last_child;
- protected Frame $_prev_sibling;
- protected Frame $_next_sibling;
- protected $_containing_block;
- protected $_position;
- protected $_opacity;
- protected AbstractFrameDecorator $_decorator;
- protected LineBox $_containing_line;
- protected array $_is_cache;
- public bool $_already_pushed;
- public bool $_float_next_line;
- public bool $_splitted;
- public static int $_ws_state;
- // methods
- public void __construct()
- public float|int get_margin_width()
- public float|int get_margin_height()
- public float|int get_width()
- public float|int get_height()
- // Inherited methods from AbstractFrameDecorator
- public void __construct()
- public void dispose()
- public Frame copy()
- public Frame deep_copy()
- public void reset()
- public string get_id()
- public Frame get_frame()
- public DOMElement|DOMText get_node()
- public Style get_style()
- public Style get_original_style()
- public array|float get_containing_block()
- public array|float get_position()
- public Dompdf get_dompdf()
- public float get_margin_height()
- public float get_margin_width()
- public array get_content_box()
- public array get_padding_box()
- public array get_border_box()
- public void set_id()
- public void set_style()
- public void set_containing_block()
- public void set_position()
- public bool is_auto_height()
- public bool is_auto_width()
- public string __toString()
- public void prepend_child()
- public void append_child()
- public void insert_child_before()
- public void insert_child_after()
- public Frame remove_child()
- public AbstractFrameDecorator get_parent()
- public AbstractFrameDecorator get_first_child()
- public AbstractFrameDecorator get_last_child()
- public AbstractFrameDecorator get_prev_sibling()
- public AbstractFrameDecorator get_next_sibling()
- public FrameTreeList get_subtree()
- public void set_positioner()
- public void set_reflower()
- public AbstractFrameReflower get_reflower()
- public void set_root()
- public Page get_root()
- public Block find_block_parent()
- public AbstractFrameDecorator find_positionned_parent()
- public void split()
- public void reset_counter()
- public void decrement_counters()
- public void increment_counters()
- public void increment_counter()
- public AbstractFrameDecorator|null lookup_counter_frame()
- public bool|string counter_value()
- public final void position()
- public final void move()
- public final void reflow()
- public final array get_min_max_width()
- public final float calculate_auto_width()
- // Inherited methods from Frame
- public void __construct()
- protected void ws_trim()
- protected bool ws_keep()
- protected bool ws_is_text()
- public void dispose()
- public void reset()
- public DOMText get_node()
- public string get_id()
- public Style get_style()
- public Style get_original_style()
- public Frame get_parent()
- public AbstractFrameDecorator get_decorator()
- public Frame get_first_child()
- public Frame get_last_child()
- public Frame get_prev_sibling()
- public Frame get_next_sibling()
- public array get_children()
- public array get_containing_block()
- public array|float get_position()
- public float get_margin_height()
- public float get_margin_width()
- public float get_break_margins()
- public array get_content_box()
- public array get_padding_box()
- public array get_border_box()
- public float get_opacity()
- public LineBox get_containing_line()
- public void set_id()
- public void set_style()
- public void set_decorator()
- public void set_containing_block()
- public void set_position()
- public void set_opacity()
- public void set_containing_line()
- public bool is_auto_height()
- public bool is_auto_width()
- public bool is_text_node()
- public bool is_positionned()
- public bool is_absolute()
- public bool is_block()
- public bool is_inline_block()
- public bool is_in_flow()
- public bool is_pre()
- public bool is_table()
- public void prepend_child()
- public void append_child()
- public void insert_child_before()
- public void insert_child_after()
- public Frame remove_child()
- public string __toString()
Hierarchy
Constants
Name | Value |
---|---|
BULLET_PADDING | 1 |
BULLET_THICKNESS | 0.04 |
BULLET_DESCENT | 0.3 |
BULLET_SIZE | 0.35 |
DEFAULT_COUNTER | "-dompdf-default-counter" |
WS_TEXT | 1 |
WS_SPACE | 2 |
Members
protected
- $_containing_block
—
array
This frame's containing block (used in layout): array(x, y, w, h) - $_containing_line
—
Dompdf\LineBox
This frame's containing line box - $_decorator
—
\Dompdf\FrameDecorator\AbstractFrameDecorator
This frame's decorator - $_dompdf
—
Dompdf\Dompdf
Reference to the current dompdf instance - $_first_child
—
Dompdf\Frame
This frame's first child. All children are handled as a doubly-linked list. - $_frame
—
Dompdf\Frame
The decorated frame - $_frame_list
—
array
This frame's children - $_id
—
string
Unique identifier for this frame. Used to reference this frame via the node. - $_is_cache — array
- $_last_child
—
Dompdf\Frame
This frame's last child. - $_next_sibling
—
Dompdf\Frame
This frame's next sibling in the document tree. - $_node
—
\DOMElement|\DOMText
The DOMElement or DOMText object this frame represents - $_opacity
—
float
Absolute opacity of this frame - $_original_style
—
Dompdf\Css\Style
This frame's original style. Needed for cases where frames are split across pages. - $_parent
—
Dompdf\Frame
This frame's parent in the document tree. - $_position
—
array
Position on the page of the top-left corner of the margin box of this frame: array(x,y) - $_positioner
—
Dompdf\Positioner\AbstractPositioner
AbstractPositioner object used to position this frame (Strategy pattern) - $_prev_sibling
—
Dompdf\Frame
This frame's previous sibling in the document tree. - $_reflower
—
\Dompdf\FrameReflower\AbstractFrameReflower
Reflower object used to calculate frame dimensions (Strategy pattern) - $_root
—
Dompdf\Frame
The root node of the DOM tree - $_style
—
Dompdf\Css\Style
This frame's calculated style
public
- $BULLET_TYPES
-
$ID_COUNTER
Unique id counter - $_already_pushed
—
Dompdf\bool
Tells wether the frame was already pushed to the next page - $_counters
- $_float_next_line — Dompdf\bool
- $_splitted
—
Dompdf\bool
Tells wether the frame was split - $_ws_state — int
Methods
public
- __construct() — ListBullet constructor.
- get_height()
- get_margin_height() — hits only on "inset" lists items, to increase height of box
- get_margin_width()
- get_width()
Inherited from Dompdf\FrameDecorator\AbstractFrameDecorator
public
- __toString()
- append_child()
- calculate_auto_width() — Determine current frame width based on contents
- copy() — Return a copy of this frame with $node as its node
- counter_value()
- decrement_counters()
- deep_copy() — Create a deep copy: copy this node and all children
- dispose() — "Destructor": foribly free all references held by this object
- find_block_parent()
- find_positionned_parent()
- get_border_box()
- get_containing_block()
- get_content_box()
- get_dompdf()
- get_first_child()
- get_frame()
- get_id()
- get_last_child()
- get_margin_height()
- get_margin_width()
- get_min_max_width()
- get_next_sibling()
- get_node()
- get_original_style()
- get_padding_box()
- get_parent()
- get_position()
- get_prev_sibling()
- get_reflower()
- get_root()
- get_style()
- get_subtree()
- increment_counter()
- increment_counters()
- insert_child_after()
- insert_child_before()
- is_auto_height()
- is_auto_width()
- lookup_counter_frame()
- move()
- position()
- prepend_child()
- reflow()
- remove_child()
- reset() — Delegate calls to decorated frame object
- reset_counter()
- set_containing_block()
- set_id()
- set_position()
- set_positioner()
- set_reflower()
- set_root()
- set_style()
- split() — split this frame at $child.
Inherited from Dompdf\Frame
protected
- ws_is_text()
- ws_keep()
- ws_trim() — WIP : preprocessing to remove all the unused whitespace
public
- __toString()
- append_child() — Inserts a new child at the end of the Frame
- dispose() — "Destructor": forcibly free all references held by this frame
- get_border_box() — Return the border box of the frame
- get_break_margins()
- get_children()
- get_containing_block() — Containing block dimensions
- get_containing_line()
- get_content_box() — Return the content box (x,y,w,h) of the frame
- get_decorator()
- get_first_child()
- get_id()
- get_last_child()
- get_margin_height() — Return the height of the margin box of the frame, in pt. Meaningless unless the height has been calculated properly.
- get_margin_width() — Return the width of the margin box of the frame, in pt. Meaningless unless the width has been calculated properly.
- get_next_sibling()
- get_node()
- get_opacity()
- get_original_style()
- get_padding_box() — Return the padding box (x,y,w,h) of the frame
- get_parent()
- get_position() — Block position
- get_prev_sibling()
- get_style()
- insert_child_after() — Inserts a new child immediately after the specified frame
- insert_child_before() — Inserts a new child immediately before the specified frame
- is_absolute()
- is_auto_height() — Indicates if the margin height is auto sized
- is_auto_width() — Indicates if the margin width is auto sized
- is_block()
- is_in_flow()
- is_inline_block()
- is_positionned()
- is_pre()
- is_table()
- is_text_node() — Tells if the frame is a text node
- prepend_child() — Inserts a new child at the beginning of the Frame
- remove_child() — Remove a child frame
- reset() — Re-initialize the frame
- set_containing_block()
- set_containing_line()
- set_decorator()
- set_id()
- set_opacity()
- set_position()
- set_style()