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

Class: awLabel

Source Location: /class/system/artichow/php5/inc/Label.class.php

Class Overview


Draw labels


Implements interfaces:

Variables

Methods



Class Details

[line 30]
Draw labels



[ Top ]


Class Variables

$angle =  0

[line 58]

Text angle



Tags:

access:  protected

Type:   int


[ Top ]

$border =

[line 37]

Label border



Tags:

access:  public

Type:   int


[ Top ]

$color =

[line 65]

Text color



Tags:

access:  protected

Type:   Color


[ Top ]

$font =

[line 51]

Text font



Tags:

access:  protected

Type:   int


[ Top ]

$hAlign =  awLabel::CENTER

[line 107]

Horizontal align



Tags:

access:  protected

Type:   int


[ Top ]

$hide =  FALSE

[line 121]

Hide all labels ?



Tags:

access:  protected

Type:   bool


[ Top ]

$hideFirst =  FALSE

[line 142]

Hide first label



Tags:

access:  protected

Type:   bool


[ Top ]

$hideKey = array()

[line 128]

Keys to hide



Tags:

access:  protected

Type:   array


[ Top ]

$hideLast =  FALSE

[line 149]

Hide last label



Tags:

access:  protected

Type:   bool


[ Top ]

$hideValue = array()

[line 135]

Values to hide



Tags:

access:  protected

Type:   array


[ Top ]

$interval =  1

[line 100]

Label interval



Tags:

access:  protected

Type:   int


[ Top ]

$move =

[line 93]

Move position from this vector



Tags:

access:  protected

Type:   Point


[ Top ]

$texts =

[line 44]

Label texts



Tags:

access:  protected

Type:   array


[ Top ]

$vAlign =  awLabel::MIDDLE

[line 114]

Vertical align



Tags:

access:  protected

Type:   int


[ Top ]



Class Methods


constructor __construct [line 156]

awLabel __construct( [string $label = NULL], [ $font = NULL], [ $color = NULL], [ $angle = 0])

Build the label



Tags:

access:  public


Parameters:

string   $label   First label
   $font  
   $color  
   $angle  

[ Top ]

method all [line 199]

array all( )

Get all labels



Tags:

access:  public


[ Top ]

method count [line 223]

int count( )

Count number of texts in the label



Tags:

access:  public


[ Top ]

method draw [line 492]

void draw( awDriver $driver, awPoint $p, [int $key = 0])

Draw the label



Tags:

access:  public


Parameters:

awDriver   $driver  
awPoint   $p   Label center
int   $key   Text position in the array of texts (default to zero)

[ Top ]

method get [line 190]

string get( int $key)

Get an element of the label from its key



Tags:

return:  A value
access:  public


Parameters:

int   $key   Element key

[ Top ]

method getCallbackFunction [line 241]

string getCallbackFunction( )

Return the callback function for labels



Tags:

access:  public


[ Top ]

method getMax [line 575]

void getMax( awDriver $driver, $function)



Tags:

access:  protected


Parameters:

awDriver   $driver  
   $function  

[ Top ]

method getMaxHeight [line 479]

int getMaxHeight( awDriver $driver)

Get max height of all texts



Tags:

access:  public


Parameters:

awDriver   $driver   A driver

[ Top ]

method getMaxWidth [line 467]

int getMaxWidth( awDriver $driver)

Get max width of all texts



Tags:

access:  public


Parameters:

awDriver   $driver   A driver

[ Top ]

method getText [line 426]

Text getText( mixed $key)

Get a text from the labele



Tags:

access:  public


Parameters:

mixed   $key   Key in the array text

[ Top ]

method hide [line 333]

void hide( [bool $hide = TRUE])

Hide all labels ?



Tags:

access:  public


Parameters:

bool   $hide  

[ Top ]

method hideFirst [line 369]

void hideFirst( bool $hide)

Hide first label



Tags:

access:  public


Parameters:

bool   $hide  

[ Top ]

method hideKey [line 351]

void hideKey( int $key)

Hide a key



Tags:

access:  public


Parameters:

int   $key   The key to hide

[ Top ]

method hideLast [line 378]

void hideLast( bool $hide)

Hide last label



Tags:

access:  public


Parameters:

bool   $hide  

[ Top ]

method hideValue [line 360]

void hideValue( int $value)

Hide a value



Tags:

access:  public


Parameters:

int   $value   The value to hide

[ Top ]

method move [line 399]

void move( int $x, int $y)

Change label position



Tags:

access:  public


Parameters:

int   $x   Add this interval to X coord
int   $y   Add this interval to Y coord

[ Top ]

method set [line 208]

void set( array $labels)

Set one or several labels



Tags:

access:  public


Parameters:

array   $labels   Array of string or a string

[ Top ]

method setAlign [line 411]

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

Change alignment



Tags:

access:  public



Implementation of:
awPositionable::setAlign()
Change alignment

Parameters:

int   $h   Horizontal alignment
int   $v   Vertical alignment

[ Top ]

method setAngle [line 276]

void setAngle( int $angle)

Change font angle



Tags:

access:  public


Parameters:

int   $angle   New angle

[ Top ]

method setBackground [line 294]

void setBackground( mixed $background)

Change text background



Tags:

access:  public


Parameters:

mixed   $background  

[ Top ]

method setBackgroundColor [line 303]

void setBackgroundColor( awColor $color)

Change text background color



Tags:

access:  public


Parameters:

Color   $color  

[ Top ]

method setBackgroundGradient [line 312]

void setBackgroundGradient( awGradient $gradient)

Change text background gradient



Tags:

access:  public


Parameters:

Gradient   $gradient  

[ Top ]

method setCallbackFunction [line 232]

void setCallbackFunction( string $function)

Set a callback function for labels



Tags:

access:  public


Parameters:

string   $function  

[ Top ]

method setColor [line 285]

void setColor( awColor $color)

Change font color



Tags:

access:  public


Parameters:

awColor   $color  

[ Top ]

method setFont [line 264]

void setFont( awFont $font, [awColor $color = NULL])

Change font for label



Tags:

access:  public


Parameters:

awFont   $font   New font
awColor   $color   Font color (can be NULL)

[ Top ]

method setFormat [line 250]

void setFormat( string $format)

Change labels format



Tags:

access:  public


Parameters:

string   $format   New format (printf style: %.2f for example)

[ Top ]

method setInterval [line 387]

void setInterval( int $interval)

Set label interval



Tags:

access:  public


Parameters:

int   $interval  

[ Top ]

method setPadding [line 324]

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

Change padding



Tags:

access:  public


Parameters:

int   $left   Left padding
int   $right   Right padding
int   $top   Top padding
int   $bottom   Bottom padding

[ Top ]

method show [line 342]

void show( [bool $show = TRUE])

Show all labels ?



Tags:

access:  public


Parameters:

bool   $show  

[ Top ]


Documentation generated on Thu, 03 May 2012 15:05:19 +0200 by phpDocumentor 1.4.1