| Methods |
public
|
__construct(DOMNode $node)
Class constructor
Parameters
| $node |
the DOMNode this frame represents
|
Overriden by
|
#
|
protected
|
ws_trim()
WIP : preprocessing to remove all the unused whitespace
WIP : preprocessing to remove all the unused whitespace
|
#
|
protected
|
ws_keep(): bool
|
#
|
protected
|
ws_is_text(): bool
|
#
|
public
|
dispose(bool $recursive = false)
"Destructor": forcibly free all references held by this frame
"Destructor": forcibly free all references held by this frame
Parameters
| $recursive |
if true, call dispose on all children
|
Overriden by
|
#
|
public
|
reset()
Re-initialize the frame
|
#
|
public
|
get_node(): DOMElement|DOMText
|
#
|
public
|
get_id(): int
|
#
|
public
|
get_style(): Style
|
#
|
public
|
get_original_style(): Style
|
#
|
public
|
get_parent(): Frame
|
#
|
public
|
get_decorator(): AbstractFrameDecorator
|
#
|
public
|
get_first_child(): Frame
|
#
|
public
|
get_last_child(): Frame
|
#
|
public
|
get_prev_sibling(): Frame
|
#
|
public
|
get_next_sibling(): Frame
|
#
|
public
|
get_children(): FrameListIterator
|
#
|
public
|
get_containing_block(string|null $i = null): float[]|float
Containing block dimensions
Containing block dimensions
Parameters
| $i |
The key of the wanted containing block's dimension (x, y, w, h)
|
Overriden by
|
#
|
public
|
get_position(string|null $i = null): float[]|float
Block position
Parameters
| $i |
The key of the wanted position value (x, y)
|
Overriden by
|
#
|
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.
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.
Overriden by
|
#
|
public
|
get_content_box(): float[]
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.
Overriden by
|
#
|
public
|
get_padding_box(): float[]
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.
Overriden by
|
#
|
public
|
get_border_box(): float[]
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.
Overriden by
|
#
|
public
|
get_opacity(float|null $opacity = null): float
|
#
|
public
&
|
get_containing_line(): LineBox|null
|
#
|
public
|
set_id(int $id)
|
#
|
public
|
set_style(Style $style): void
|
#
|
public
|
set_decorator(AbstractFrameDecorator $decorator)
|
#
|
public
|
set_containing_block(float|float[]|null $x = null, float|null $y = null, float|null $w = null, float|null $h = null)
|
#
|
public
|
set_position(float|float[]|null $x = null, float|null $y = null)
|
#
|
public
|
set_opacity(float $opacity): void
|
#
|
public
|
set_containing_line(LineBox $line)
|
#
|
public
|
is_auto_height(): bool
Indicates if the margin height is auto sized
Indicates if the margin height is auto sized
Overriden by
|
#
|
public
|
is_auto_width(): bool
Indicates if the margin width is auto sized
Indicates if the margin width is auto sized
Overriden by
|
#
|
public
|
is_text_node(): bool
Tells if the frame is a text node
Tells if the frame is a text node
|
#
|
public
|
is_positioned(): bool
|
#
|
public
|
is_absolute(): bool
|
#
|
public
|
is_block(): bool
Whether the frame is a block container.
Whether the frame is a block container.
|
#
|
public
|
is_block_level(): bool
Whether the frame has a block-level display type.
Whether the frame has a block-level display type.
|
#
|
public
|
is_inline_level(): bool
Whether the frame has an inline-level display type.
Whether the frame has an inline-level display type.
|
#
|
public
|
is_in_flow(): bool
|
#
|
public
|
is_pre(): bool
|
#
|
public
|
is_table(): bool
|
#
|
public
|
prepend_child(Frame $child, bool $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
|
Overriden by
|
#
|
public
|
append_child(Frame $child, bool $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
|
Overriden by
|
#
|
public
|
insert_child_before(Frame $new_child, Frame $ref, bool $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
|
Throws
Overriden by
|
#
|
public
|
insert_child_after(Frame $new_child, Frame $ref, bool $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
|
Throws
Overriden by
|
#
|
public
|
remove_child(Frame $child, bool $update_node = true): Frame
Remove a child frame
Parameters
| $update_node |
Whether or not to remove the DOM node
|
Returns
Throws
Overriden by
|
#
|
public
|
__toString(): string
|
#
|