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

Class: TextShape

Source Location: /TextShape.php

Class Overview

TeeBase
   |
   --TeeShape
      |
      --TextShape

TextShape class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Child classes:

AxisLabelItem
AxisLabelItem class
AxisLabels
AxisLabels class
AxisTitle
AxisTitle class
LegendTitle
LegendTitle class
MarksItem
MarksItem class
SeriesMarks
SeriesMarks class
TextShapePosition
TextShapePosition class

Inherited Variables

Inherited Methods

Class: TeeShape

TeeShape::__construct()
The class constructor.
TeeShape::assign()
Assign all properties from a shape to another.
TeeShape::getBevel()
Sets the bevel characteristics of the Shape.
TeeShape::getBevelInner()
Obsolete.&ndsp;Please use Bevel.<!-- -->Inner.
TeeShape::getBevelOuter()
Obsolete.&nbsp;Please use Bevel.<!-- -->Outer
TeeShape::getBevelWidth()
Obsolete.&nbsp;Please use Bevel.<!-- -->Width
TeeShape::getBorderRound()
Rounds the Borders of the Chart Shapes.
TeeShape::getBottom()
Shape rectangle bottom co-ordinate.
TeeShape::getBrush()
Defines the kind of brush used to fill shape background.
TeeShape::getColor()
Defines the shape Color.
TeeShape::getGradient()
Calls the Gradient characteristics for the shape.
TeeShape::getHeight()
TeeShape::getImage()
Rendered Image for Shape background.
Default value: null
TeeShape::getImageBevel()
Sets the bevel characteristics of the Shape.
TeeShape::getImageMode()
ImageMode for rendered Shape background Image.
Default value: ImageMode::$Stretch
TeeShape::getImageTransparent()
Sets the shape image to transparent.
TeeShape::getLeft()
Shape rectangle left co-ordinate.
TeeShape::getPen()
Specifies the pen used to draw the shape.
TeeShape::getRight()
Shape rectangle right co-ordinate.
TeeShape::getShadow()
Defines the shape's Shadow characteristics.
TeeShape::getShapeBorders()
Defines the Shape Borders.
TeeShape::getShapeBounds()
Defines the boundaries of the Shape.
TeeShape::getTop()
Shape rectangle top co-ordinate.
TeeShape::getTransparency()
The Transparency level from 0 to 100% of shape.
TeeShape::getTransparent()
Enables/disables transparency of shape.
See transparency, which sets percentage transparency when Transparent is true.
TeeShape::getVisible()
Shows or hides the Shape.
TeeShape::getWidth()
TeeShape::paint()
TeeShape::setBevel()
Internal use - serialization
TeeShape::setBevelInner()
Defines the inner bevel type of the TChart Panel border.
TeeShape::setBevelOuter()
Defines the outer bevel type of the TChart Panel border.
TeeShape::setBevelWidth()
Obsolete.&nbsp;Please use Bevel.<!-- -->Width
TeeShape::setBorderRound()
Rounds the Borders of the Chart Shapes.
TeeShape::setBottom()
Shape rectangle bottom co-ordinate.
TeeShape::setBrush()
Internal use - serialization
TeeShape::setChart()
Chart associated with this object.
TeeShape::setColor()
TeeShape::setDefaultVisible()
TeeShape::setHeight()
TeeShape::setImage()
Sets Rendered Image for Shape background.
Default value: null
TeeShape::setImageMode()
Sets the ImageMode for rendered Shape background Image.
Default value: ImageMode.Stretch
TeeShape::setImageTransparent()
TeeShape::setLeft()
Shape rectangle left co-ordinate.
TeeShape::setPen()
Internal use - serialization
TeeShape::setRight()
Shape rectangle right co-ordinate.
TeeShape::setShapeBounds()
Defines the boundaries of the Shape.
TeeShape::setTop()
Shape rectangle top co-ordinate.
TeeShape::setTransparency()
Sets Transparency level from 0 to 100% of shape.
Default value: 0
TeeShape::setTransparent()
Enables/disables transparency of shape.
TeeShape::setVisible()
Shows or hides the Shape.
TeeShape::setWidth()
TeeShape::_setColor()
Defines the shape Color.
TeeShape::__get()
TeeShape::__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 15]
TextShape class

Description: Base class for Chart shape elements with text




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

$defaultText =  ""

[line 19]



Tags:

access:  public

Type:   mixed


[ Top ]

$drawText =  true

[line 18]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor TextShape [line 44]

TextShape TextShape( [ $c = null])

The class constructor.



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method assign [line 212]

void assign( s $s)

Assign all properties from a TextShape to another.



Tags:

access:  public


Overrides TeeShape::assign() (Assign all properties from a shape to another.)

Parameters:

s   $s   TextShape

[ Top ]

method drawRectRotated [line 307]

void drawRectRotated( g $gd, rect $rect, angle $angle, aZ $aZ, [ $animations = null])

Draws the Shape rectangle rotated by Angle degrees.



Tags:

access:  public


Parameters:

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

[ Top ]

method getFont [line 200]

ChartFont getFont( )

Determines the font attributes used to output ShapeSeries.<!-- -->Text Strings.



Tags:

access:  public


[ Top ]

method getLines [line 179]

String[] getLines( )

Accesses the array of Text lines.


Use lines to add multiline text to TeeChart's text objects (TeeChart Header, TeeChart Axis Titles etc.).
Default value: null




Tags:

access:  public


Overridden in child classes as:

SeriesMarks::getLines()
Contains the list of lines drawn on the chart by the user at run-time.
Legend::getLines()

[ Top ]

method getLinesLength [line 125]

void getLinesLength( )



Tags:

access:  protected


[ Top ]

method getShadowSize [line 112]

int getShadowSize( )

Obsolete.&nbsp;Please use Shadow.<!-- -->Size.



Tags:

access:  public


[ Top ]

method getShapeStyle [line 72]

TextShapeStyle getShapeStyle( )

Shape may be rectagular or rounded rectangular in shape.
Default value: TextShapeStyle.Rectangle



Tags:

access:  public


[ Top ]

method getText [line 145]

String getText( )

Displays customized strings inside Shapes.
You can use Font and Aligment to control Text display.

Note: You would maybe need to change Shape Font size to a different value when creating metafiles or when zooming Charts.



Tags:

access:  public


Overridden in child classes as:

Legend::getText()
Adds text to the Legend.

[ Top ]

method getTextFormat [line 97]

void getTextFormat( )

Determines if Text is drawn as Normal or HTML styles.

Default value: TextFormatted::$Normal




Tags:

access:  public


[ Top ]

method paint [line 227]

void paint( )

Paints the TextShape object on the Chart Canvas.



Tags:

access:  public


Overridden in child classes as:

Legend::paint()

Overrides TeeShape::paint() (parent method not documented)

[ Top ]

method readResolve [line 53]

void readResolve( )



Tags:

access:  protected


Overridden in child classes as:

AxisLabels::readResolve()
SeriesMarks::readResolve()
Legend::readResolve()
Title::readResolve()
Footer::readResolve()

[ Top ]

method setChart [line 59]

void setChart( $c)



Tags:

access:  public


Overridden in child classes as:

SeriesMarks::setChart()
Legend::setChart()

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

Parameters:

   $c  

[ Top ]

method setDrawText [line 76]

void setDrawText( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setLines [line 189]

void setLines( value $value)

Accesses the array of Text lines.


Default value: null




Tags:

access:  public


Overridden in child classes as:

Legend::setLines()

Parameters:

value   $value   String[]

[ Top ]

method setShadowSize [line 121]

void setShadowSize( value $value)

Obsolete.&nbsp;Please use Shadow.<!-- -->Size.



Tags:

access:  public


Parameters:

value   $value   int

[ Top ]

method setShapeStyle [line 86]

void setShapeStyle( value $value)

Shape may be rectagular or rounded rectangular in shape.
Default value: TextShapeStyle.Rectangle



Tags:

access:  public


Parameters:

value   $value   TextShapeStyle

[ Top ]

method setText [line 157]

void setText( value $value)

Displays customized strings inside Shapes.




Tags:

access:  public


Overridden in child classes as:

Legend::setText()
Adds text to the Legend.

Parameters:

value   $value   String

[ Top ]

method setTextFormat [line 101]

void setTextFormat( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method _paint [line 237]

void _paint( g $gd, rect $rect, [ $animations = null])

Paints the TextShape object on the Chart Canvas.



Tags:

access:  public


Parameters:

g   $gd   IGraphics3D
rect   $rect   Rectangle
   $animations  

[ Top ]

method __get [line 27]

void __get( $property)



Overridden in child classes as:

AxisLabelItem::__get()
AxisLabels::__get()
AxisTitle::__get()
LegendTitle::__get()
SeriesMarks::__get()
TextShapePosition::__get()
Legend::__get()
Title::__get()
Footer::__get()

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

Parameters:

   $property  

[ Top ]

method __set [line 34]

void __set( $property, $value)



Overridden in child classes as:

AxisLabelItem::__set()
AxisLabels::__set()
AxisTitle::__set()
LegendTitle::__set()
SeriesMarks::__set()
TextShapePosition::__set()
Legend::__set()
Title::__set()
Footer::__set()

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

Parameters:

   $property  
   $value  

[ Top ]


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