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

Class: MarksTip

Source Location: /tools/MarksTip.php

Class Overview

TeeBase
   |
   --Tool
      |
      --ToolSeries
         |
         --MarksTip

<p>Title: MarksTip class</p>


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: ToolSeries

ToolSeries::ToolSeries()
ToolSeries::getHorizAxis()
Returns the associated Top or Bottom Chart Horizontal Axis.
ToolSeries::getSeries()
The Series with which Tools are associated.
Default value: null
ToolSeries::getVertAxis()
Returns the associated Left or Right Chart Vertical Axis.
ToolSeries::setSeries()
Sets the Series with which Tools are associated.
Default value: null
ToolSeries::__get()
ToolSeries::__set()

Class: Tool

Tool::Tool()
Tool::chartEvent()
Tool::getActive()
Enables/Disables the indexed Tool.
Default value: true
Tool::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.
Tool::getDescription()
Gets descriptive text.
Tool::getFirstLastSeries()
Tool::getSummary()
Gets detailed descriptive text.
Tool::mouseEvent()
Tool::readResolve()
Tool::setActive()
Enables/Disables the indexed Tool.
Default value: true
Tool::setChart()
Tool::toString()
Tool::__get()
Tool::__set()

Class: TeeBase

TeeBase::__construct()
TeeBase::getChart()
Chart associated with this object.
TeeBase::invalidate()
Use invalidate when the entire canvas needs to be repainted.
TeeBase::setBooleanProperty()
TeeBase::setChart()
Chart associated with this object.
TeeBase::setColorProperty()
TeeBase::setDoubleProperty()
TeeBase::setIntegerProperty()
TeeBase::setStringProperty()
TeeBase::_setColorProperty()
TeeBase::__get()
TeeBase::__set()

Class Details

[line 17]
<p>Title: MarksTip class</p>

Description: Marks Tip.
Marks tip tool, use it to display "tips" or "hints" when the end-user moves or clicks the mouse over a series point.

Copyright (c) 2005-2007 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL




Tags:

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


[ Top ]


Class Variables

$customToolTip =

[line 22]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor MarksTip [line 24]

MarksTip MarksTip( [ $c = null])



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method getDescription [line 158]

String getDescription( )

Gets descriptive text.



Tags:

access:  public


Overrides Tool::getDescription() (Gets descriptive text.)

[ Top ]

method getHideDelay [line 130]

int getHideDelay( )

The time period during which the Tool Tip appears.
Default value: 4000 (ms)



Tags:

access:  public


[ Top ]

method getMouseAction [line 80]

MarksTipMouseAction getMouseAction( )

Activates Mark Tip on mouse move or click.
Default value: MarksTipMouseAction.Move



Tags:

access:  public


[ Top ]

method getMouseDelay [line 101]

int getMouseDelay( )

The time lag before the Tool Tip appears.
Default value: 500



Tags:

access:  public


[ Top ]

method getStyle [line 56]

MarksStyle getStyle( )

Defines the text format of the Mark ToolTip.
Default value: MarksStyle.Label



Tags:

access:  public


[ Top ]

method getSummary [line 167]

String getSummary( )

Gets detailed descriptive text.



Tags:

access:  public


Overrides Tool::getSummary() (Gets detailed descriptive text.)

[ Top ]

method mouseEvent [line 188]

void mouseEvent( $e, $c)



Tags:

access:  public


Overrides Tool::mouseEvent() (parent method not documented)

Parameters:

   $e  
   $c  

[ Top ]

method readResolve [line 30]

void readResolve( )



Tags:

access:  protected


Overrides Tool::readResolve() (parent method not documented)

[ Top ]

method removeToolTipResolver [line 44]

void removeToolTipResolver( )



Tags:

access:  public


[ Top ]

method setActive [line 250]

void setActive( $value)



Tags:

access:  public


Overrides Tool::setActive() (Enables/Disables the indexed Tool.
Default value: true)

Parameters:

   $value  

[ Top ]

method setHideDelay [line 145]

void setHideDelay( value $value)

Sets the time period during which the Tool Tip appears.
Default value: 4000 (ms)



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setMouseAction [line 90]

void setMouseAction( value $value)

Activates Mark Tip on mouse move or click.
Default value: MarksTipMouseAction.Move



Tags:

access:  public


Parameters:

value   $value   MarksTipMouseAction

[ Top ]

method setMouseDelay [line 116]

void setMouseDelay( value $value)

Sets the time lag before the Tool Tip appears.
Default value: 500



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setStyle [line 67]

void setStyle( value $value)

Defines the text format of the Mark ToolTip.
Default value: MarksStyle.Label



Tags:

access:  public


Parameters:

value   $value   MarksStyle

[ Top ]

method setToolTipResolver [line 36]

void setToolTipResolver( $resolver)



Tags:

access:  public


Parameters:

   $resolver  

[ Top ]


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