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

Class: Title

Source Location: /Title.php

Class Overview

TeeBase
   |
   --TeeShape
      |
      --TextShape
         |
         --TextShapePosition
            |
            --Title

Title class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Child classes:

Footer
Footer class
Header
Header class

Inherited Variables

Inherited Methods

Class: TextShapePosition

TextShapePosition::TextShapePosition()
TextShapePosition::getCustomPosition()
Allows custom positioning of TextShape when true.
Default value: false
TextShapePosition::setCustomPosition()
Set to true to permit custom positioning of TextShape.
Default value: false
TextShapePosition::shouldSerializeBottom()
TextShapePosition::shouldSerializeLeft()
TextShapePosition::shouldSerializeRight()
TextShapePosition::shouldSerializeTop()
TextShapePosition::__get()
TextShapePosition::__set()

Class: TextShape

TextShape::TextShape()
The class constructor.
TextShape::assign()
Assign all properties from a TextShape to another.
TextShape::drawRectRotated()
Draws the Shape rectangle rotated by Angle degrees.
TextShape::getFont()
Determines the font attributes used to output ShapeSeries.<!-- -->Text Strings.
TextShape::getLines()
Accesses the array of Text lines.
TextShape::getLinesLength()
TextShape::getShadowSize()
Obsolete.&nbsp;Please use Shadow.<!-- -->Size.
TextShape::getShapeStyle()
Shape may be rectagular or rounded rectangular in shape.
Default value: TextShapeStyle.Rectangle
TextShape::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.
TextShape::getTextFormat()
Determines if Text is drawn as Normal or HTML styles.
TextShape::paint()
Paints the TextShape object on the Chart Canvas.
TextShape::readResolve()
TextShape::setChart()
TextShape::setDrawText()
TextShape::setLines()
Accesses the array of Text lines.
TextShape::setShadowSize()
Obsolete.&nbsp;Please use Shadow.<!-- -->Size.
TextShape::setShapeStyle()
Shape may be rectagular or rounded rectangular in shape.
Default value: TextShapeStyle.Rectangle
TextShape::setText()
Displays customized strings inside Shapes.
TextShape::setTextFormat()
TextShape::_paint()
Paints the TextShape object on the Chart Canvas.
TextShape::__get()
TextShape::__set()

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]
Title class

Description: Underlying Title characteristics




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

$onTop =  true

[line 25]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor Title [line 42]

Title Title( $c)



Tags:

access:  public


Parameters:

   $c  

[ Top ]

method clicked [line 160]

boolean clicked( p $p)

Returns if mouse cursor is inside TChartTitle bound rectangle.

The Title.Visible property must be true.
The Title rectangle size depends on Title.Pen.Visible and Title.AdjustFrame.



Tags:

access:  public


Parameters:

p   $p   Point

[ Top ]

method doDraw [line 178]

void doDraw( $gd, $rect, $customOnly)



Parameters:

   $gd  
   $rect  
   $customOnly  

[ Top ]

method draw [line 186]

void draw( $gd, $rect)



Tags:

access:  protected


Parameters:

   $gd  
   $rect  

[ Top ]

method getAdjustFrame [line 64]

boolean getAdjustFrame( )

Resizes Header and Footer frames to full Chart dimensions when true.


When false it resizes to the Title text width. It only has effect when Chart.Header or Chart.Footer.Visible is true.
Default value: true




Tags:

access:  public


[ Top ]

method getAlignment [line 88]

StringAlignment getAlignment( )

Determines how tChart Header and Footer text will be aligned within the

Chart rectangle.
The Header or Footer can optionally be surrounded by a Frame.
Default value: Center




Tags:

access:  public


[ Top ]

method readResolve [line 51]

void readResolve( )



Tags:

access:  protected


Overridden in child classes as:

Footer::readResolve()

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

[ Top ]

method setAdjustFrame [line 76]

void setAdjustFrame( value $value)

Resizes Header and Footer frames to full Chart dimensions when true.


When false it resizes to the Title text width. It only has effect when Chart.Header or Chart.Footer.Visible is true.
Default value: true




Tags:

access:  public


Parameters:

value   $value   boolean

[ Top ]

method setAlignment [line 100]

void setAlignment( value $value)

Sets how tChart Header and Footer text will be aligned within the

Chart rectangle.
The Header or Footer can optionally be surrounded by a Frame.
Default value: Center




Tags:

access:  public


Parameters:

value   $value   StringAlignment

[ Top ]

method _clicked [line 174]

boolean _clicked( x $x, y $y)

Returns if mouse cursor is inside TChartTitle bound rectangle.

The Title.Visible property must be true.
The Title rectangle size depends on Title.Pen.Visible and Title.AdjustFrame.



Tags:

access:  public


Parameters:

x   $x   int
y   $y   int

[ Top ]

method __get [line 28]

void __get( $property)



Overridden in child classes as:

Footer::__get()

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

Parameters:

   $property  

[ Top ]

method __set [line 35]

void __set( $property, $value)



Overridden in child classes as:

Footer::__set()

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

Parameters:

   $property  
   $value  

[ Top ]


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