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

Class: Tool

Source Location: /tools/Tool.php

Class Overview

TeeBase
   |
   --Tool

Tool class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Child classes:

Annotation
Annotation class
ToolAxis
ToolAxis class
ToolSeries
ToolSeries class

Inherited Variables

Inherited Methods


Class Details

[line 16]
Tool class

Description: Base Tool class




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

$bBrush = null

[line 21]



Tags:

access:  protected

Type:   mixed


[ Top ]

$clickTolerance =  3

[line 18]



Tags:

access:  public

Type:   mixed


[ Top ]

$listenerList =

[line 24]



Tags:

access:  protected

Type:   mixed


[ Top ]

$pPen = null

[line 20]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor Tool [line 69]

Tool Tool( [ $c = null])



Tags:

access:  protected


Parameters:

   $c  

[ Top ]

method chartEvent [line 198]

void chartEvent( $ce)



Tags:

access:  public


Overridden in child classes as:

Annotation::chartEvent()
ColorBand::chartEvent()
ColorLine::chartEvent()
GridBand::chartEvent()
ExtraLegend::chartEvent()
SeriesBand::chartEvent()

Parameters:

   $ce  

[ Top ]

method getActive [line 171]

boolean getActive( )

Enables/Disables the indexed Tool.
Default value: true



Tags:

access:  public


[ Top ]

method getBitmapEditor [line 229]

URL getBitmapEditor( )

Returns the URL of the associated icon for a given Tool class.
This icon is used at Tools gallery listbox and Tools Editor dialog.



Tags:

access:  public


[ Top ]

method getDescription [line 210]

String getDescription( )

Gets descriptive text.



Tags:

access:  public


Overridden in child classes as:

Annotation::getDescription()
Gets descriptive text.
ColorBand::getDescription()
Gets descriptive text.
ColorLine::getDescription()
Gets descriptive text.
GridBand::getDescription()
Gets descriptive text.
ExtraLegend::getDescription()
Gets descriptive text.
MarksTip::getDescription()
Gets descriptive text.
SeriesBand::getDescription()
Gets descriptive text.

[ Top ]

method getFirstLastSeries [line 48]

void getFirstLastSeries( $s)



Parameters:

   $s  

[ Top ]

method getSummary [line 219]

String getSummary( )

Gets detailed descriptive text.



Tags:

access:  public


Overridden in child classes as:

Annotation::getSummary()
Gets detailed descriptive text.
ColorBand::getSummary()
Gets detailed descriptive text.
ColorLine::getSummary()
Gets detailed descriptive text.
GridBand::getSummary()
Gets detailed descriptive text.
ExtraLegend::getSummary()
Gets detailed descriptive text.
MarksTip::getSummary()
Gets detailed descriptive text.
SeriesBand::getSummary()
Gets detailed descriptive text.

[ Top ]

method mouseEvent [line 200]

void mouseEvent( $e, $c)



Tags:

access:  public


Overridden in child classes as:

Annotation::mouseEvent()
ColorBand::mouseEvent()
ColorLine::mouseEvent()
MarksTip::mouseEvent()

Parameters:

   $e  
   $c  

[ Top ]

method readResolve [line 41]

void readResolve( )



Tags:

access:  protected


Overridden in child classes as:

MarksTip::readResolve()

[ Top ]

method setActive [line 161]

void setActive( value $value)

Enables/Disables the indexed Tool.
Default value: true



Tags:

access:  public


Overridden in child classes as:

MarksTip::setActive()

Parameters:

value   $value   boolean

[ Top ]

method setChart [line 175]

void setChart( $value)



Tags:

access:  public


Overridden in child classes as:

Annotation::setChart()

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

Parameters:

   $value  

[ Top ]

method toString [line 79]

void toString( )



Tags:

access:  public


[ Top ]

method __get [line 27]

void __get( $property)



Overridden in child classes as:

Annotation::__get()
ToolAxis::__get()
ColorBand::__get()
ColorLine::__get()
GridBand::__get()
ToolSeries::__get()
ExtraLegend::__get()

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

Parameters:

   $property  

[ Top ]

method __set [line 34]

void __set( $property, $value)



Overridden in child classes as:

Annotation::__set()
ToolAxis::__set()
ColorBand::__set()
ColorLine::__set()
GridBand::__set()
ToolSeries::__set()
ExtraLegend::__set()

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

Parameters:

   $property  
   $value  

[ Top ]


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