TeeChartPHP
[ class tree: TeeChartPHP ] [ index: TeeChartPHP ] [ all elements ]

Class: Shadow

Source Location: /Shadow.php

Class Overview

TeeBase
   |
   --Shadow

Shadow class


Author(s):

Version:

  • 1.0

Copyright:

  • (c) 1995-2010 by Steema Software SL. All Rights Reserved. <info@steema.com>

Variables

Methods


Child classes:

PieShadow
<p>Title: PieShadow class</p>

Inherited Variables

Inherited Methods


Class Details

[line 15]
Shadow class

Description: Properties to draw a shadow




Tags:

author:  
version:  1.0
copyright:  (c) 1995-2010 by Steema Software SL. All Rights Reserved. <info@steema.com>
link:  http://www.steema.com


[ Top ]


Class Variables

$bBrush =

[line 20]



Tags:

access:  protected

Type:   mixed


[ Top ]

$bVisible = false

[line 21]



Tags:

access:  protected

Type:   mixed


[ Top ]

$defaultColor =

[line 24]



Tags:

access:  protected

Type:   mixed


[ Top ]

$defaultSize =

[line 23]



Tags:

access:  protected

Type:   mixed


[ Top ]

$defaultVisible = false

[line 22]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor Shadow [line 48]

Shadow Shadow( c $c, [size $size = -1], [color $color = null])

Shadow constructor, defines initial size and color



Tags:

access:  public


Parameters:

c   $c   IBaseChart
size   $size   int
color   $color   Color

[ Top ]

method assign [line 73]

void assign( value $value)

Assigns characteristics of Shadow '$value'.
Copies all properties from Source Shadow to Self.



Tags:

access:  public


Parameters:

value   $value   Shadow

[ Top ]

method draw [line 315]

void draw( g $g, rect $rect, [angle $angle = 0], [aZ $aZ = 0])

Draws a shadow around the Rect rectangle parameter.
Uses the Height, Width and Transparency properties to draw the shadow.



Tags:

access:  public


Parameters:

g   $g   IGraphics3D
rect   $rect   Rectangle
angle   $angle   int
aZ   $aZ   int

[ Top ]

method getBrush [line 234]

ChartBrush getBrush( )

Defines the Brush characteristics to fill the shadow.



Tags:

access:  public


[ Top ]

method getColor [line 85]

Color getColor( )

Defines the shadow Color. Gets or sets Color used to fill shadow.



Tags:

access:  public


[ Top ]

method getHeight [line 138]

int getHeight( )

The vertical displacement of the shadow in pixels.



Tags:

access:  public


[ Top ]

method getHorizSize [line 166]

int getHorizSize( )

Obsolete.&nbsp;Please use Width property.



Tags:

access:  public


[ Top ]

method getSize [line 246]

Dimension getSize( )

Size in pixels of shadow.
Returns the biggest of the HorizSize and VertSize properties.

When setting Size, it will set both HorizSize and VertSize to the same $value.




Tags:

access:  public


[ Top ]

method getTransparency [line 120]

int getTransparency( )

The Transparency level from 0 to 100% of shadow.
Transparency is a $value between 0 and 100 which sets the transparency percentage with respect to foreground versus background for the shadow.



Tags:

access:  public


[ Top ]

method getVertSize [line 184]

int getVertSize( )

Obsolete.&nbsp;Please use Height property.



Tags:

access:  public


[ Top ]

method getVisible [line 281]

boolean getVisible( )

Determines whether the shadow will appear on screen.



Tags:

access:  public


[ Top ]

method getWidth [line 206]

int getWidth( )

The horizontal shadow size in pixels.



Tags:

access:  public


[ Top ]

method setChart [line 345]

void setChart( $c)



Tags:

access:  public


Overrides TeeBase::setChart() (Chart associated with this object.)

Parameters:

   $c  

[ Top ]

method setColor [line 94]

void setColor( value $value)

Defines the shadow Color. Gets or sets Color used to fill shadow.



Tags:

access:  public


Parameters:

value   $value   Color

[ Top ]

method setDefaultSize [line 98]

void setDefaultSize( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setDefaultVisible [line 104]

void setDefaultVisible( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setHeight [line 157]

void setHeight( value $value)

Sets the vertical displacement of the shadow in pixels.

Example:




Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setHorizSize [line 175]

void setHorizSize( $value $value)

Obsolete.&nbsp;Please use Width property.



Tags:

access:  public


Parameters:

$value   $value   int

[ Top ]

method setSize [line 255]

void setSize( $value $value)

Sets both horizontal and vertical shadow size to same $value.



Tags:

access:  public


Parameters:

$value   $value   int

[ Top ]

method setTransparency [line 129]

void setTransparency( $value $value)

Sets Transparency level from 0 to 100% of shadow.




Tags:

access:  public


Parameters:

$value   $value   int

[ Top ]

method setVertSize [line 193]

void setVertSize( $value $value)

Obsolete.&nbsp;Please use Height property.



Tags:

access:  public


Parameters:

$value   $value   int

[ Top ]

method setVisible [line 290]

void setVisible( $value $value)

Determines whether the shadow will appear on screen.



Tags:

access:  public


Parameters:

$value   $value   boolean

[ Top ]

method setWidth [line 225]

void setWidth( value $value)

Sets the horizontal shadow size in pixels.

Example:




Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method shouldSerializeHeight [line 109]

void shouldSerializeHeight( )



Tags:

access:  protected


[ Top ]

method shouldSerializeVisible [line 272]

void shouldSerializeVisible( $value 0)

Size in pixels of shadow.




Tags:

access:  protected


Parameters:

$value   0   Dimension

[ Top ]

method shouldSerializeWidth [line 197]

void shouldSerializeWidth( )



Tags:

access:  protected


[ Top ]

method _draw [line 302]

void _draw( g $g, rect $rect)

Draws a shadow around the Rect rectangle parameter, using the ACanvas canvas.
Uses the Height, Width and Transparency properties to draw the shadow.



Tags:

access:  public


Parameters:

g   $g   IGraphics3D
rect   $rect   Rectangle

[ Top ]

method __get [line 27]

void __get( $property)



Overrides TeeBase::__get() (parent method not documented)

Parameters:

   $property  

[ Top ]

method __set [line 34]

void __set( $property, $value)



Overrides TeeBase::__set() (parent method not documented)

Parameters:

   $property  
   $value  

[ Top ]


Documentation generated on Wed, 16 Jun 2010 12:08:08 +0200 by phpDocumentor 1.4.1