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

Class: awComponent

Source Location: /class/system/artichow/php5/Component.class.php

Class Overview




Author(s):

Variables

Methods


Child classes:

awComponentGroup
A graph can contain some groups of components

Class Details

[line 49]


Tags:

abstract:  


[ Top ]


Class Variables

$auto =  TRUE

[line 149]

Adjust automatically the component ?



Tags:

access:  protected

Type:   bool


[ Top ]

$background =

[line 121]

Component background color



Tags:

access:  protected

Type:   Color


[ Top ]

$driver =

[line 56]

Component driver



Tags:

access:  protected

Type:   Driver


[ Top ]

$h =

[line 100]

Component absolute height (in pixels)



Tags:

access:  public

Type:   int


[ Top ]

$height =  1.0

[line 70]

Component height



Tags:

access:  public

Type:   float


[ Top ]

$left =

[line 114]

Left-top corner X position



Tags:

access:  public

Type:   float


[ Top ]

$legend =

[line 156]

Legend



Tags:

access:  public

Type:   Legend


[ Top ]

$padding =

[line 128]

Component padding



Tags:

access:  protected

Type:   Side


[ Top ]

$space =

[line 135]

Component space



Tags:

access:  protected

Type:   Side


[ Top ]

$title =

[line 142]

Component title



Tags:

access:  public

Type:   Label


[ Top ]

$top =

[line 107]

Left-top corner Y position



Tags:

access:  public

Type:   float


[ Top ]

$w =

[line 92]

Component absolute width (in pixels)



Tags:

access:  public

Type:   int


[ Top ]

$width =  1.0

[line 63]

Component width



Tags:

access:  public

Type:   float


[ Top ]

$x =  0.5

[line 77]

Position X of the center the graph (from 0 to 1)



Tags:

access:  public

Type:   float


[ Top ]

$y =  0.5

[line 84]

Position Y of the center the graph (from 0 to 1)



Tags:

access:  public

Type:   float


[ Top ]



Class Methods


constructor __construct [line 161]

awComponent __construct( )

Build the component



Tags:

access:  public


Overridden in child classes as:

awComponentGroup::__construct()
Build the component group

[ Top ]

method auto [line 185]

void auto( bool $auto)

Adjust automatically the component ?



Tags:

access:  public


Parameters:

bool   $auto  

[ Top ]

method drawComponent [line 393]

void drawComponent( $driver, int $x1, int $y1, int $x2, int $y2, bool $aliasing)

Draw the component on the graph Component should be drawed into specified coords



Tags:

abstract:  
access:  public


Overridden in child classes as:

awPlotGroup::drawComponent()

Parameters:

int   $x1  
int   $y1  
int   $x2  
int   $y2  
bool   $aliasing   Use anti-aliasing to draw the component ?
Driver   $driver   A driver

[ Top ]

method drawEnvelope [line 380]

array drawEnvelope( $driver)

Draw the grid around your component



Tags:

return:  Coords for the component
abstract:  
access:  public


Overridden in child classes as:

awPlotGroup::drawEnvelope()

Parameters:

Driver   $driver   A driver

[ Top ]

method finalize [line 360]

void finalize( $driver)

Finalize the drawing of the component



Tags:

access:  public


Parameters:

awDriver   $driver  

[ Top ]

method getBackground [line 253]

Color, getBackground( )

Return the component background



Tags:

return:  Gradient
access:  public


[ Top ]

method getPosition [line 312]

array getPosition( )

Get component coords with its padding



Tags:

return:  Coords of the component
access:  public


[ Top ]

method getSpace [line 402]

array getSpace( int $width, int $height)

Get space width in pixels



Tags:

access:  protected


Parameters:

int   $width   Component width
int   $height   Component height

[ Top ]

method init [line 327]

void init( $driver)

Init the drawing of the component



Tags:

access:  public


Overridden in child classes as:

awPlotGroup::init()

Parameters:

awDriver   $driver  

[ Top ]

method setAbsPosition [line 287]

void setAbsPosition( $left, $top)

Change the absolute position of the component on the graph



Tags:

var:  Left-top corner X position
access:  public


Parameters:

   $left  
   $top  

[ Top ]

method setAbsSize [line 208]

void setAbsSize( int $w, int $h)

Change the absolute size of the component



Tags:

access:  public


Parameters:

int   $w   Component width (in pixels)
int   $h   Component height (in pixels)

[ Top ]

method setBackgroundColor [line 220]

void setBackgroundColor( awColor $color)

Change component background color



Tags:

access:  public


Parameters:

awColor   $color   (can be null)

[ Top ]

method setBackgroundGradient [line 231]

void setBackgroundGradient( awGradient $gradient)

Change component background gradient



Tags:

access:  public


Parameters:

awGradient   $gradient   (can be null)

[ Top ]

method setBackgroundImage [line 242]

void setBackgroundImage( awImage $image)

Change component background image



Tags:

access:  public


Parameters:

awImage   $image   (can be null)

[ Top ]

method setCenter [line 300]

void setCenter( int $x, int $y)

Set the center of the component



Tags:

access:  public


Parameters:

int   $x   Position X of the center of the component
int   $y   Position Y of the center of the component

[ Top ]

method setPadding [line 265]

void setPadding( [int $left = NULL], [int $right = NULL], [int $top = NULL], [int $bottom = NULL])

Change component padding



Tags:

access:  public


Parameters:

int   $left   Padding in pixels (NULL to keep old value)
int   $right   Padding in pixels (NULL to keep old value)
int   $top   Padding in pixels (NULL to keep old value)
int   $bottom   Padding in pixels (NULL to keep old value)

[ Top ]

method setSize [line 195]

void setSize( int $width, int $height)

Change the size of the component



Tags:

access:  public


Parameters:

int   $width   Component width (from 0 to 1)
int   $height   Component height (from 0 to 1)

[ Top ]

method setSpace [line 277]

void setSpace( [float $left = NULL], [float $right = NULL], [float $bottom = NULL], [float $top = NULL])

Change component space



Tags:

access:  public


Parameters:

float   $left   Space in % (NULL to keep old value)
float   $right   Space in % (NULL to keep old value)
float   $bottom   Space in % (NULL to keep old value)
float   $top   Space in % (NULL to keep old value)

[ Top ]


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