Docs For Class Frame

Description

Represents an entire document as a tree of frames

The Frame_Tree consists of Frame objects each tied to specific DomNode objects in a specific DomDocument. The Frame_Tree has the same structure as the DomDocument, but adds additional capabalities for styling and layout.

access: protected

Located in /include/frame_tree.cls.php (line 53)

Variable Summary

DomDocument $_dom

array $_HIDDEN_TAGS

array $_registry

Frame $_root

Method Summary

Frame_Tree __construct (DomDocument $dom)

void build_tree ()

DomDocument get_dom ()

Frame get_frame (string $id)

FrameTreeList get_frames ()

Frame get_root ()

Frame _build_tree_r (DomNode $node)

Variables

DomDocument $_dom (line 69)

The main DomDocument

access: protected
see: http://ca2.php.net/manual/en/ref.dom.php

array $_HIDDEN_TAGS = array("area", "base", "basefont", "head",
"meta", "style", "title",
"noembed", "noscript", "param", "#comment") (line 60)

Tags to ignore while parsing the tree

access: protected
static:

array $_registry (line 83)

A mapping of Frame objects to DomNode objects

access: protected

Frame $_root (line 76)

The root node of the FrameTree.

access: protected

Methods

Constructor __construct (line 91)

Class constructor

Frame_Tree __construct (DomDocument $dom)

DomDocument $dom: the main DomDocument object representing the current html document

build_tree (line 129)

Builds the tree

void build_tree ()

get_dom (line 102)

Returns the DomDocument object representing the curent html document

DomDocument get_dom ()

get_frame (line 117)

Returns a specific frame given its id

Frame get_frame (string $id)

string $id

get_frames (line 124)

Returns a post-order iterator for all frames in the tree

FrameTreeList get_frames ()

get_root (line 109)

Returns the root frame of the tree

Frame get_root ()

_build_tree_r (line 151)

Recursively adds Frame objects to the tree

Recursively build a tree of Frame objects based on a dom tree. No layout information is calculated at this time, although the tree may be adjusted (i.e. nodes and frames for generated content and images may be created).

access: protected

Frame _build_tree_r (DomNode $node)

DomNode $node: the current DomNode being considered

Class Frame_Tree