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

Class: ChartBrush

Source Location: /drawing/ChartBrush.php

Class Overview

TeeBase
   |
   --ChartBrush

ChartBrush class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 17]
ChartBrush class

Description: Common Chart Brush (pattern) used to fill polygons and rectangles




Tags:

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


[ Top ]


Class Variables

$color =

[line 33]



Tags:

access:  protected

Type:   mixed


[ Top ]

$defaultColor =

[line 30]



Tags:

access:  protected

Type:   mixed


[ Top ]

$defaultVisible =

[line 31]



Tags:

access:  protected

Type:   mixed


[ Top ]

$internalTransparency =

[line 29]



Tags:

access:  protected

Type:   mixed


[ Top ]

$visible =  true

[line 32]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor ChartBrush [line 51]

ChartBrush ChartBrush( $c, [ $aColor = null], [ $startVisible = true])



Tags:

access:  public


Parameters:

   $c  
   $aColor  
   $startVisible  

[ Top ]

method applyDark [line 346]

void applyDark( $quantity)



Tags:

access:  public


Parameters:

   $quantity  

[ Top ]

method assign [line 101]

void assign( $b)



Tags:

access:  public


Parameters:

   $b  

[ Top ]

method clearImage [line 459]

void clearImage( )

Clears the ChartBrush element from all associated bitmap images.



Tags:

access:  public


[ Top ]

method getColor [line 356]

Color getColor( )

Determines the color used to fill a zone.



Tags:

access:  public


[ Top ]

method getForegroundColor [line 325]

Color getForegroundColor( )

Color to fill inner portions of Brush, when Solid is false.
Default value: SILVER



Tags:

access:  public


[ Top ]

method getGradient [line 230]

Gradient getGradient( )

Fill Gradient.
Gradient specifies the colors used to fill a zone.

The zone is filled using these three colors: StartColor, MidColor and EndColor. You can control the drawing output by setting Gradient.Direction.
Use the Visible property to show / hide filling.
Default value: null




Tags:

access:  public


[ Top ]

method getGradientVisible [line 215]

void getGradientVisible( )



Tags:

access:  public


[ Top ]

method getHatchTexture [line 83]

void getHatchTexture( )



Tags:

access:  public


[ Top ]

method getImage [line 420]

Image getImage( )

Image to use for fill.
Default value: null



Tags:

access:  public


[ Top ]

method getImageMode [line 270]

ImageMode getImageMode( )

Drawing Brush Image Style.
Default value: Stretch



Tags:

access:  public


[ Top ]

method getImageRect [line 287]

void getImageRect( )



Tags:

access:  public


[ Top ]

method getImageTransparent [line 201]

boolean getImageTransparent( )

The Brush image will be Transparent when true.
Default value: false



Tags:

access:  public


[ Top ]

method getSolid [line 181]

boolean getSolid( )

Fills using Color only. Does not use Foreground color.
Default value: true



Tags:

access:  public


[ Top ]

method getStyle [line 394]

HatchStyle getStyle( )

Determines the style in which the zone is filled or patterned using both Color and ForegroundColor.
Default value: HatchStyle.BackwardDiagonal



Tags:

access:  public


[ Top ]

method getTexture [line 93]

void getTexture( $rect)



Tags:

access:  public


Parameters:

   $rect  

[ Top ]

method getTransparency [line 155]

int getTransparency( )

The Transparency level from 0 to 100%.


Transparency is a value between 0 and 100 which sets the transparency percentage with respect to foreground versus background.
Default value: 0




Tags:

access:  public


[ Top ]

method getVisible [line 374]

boolean getVisible( )

Determines if the brush will draw lines or not.



Tags:

access:  public


[ Top ]

method getWrapTile [line 301]

boolean getWrapTile( )

Drawing Brush Image Style.
Default value: Tile



Tags:

access:  public


[ Top ]

method invalidate [line 259]

void invalidate( )

Use invalidate when the entire canvas needs to be repainted.


When more than one region within the canvas needs repainting, Invalidate will cause the entire window to be repainted in a single pass, aing flicker caused by redundant repaints. There is no performance penalty for calling Invalidate multiple times before the control is actually repainted.




Tags:

access:  public


Overrides TeeBase::invalidate() (Use invalidate when the entire canvas needs to be repainted.)

[ Top ]

method loadImageFromFile [line 441]

void loadImageFromFile( fileName $fileName)

Loads a bitmap into a ChartBrush element from the specified path.



Tags:

access:  public


Parameters:

fileName   $fileName   String

[ Top ]

method reset [line 71]

void reset( )



Tags:

access:  public


[ Top ]

method setChart [line 140]

void setChart( $c)



Tags:

access:  public


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

Parameters:

   $c  

[ Top ]

method setColor [line 365]

void setColor( value $value)

Specifies the color used to fill a zone.



Tags:

access:  public


Parameters:

value   $value   Color

[ Top ]

method setDefaultColor [line 135]

void setDefaultColor( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setForegroundColor [line 337]

void setForegroundColor( value $value)

Specifies the Color to fill inner portions of Brush, when Solid is false.


Default value: SILVER




Tags:

access:  public


Parameters:

value   $value   Color

[ Top ]

method setGradient [line 243]

void setGradient( value $value)

Sets the Gradient fill.
Default value: null



Tags:

access:  public


Parameters:

value   $value   Gradient

[ Top ]

method setImage [line 430]

void setImage( value $value)

Image to use for fill.
Default value: null



Tags:

access:  public


Parameters:

value   $value   Image

[ Top ]

method setImageMode [line 280]

void setImageMode( value $value)

Drawing Brush Image Style.
Default value: Stretch



Tags:

access:  public


Parameters:

value   $value   ImageMode

[ Top ]

method setImageTransparent [line 211]

void setImageTransparent( value $value)

Sets the Brush image to Transparent.
Default value: false



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setSolid [line 191]

void setSolid( value $value)

Fills using Color only. Does not use Foreground color.
Default value: true



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setStyle [line 405]

void setStyle( value $value)

Determines the style in which the zone is filled or patterned using both Color and ForegroundColor.
Default value: HatchStyle.BackwardDiagonal



Tags:

access:  public


Parameters:

value   $value   HatchStyle

[ Top ]

method setTransparency [line 165]

void setTransparency( value $value)

Sets Transparency level from 0 to 100%.
Default value: 0



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setVisible [line 383]

void setVisible( value $value)

Determines if the brush will draw lines or not.



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setWrapTile [line 311]

void setWrapTile( value $value)

Drawing Brush Image Style.
Default value: Tile



Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method _applyDark [line 341]

void _applyDark( $c, $quantity)



Tags:

access:  public


Parameters:

   $c  
   $quantity  

[ Top ]

method __get [line 37]

void __get( $property)



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

Parameters:

   $property  

[ Top ]

method __set [line 44]

void __set( $property, $value)



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

Parameters:

   $property  
   $value  

[ Top ]


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