| Methods |
public
|
__construct(Frame $frame, Dompdf $dompdf)
Class constructor
Parameters
| $frame |
The decoration target
|
| $dompdf |
The Dompdf object
|
Overrides
Overriden by
|
#
|
public
|
dispose(bool $recursive = false)
"Destructor": forcibly free all references held by this object
"Destructor": forcibly free all references held by this object
Parameters
| $recursive |
if true, call dispose on all children
|
Overrides
|
#
|
public
|
copy(DOMNode $node): AbstractFrameDecorator
Return a copy of this frame with $node as its node
Return a copy of this frame with $node as its node
|
#
|
public
|
deep_copy(): AbstractFrameDecorator
Create a deep copy: copy this node and all children
Create a deep copy: copy this node and all children
|
#
|
public
|
create_anonymous_child(string $node_name, string $display): AbstractFrameDecorator
Create an anonymous child frame, inheriting styles from this frame.
Create an anonymous child frame, inheriting styles from this frame.
|
#
|
public
|
reset()
Re-initialize the frame
|
#
|
protected
|
reset_generated_content(): void
If this represents a generated node then child nodes represent generated
content. Remove the children since the content…
If this represents a generated node then child nodes represent generated
content. Remove the children since the content will be generated next
time this frame is reflowed.
|
#
|
protected
|
revert_counter_increment(): void
Decrement any counters that were incremented on the current node, unless
that node is the body.
Decrement any counters that were incremented on the current node, unless
that node is the body.
|
#
|
public
|
get_id()
|
#
|
public
|
get_frame(): Frame
|
#
|
public
|
get_node()
|
#
|
public
|
get_style()
|
#
|
public
|
get_original_style()
|
#
|
public
|
get_containing_block($i = null)
Containing block dimensions
Containing block dimensions
Parameters
| $i |
The key of the wanted containing block's dimension (x, y, w, h)
|
Overrides
|
#
|
public
|
get_position($i = null)
Block position
Parameters
| $i |
The key of the wanted position value (x, y)
|
Overrides
|
#
|
public
|
get_dompdf(): Dompdf
|
#
|
public
|
get_margin_width(): float
Return the width of the margin box of the frame, in pt. Meaningless
unless the width has been calculated properly.
Return the width of the margin box of the frame, in pt. Meaningless
unless the width has been calculated properly.
Overrides
Overriden by
|
#
|
public
|
get_margin_height(): float
Return the height of the margin box of the frame, in pt. Meaningless
unless the height has been calculated properly.
Return the height of the margin box of the frame, in pt. Meaningless
unless the height has been calculated properly.
Overrides
Overriden by
|
#
|
public
|
get_content_box(): array
Return the content box (x,y,w,h) of the frame.
Return the content box (x,y,w,h) of the frame.
Width and height might be reported as 0 if they have not been resolved
yet.
Overrides
|
#
|
public
|
get_padding_box(): array
Return the padding box (x,y,w,h) of the frame.
Return the padding box (x,y,w,h) of the frame.
Width and height might be reported as 0 if they have not been resolved
yet.
Overrides
|
#
|
public
|
get_border_box(): array
Return the border box of the frame.
Return the border box of the frame.
Width and height might be reported as 0 if they have not been resolved
yet.
Overrides
|
#
|
public
|
set_id($id)
|
#
|
public
|
set_style(Style $style): void
|
#
|
public
|
set_containing_block($x = null, $y = null, $w = null, $h = null)
|
#
|
public
|
set_position($x = null, $y = null)
|
#
|
public
|
is_auto_height()
Indicates if the margin height is auto sized
Indicates if the margin height is auto sized
Overrides
|
#
|
public
|
is_auto_width()
Indicates if the margin width is auto sized
Indicates if the margin width is auto sized
Overrides
|
#
|
public
|
__toString()
|
#
|
public
|
prepend_child(Frame $child, $update_node = true)
Inserts a new child at the beginning of the Frame
Inserts a new child at the beginning of the Frame
Parameters
| $child |
The new Frame to insert
|
| $update_node |
Whether or not to update the DOM
|
Overrides
|
#
|
public
|
append_child(Frame $child, $update_node = true)
Inserts a new child at the end of the Frame
Inserts a new child at the end of the Frame
Parameters
| $child |
The new Frame to insert
|
| $update_node |
Whether or not to update the DOM
|
Overrides
|
#
|
public
|
insert_child_before(Frame $new_child, Frame $ref, $update_node = true)
Inserts a new child immediately before the specified frame
Inserts a new child immediately before the specified frame
Parameters
| $new_child |
The new Frame to insert
|
| $ref |
The Frame after the new Frame
|
| $update_node |
Whether or not to update the DOM
|
Overrides
|
#
|
public
|
insert_child_after(Frame $new_child, Frame $ref, $update_node = true)
Inserts a new child immediately after the specified frame
Inserts a new child immediately after the specified frame
Parameters
| $new_child |
The new Frame to insert
|
| $ref |
The Frame before the new Frame
|
| $update_node |
Whether or not to update the DOM
|
Overrides
|
#
|
public
|
remove_child(Frame $child, $update_node = true)
Remove a child frame
Parameters
| $update_node |
Whether or not to remove the DOM node
|
Returns
Overrides
|
#
|
public
|
get_parent(bool $use_cache = true): AbstractFrameDecorator
|
#
|
public
|
get_first_child(): AbstractFrameDecorator
|
#
|
public
|
get_last_child(): AbstractFrameDecorator
|
#
|
public
|
get_prev_sibling(): AbstractFrameDecorator
|
#
|
public
|
get_next_sibling(): AbstractFrameDecorator
|
#
|
public
|
get_children(): FrameListIterator<AbstractFrameDecorator>
|
#
|
public
|
get_subtree(): FrameTreeIterator<AbstractFrameDecorator>
|
#
|
public
|
set_positioner(AbstractPositioner $posn)
|
#
|
public
|
set_reflower(AbstractFrameReflower $reflower)
|
#
|
public
|
get_positioner(): AbstractPositioner
|
#
|
public
|
get_reflower(): AbstractFrameReflower
|
#
|
public
|
set_root(Frame $root)
|
#
|
public
|
get_root(): Page
|
#
|
public
|
find_block_parent(): Block
|
#
|
public
|
find_positioned_parent(): AbstractFrameDecorator
|
#
|
public
|
split(Frame|null $child = null, bool $page_break = false, bool $forced = false): void
Split this frame at $child.
The current frame is cloned and $child and all children following
$child are added to the…
Split this frame at $child.
The current frame is cloned and $child and all children following
$child are added to the clone. The clone is then passed to the
current frame's parent->split() method.
Parameters
| $forced |
Whether the page break is forced.
|
Throws
Overriden by
|
#
|
public
|
reset_counters(array $counters): void
|
#
|
public
|
reset_counter(string $id = self::DEFAULT_COUNTER, int $value = 0): void
|
#
|
public
|
decrement_counters(array $counters): void
|
#
|
public
|
increment_counters(array $counters): void
|
#
|
public
|
increment_counter(string $id = self::DEFAULT_COUNTER, int $increment = 1): void
|
#
|
public
|
lookup_counter_frame(string $id = self::DEFAULT_COUNTER): AbstractFrameDecorator|null
|
#
|
public
|
counter_value(string $id = self::DEFAULT_COUNTER, string $type = "decimal"): bool|string
|
#
|
final
public
|
position()
|
#
|
final
public
|
move(float $offset_x, float $offset_y, bool $ignore_self = false): void
|
#
|
final
public
|
reflow(Block|null $block = null)
|
#
|
final
public
|
get_min_max_width(): array
|
#
|