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

Class: Annotation

Source Location: /tools/Annotation.php

Class Overview

TeeBase
   |
   --Tool
      |
      --Annotation

Annotation class


Author(s):

Version:

  • 1.0

Copyright:

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

Methods


Inherited Variables

Inherited Methods

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 16]
Annotation class

Description: Annotation tool




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 Methods


constructor Annotation [line 41]

Annotation Annotation( [ $c = null], [ $text = ""])



Tags:

access:  public


Parameters:

   $c  
   $text  

[ Top ]

method addToolMouseListener [line 53]

void addToolMouseListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method chartEvent [line 423]

void chartEvent( $e)



Tags:

access:  public


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

Parameters:

   $e  

[ Top ]

method clicked [line 438]

boolean clicked( p $p)

Returns true is point parameter is inside annotation bounds



Tags:

access:  public


Parameters:

p   $p   Point

[ Top ]

method getCallout [line 63]

void getCallout( )



Tags:

access:  public


[ Top ]

method getCursor [line 79]

Cursor getCursor( )

The Cursor type for when the user moves the mouse over the Annotation bounds.
Default value: Default



Tags:

access:  public


[ Top ]

method getCustomSize [line 306]

void getCustomSize( )



Tags:

access:  public


[ Top ]

method getDescription [line 254]

String getDescription( )

Gets descriptive text.



Tags:

access:  public


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

[ Top ]

method getHeight [line 273]

int getHeight( )

Returns the annotation height in pixels



Tags:

access:  public


[ Top ]

method getInnerText [line 222]

void getInnerText( )



Tags:

access:  protected


[ Top ]

method getLeft [line 139]

int getLeft( )

The horizontal displacement in pixels of text box from Chart's left edge.



Tags:

access:  public


[ Top ]

method getPosition [line 185]

AnnotationPosition getPosition( )

The default position for the Annotation Tool text box and text.


Default value: AnnotationPosition.LeftTop




Tags:

access:  public


[ Top ]

method getShape [line 213]

TextShapePosition getShape( )

The characteristics of the Annotation Tool text and text box Shape.



Tags:

access:  public


[ Top ]

method getSummary [line 264]

String getSummary( )

Gets detailed descriptive text.



Tags:

access:  public


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

[ Top ]

method getText [line 233]

String getText( )

The text for the Annotation Tool.
Default value: ""



Tags:

access:  public


[ Top ]

method getTextAlign [line 109]

StringAlignment getTextAlign( )

Horizontal alignment of displayed text.
Default value: StringAlignment.Near



Tags:

access:  public


[ Top ]

method getTop [line 161]

int getTop( )

The vertical displacement in pixels of text box from Chart's top edge.



Tags:

access:  public


[ Top ]

method getWidth [line 291]

int getWidth( )

Returns the annotation width in pixels



Tags:

access:  public


[ Top ]

method mouseEvent [line 443]

void mouseEvent( $e, $c)



Tags:

access:  public


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

Parameters:

   $e  
   $c  

[ Top ]

method removeToolMouseListener [line 58]

void removeToolMouseListener( $l)



Tags:

access:  public


Parameters:

   $l  

[ Top ]

method setChart [line 96]

void setChart( $c)



Tags:

access:  public


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

Parameters:

   $c  

[ Top ]

method setCursor [line 91]

void setCursor( value $value)

Selects the Cursor type for when the user moves the mouse over the Annotation bounds.
Default value: Default



Tags:

access:  public


Parameters:

value   $value   Cursor

[ Top ]

method setCustomSize [line 311]

void setCustomSize( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setHeight [line 282]

void setHeight( value $value)

Sets the annotation height in pixels



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setLeft [line 150]

void setLeft( value $value)

Sets horizontal displacement in pixels of text box from Chart's left edge.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setPosition [line 198]

void setPosition( value $value)

Defines a default position for the Annotation Tool text box and text.


Default value: AnnotationPosition.LeftTop




Tags:

access:  public


Parameters:

value   $value   AnnotationPosition

[ Top ]

method setText [line 244]

void setText( value $value)

Defines the text for the Annotation Tool.
Default value: ""



Tags:

access:  public


Parameters:

value   $value   String

[ Top ]

method setTextAlign [line 120]

void setTextAlign( value $value)

Sets the horizontal alignment of displayed text.
Default value: StringAlignment.Near



Tags:

access:  public


Parameters:

value   $value   StringAlignment

[ Top ]

method setTop [line 171]

void setTop( value $value)

Sets vertical displacement in pixels of text box from Chart's top edge.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setWidth [line 300]

void setWidth( value $value)

Sets the annotation width in pixels



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method __get [line 27]

void __get( $property)



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

Parameters:

   $property  

[ Top ]

method __set [line 34]

void __set( $property, $value)



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

Parameters:

   $property  
   $value  

[ Top ]


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