linea21-externals
[ class tree: linea21-externals ] [ index: linea21-externals ] [ all elements ]

Class: awLegend

Source Location: /class/system/artichow/php4/inc/Legend.class.php

Class Overview


Some legends


Variables

Methods



Class Details

[line 37]
Some legends



[ Top ]


Class Variables

$background =

[line 58]

Background color or gradient



Tags:

var:  Gradient

Type:   Color,


[ Top ]

$border =

[line 149]

Legend border


Type:   Border


[ Top ]

$columns =  NULL

[line 86]

Number of columns


Type:   int


[ Top ]

$component =

[line 51]

The current component


Type:   Component


[ Top ]

$hAlign =

[line 121]

Horizontal alignment


Type:   int


[ Top ]

$hide =  FALSE

[line 107]

Hide legend ?


Type:   bool


[ Top ]

$legends = array()

[line 44]

Legends added


Type:   array


[ Top ]

$margin =

[line 135]

Margin



Tags:

var:  Array for left, right, top and bottom margins

Type:   array


[ Top ]

$position =

[line 100]

Legend position


Type:   Point


[ Top ]

$rows =  NULL

[line 93]

Number of rows


Type:   int


[ Top ]

$shadow =

[line 142]

Legend shadow


Type:   Shadow


[ Top ]

$space =  4

[line 114]

Space between each legend


Type:   int


[ Top ]

$textColor =

[line 65]

Text color


Type:   Color


[ Top ]

$textFont =

[line 72]

Text font


Type:   Font


[ Top ]

$textMargin =

[line 79]

Text margin


Type:   Side


[ Top ]

$vAlign =

[line 128]

Vertical alignment


Type:   int


[ Top ]



Class Methods


constructor awLegend [line 198]

awLegend awLegend( [int $model = LEGEND_MODEL_RIGHT])

Build the legend



Parameters:

int   $model   Legend model

[ Top ]

method add [line 274]

void add( &$legendable &$legendable, string $title, [int $type = LEGEND_LINE])

Add a Legendable object to the legend



Parameters:

string   $title   Legend title
int   $type   Legend type (default to LEGEND_LINE)
&$legendable   &$legendable  

[ Top ]

method count [line 421]

int count( )

Count the number of Legendable objects in the legend



[ Top ]

method draw [line 425]

void draw( $driver)



Parameters:

   $driver  

[ Top ]

method drawBase [line 660]

void drawBase( $driver, $p, $width, $height)



Parameters:

   $driver  
   $p  
   $width  
   $height  

[ Top ]

method getPosition [line 357]

Point getPosition( )

Get legend position



[ Top ]

method hide [line 253]

void hide( [bool $hide = TRUE])

Hide legend ?



Parameters:

bool   $hide   TRUE to hide legend, FALSE otherwise

[ Top ]

method setAlign [line 309]

void setAlign( [int $h = NULL], [int $v = NULL])

Change alignment



Parameters:

int   $h   Horizontal alignment
int   $v   Vertical alignment

[ Top ]

method setBackground [line 394]

void setBackground( mixed $background)

Change background



Parameters:

mixed   $background  

[ Top ]

method setBackgroundColor [line 403]

void setBackgroundColor( $color $color)

Change background color



Parameters:

$color   $color  

[ Top ]

method setBackgroundGradient [line 412]

void setBackgroundGradient( $gradient $gradient)

Change background gradient



Parameters:

$gradient   $gradient  

[ Top ]

method setColumns [line 323]

void setColumns( int $columns)

Change number of columns



Parameters:

int   $columns  

[ Top ]

method setModel [line 213]

void setModel( int $model)

Set a predefined model for the legend



Parameters:

int   $model  

[ Top ]

method setPadding [line 290]

void setPadding( int $left, int $right, int $top, int $bottom)

Change legend padding



Parameters:

int   $left  
int   $right  
int   $top  
int   $bottom  

[ Top ]

method setPosition [line 345]

void setPosition( [float $x = NULL], [float $y = NULL])

Change legend position X and Y positions must be between 0 and 1.



Parameters:

float   $x  
float   $y  

[ Top ]

method setRows [line 333]

void setRows( int $rows)

Change number of rows



Parameters:

int   $rows  

[ Top ]

method setSpace [line 299]

void setSpace( int $space)

Change space between each legend



Parameters:

int   $space  

[ Top ]

method setTextColor [line 385]

void setTextColor( $color $color)

Change text color



Parameters:

$color   $color  

[ Top ]

method setTextFont [line 366]

void setTextFont( &$font &$font)

Change text font



Parameters:

&$font   &$font  

[ Top ]

method setTextMargin [line 376]

void setTextMargin( int $left, int $right)

Change text margin



Parameters:

int   $left  
int   $right  

[ Top ]

method show [line 262]

void show( [bool $show = TRUE])

Show legend ?



Parameters:

bool   $show  

[ Top ]


Documentation generated on Sat, 08 Nov 2008 14:52:54 +0100 by phpDocumentor 1.4.1