Class: AlphaTreeGraph

Source Location: /util/graphs/AlphaTreeGraph.inc

Class AlphaTreeGraph

Class Overview

Maintains the geometry for a tree graph

Located in /util/graphs/AlphaTreeGraph.inc [line 50]

Author(s):

John Collins <dev@alphaframework.org>

Information Tags:

Version:	$Id: AlphaTreeGraph.inc 1341 2011-03-17 15:02:02Z johnc $
Copyright:	Copyright (c) 2011, John Collins (founder of Alpha Framework). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Alpha Framework nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Since:	1.0
License:	The BSD License

Methods

[ Top ]

Method Summary

AlphaTreeGraph	__construct()	Constructor
void	add()	Add a new node to the graph
void	getHeight()	Get the heith of the graph, will invoke render() if not already rendered
void	getWidth()	Get the width of the graph, will invoke render() if not already rendered
boolean	hasNext()	Check to see if another AlphaGraphNode instance in the graph is available
AlphaGraphNode	next()	Get the next AlphaGraphNode instance in the graph, will invoke render() if not already rendered
void	render()	Render the chart in memory

[ Top ]

Methods

Constructor __construct [line 147]

AlphaTreeGraph __construct(
[integer
$rowSpace = 40], [integer
$colSpace = 40], [integer
$branchSpace = 80] 
)

Constructor

Parameters:

integer	$rowSpace:
integer	$colSpace:
integer	$branchSpace:

API Tags:

Access:

public

Information Tags:

Since:

1.0

[ Top ]

add [line 169]

void add(
integer
$id, integer
$pid, [string
$message = ''], [integer
$w = 0], [integer
$h = 0], string
$nodeColour, string
$URL 
)

Add a new node to the graph

Parameters:

integer	$id:
integer	$pid:
string	$message:
integer	$w:
integer	$h:
string	$nodeColour:
string	$URL:

API Tags:

Access:

public

Information Tags:

Since:

1.0

[ Top ]

getHeight [line 404]

void getHeight(
)

Get the heith of the graph, will invoke render() if not already rendered

API Tags:

Access:

public

Information Tags:

Since:

1.0

[ Top ]

getWidth [line 392]

void getWidth(
)

Get the width of the graph, will invoke render() if not already rendered

API Tags:

Access:

public

Information Tags:

Since:

1.0

[ Top ]

hasNext [line 436]

boolean hasNext(
)

Check to see if another AlphaGraphNode instance in the graph is available

API Tags:

Access:

public

Information Tags:

Since:

1.0

[ Top ]

next [line 417]

AlphaGraphNode next(
)

Get the next AlphaGraphNode instance in the graph, will invoke render() if not already rendered

API Tags:

Access:

public

Information Tags:

Since:

1.0

[ Top ]

render [line 376]

void render(
)

Render the chart in memory

API Tags:

Access:

protected

Information Tags:

Since:

1.0

[ Top ]

Documentation generated on Thu, 17 Mar 2011 16:43:40 +0000 by phpDocumentor 1.4.3

	alpha--util--graphs

[ class tree: alpha--util--graphs ] [ index: alpha--util--graphs ] [ all elements ]