Docs For Class Frame

Description

The main Frame class

This class represents a single HTML element. This class stores positioning information as well as containing block location and dimensions. Style information for the element is stored in a Style object. Tree structure is maintained via the parent & children links.

access: protected

Located in /include/frame.cls.php (line 54)

Variable Summary

mixed $_containing_block

mixed $_decorator

mixed $_first_child

mixed $_id

mixed $_last_child

mixed $_next_sibling

mixed $_node

mixed $_original_style

mixed $_parent

mixed $_position

mixed $_prev_sibling

mixed $_style

Method Summary

Frame __construct (DomNode $node)

void append_child (Frame $child, [mixed $update_node = true])

void get_border_box ()

void get_children ()

void get_containing_block ([mixed $i = null])

void get_decorator ()

void get_first_child ()

void get_id ()

void get_last_child ()

void get_margin_height ()

void get_margin_width ()

void get_next_sibling ()

void get_node ()

void get_original_style ()

void get_padding_box ()

void get_parent ()

void get_position ([mixed $i = null])

void get_prev_sibling ()

void get_style ()

void insert_child_after (Frame $new_child, Frame $ref, [mixed $update_node = true])

void insert_child_before (Frame $new_child, Frame $ref, [mixed $update_node = true])

void prepend_child (Frame $child, [mixed $update_node = true])

void remove_child (Frame $child, [mixed $update_node = true])

void reset ()

void set_containing_block ([mixed $x = null], [mixed $y = null], [mixed $w = null], [mixed $h = null])

void set_decorator (Frame_Decorator $decorator)

void set_id (mixed $id)

void set_position ([mixed $x = null], [mixed $y = null])

void set_style (Style $style)

void __toString ()

Variables

mixed $_containing_block (line 70)

access: protected

mixed $_decorator (line 76)

access: protected

mixed $_first_child (line 63)

access: protected

mixed $_id (line 58)

access: protected

mixed $_last_child (line 64)

access: protected

mixed $_next_sibling (line 67)

access: protected

mixed $_node (line 57)

access: protected

mixed $_original_style (line 60)

access: protected

mixed $_parent (line 62)

access: protected

mixed $_position (line 72)

access: protected

mixed $_prev_sibling (line 66)

access: protected

mixed $_style (line 59)

access: protected

Methods

Constructor __construct (line 80)

Frame __construct (DomNode $node)

append_child (line 327)

void append_child (Frame $child, [mixed $update_node = true])

get_border_box (line 206)

void get_border_box ()

get_children (line 132)

void get_children ()

get_containing_block (line 135)

void get_containing_block ([mixed $i = null])

get_decorator (line 125)

void get_decorator ()

get_first_child (line 127)

void get_first_child ()

get_id (line 122)

void get_id ()

get_last_child (line 128)

void get_last_child ()

get_margin_height (line 154)

void get_margin_height ()

get_margin_width (line 167)

void get_margin_width ()

get_next_sibling (line 130)

void get_next_sibling ()

get_node (line 121)

void get_node ()

get_original_style (line 124)

void get_original_style ()

get_padding_box (line 179)

void get_padding_box ()

get_parent (line 126)

void get_parent ()

get_position (line 141)

void get_position ([mixed $i = null])

get_prev_sibling (line 129)

void get_prev_sibling ()

get_style (line 123)

void get_style ()

insert_child_after (line 389)

void insert_child_after (Frame $new_child, Frame $ref, [mixed $update_node = true])

insert_child_before (line 355)

void insert_child_before (Frame $new_child, Frame $ref, [mixed $update_node = true])

prepend_child (line 300)

void prepend_child (Frame $child, [mixed $update_node = true])

remove_child (line 429)

void remove_child (Frame $child, [mixed $update_node = true])

reset (line 105)

void reset ()

set_containing_block (line 257)

void set_containing_block ([mixed $x = null], [mixed $y = null], [mixed $w = null], [mixed $h = null])

set_decorator (line 255)

void set_decorator (Frame_Decorator $decorator)

set_id (line 238)

void set_id (mixed $id)

set_position (line 283)

void set_position ([mixed $x = null], [mixed $y = null])

set_style (line 248)

void set_style (Style $style)

__toString (line 459)

void __toString ()