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

Class: Rectangle

Source Location: /Rectangle.php

Class Overview


Rectangle class


Author(s):

Version:

  • 1.0

Copyright:

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

Variables

Methods


Child classes:

Square
Rectangle class

Class Details

[line 15]
Rectangle class

Description: Class to create the Rectangle object




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

$height =

[line 18]



Tags:

access:  public

Type:   mixed


[ Top ]

$width =

[line 19]



Tags:

access:  public

Type:   mixed


[ Top ]

$x =

[line 20]



Tags:

access:  public

Type:   mixed


[ Top ]

$y =

[line 21]



Tags:

access:  public

Type:   mixed


[ Top ]



Class Methods


static method fromLTRB [line 124]

static void fromLTRB( $x, $y, $right, $bottom)



Tags:

access:  public


Parameters:

   $x  
   $y  
   $right  
   $bottom  

[ Top ]

static method __intersect [line 212]

static void __intersect( $src1, $src2, $dest)



Tags:

access:  public


Parameters:

   $src1  
   $src2  
   $dest  

[ Top ]

constructor Rectangle [line 38]

Rectangle Rectangle( [ $x = 0], [ $y = 0], [ $width = 0.0], [ $height = 0.0])



Parameters:

   $x  
   $y  
   $width  
   $height  

[ Top ]

method center [line 284]

void center( )



Tags:

access:  public


[ Top ]

method copy [line 114]

void copy( )



Tags:

access:  public


[ Top ]

method getArea [line 119]

void getArea( )



Tags:

access:  public


Overridden in child classes as:

Square::getArea()

[ Top ]

method getBottom [line 144]

int getBottom( )

Gets rectangle Bottom coordinate.



Tags:

access:  public


[ Top ]

method getCenterX [line 85]

void getCenterX( )



[ Top ]

method getCenterY [line 90]

void getCenterY( )



[ Top ]

method getHeight [line 274]

void getHeight( )



Tags:

access:  public


[ Top ]

method getLeft [line 154]

int getLeft( )

Gets rectangle Left coordinate.



Tags:

access:  public


[ Top ]

method getLocation [line 297]

the getLocation( )

Returns the location of this
.

This method is included for completeness, to parallel the

method of
  1. Component
.




Tags:

return:  
  1. Point
that is the top-left corner of this
.
access:  public


[ Top ]

method getRight [line 134]

int getRight( )

Gets rectangle Right coordinate.



Tags:

access:  public


[ Top ]

method getTop [line 183]

int getTop( )

Gets rectangle Top coordinate.



Tags:

access:  public


[ Top ]

method getWidth [line 264]

void getWidth( )



Tags:

access:  public


[ Top ]

method getX [line 95]

void getX( )



[ Top ]

method getY [line 100]

void getY( )



[ Top ]

method grow [line 362]

void grow( h $h, v $v)

Resizes the
both horizontally and vertically.

This method modifies the

so that it is
  1. h
units larger on both the left and right side, and
  1. v
units larger at both the top and bottom.

The new

has (
  1. x&nbsp;-&nbsp;h
,
  1. y&nbsp;-&nbsp;v
) as its top-left corner, a width of
&nbsp;
  1. +
&nbsp;
  1. 2h
, and a height of
&nbsp;
  1. +
&nbsp;
  1. 2v
.

If negative values are supplied for

  1. h
and
  1. v
, the size of the
decreases accordingly. The
method does not check whether the resulting values of
and
are non-negative.




Tags:

access:  public


Parameters:

h   $h   the horizontal expansion
v   $v   the vertical expansion

[ Top ]

method inflate [line 327]

void inflate( $horizontal, $vertical)



Tags:

access:  public


Parameters:

   $horizontal  
   $vertical  

[ Top ]

method intersect [line 207]

void intersect( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method intersects [line 231]

true intersects( r $r)

Determines whether or not this
and the specified
intersect. Two rectangles intersect if their intersection is nonempty.



Tags:

return:  if the specified
and this
intersect;
  1. false
otherwise.
access:  public


Parameters:

r   $r   the specified

[ Top ]

method isEmpty [line 322]

true isEmpty( )

Determines whether or not this
is empty. A
is empty if its width or its height is less than or equal to zero.



Tags:

return:  if this
is empty;
  1. false
otherwise.
access:  public


[ Top ]

method offset [line 333]

void offset( $w, $h)



Tags:

access:  public


Parameters:

   $w  
   $h  

[ Top ]

method setBottom [line 202]

void setBottom( $value)

Sets rectangle Bottom coordinate.



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setBounds [line 57]

void setBounds( $x, $y, $width, $height)



Parameters:

   $x  
   $y  
   $width  
   $height  

[ Top ]

method setFrame [line 256]

void setFrame( $x, $y, $w, $h)



Tags:

access:  public


Parameters:

   $x  
   $y  
   $w  
   $h  

[ Top ]

method setHeight [line 279]

void setHeight( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setLeft [line 163]

void setLeft( $value)

Sets rectangle Left coordinate.



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setLocation [line 63]

void setLocation( $x, $y)



Parameters:

   $x  
   $y  

[ Top ]

method setRectangle [line 47]

void setRectangle( &$rect)



Parameters:

   &$rect  

[ Top ]

method setRight [line 173]

void setRight( $value)

Sets rectangle Right coordinate.



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setSize [line 69]

void setSize( $w, $h)



Parameters:

   $w  
   $h  

[ Top ]

method setTop [line 192]

void setTop( $value)

Sets rectangle Top coordinate.



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setWidth [line 269]

void setWidth( $value)



Tags:

access:  public


Parameters:

   $value  

[ Top ]

method setX [line 75]

void setX( $x)



Parameters:

   $x  

[ Top ]

method setY [line 80]

void setY( $y)



Parameters:

   $y  

[ Top ]

method toString [line 105]

void toString( )



[ Top ]

method _setLocation [line 310]

void _setLocation( p $p)

Moves this
to the specified location.

This method is included for completeness, to parallel the

method of
  1. Component
.




Tags:

access:  public


Parameters:

p   $p   the
  1. Point
specifying the new location for this

[ Top ]

method __get [line 24]

void __get( $property)



Parameters:

   $property  

[ Top ]

method __set [line 31]

void __set( $property, $value)



Parameters:

   $property  
   $value  

[ Top ]


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