com.steema.teechart
Class Shape

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.Shape

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Panel, TextShape, Wall

public class Shape
extends TeeBase

Title: Shape class

Description: Base class for Chart Shape elements

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

Company: Steema Software SL

See Also:

Serialized Form

Field Summary

protected Bevel	bBevel
protected int	bBorderRound
protected ChartBrush	bBrush
protected ImageBevel	bImageBevel
protected boolean	bTransparent
protected boolean	defaultVisible
protected ChartPen	pPen
protected Shadow	shadow
protected Rectangle	shapeBounds
protected boolean	visible

Fields inherited from class com.steema.teechart.TeeBase

chart

Constructor Summary

Shape()

Shape(IBaseChart c)

Method Summary

void	assign(Shape s) Assign all properties from a shape to another.
Bevel	getBevel() Sets the bevel characteristics of the Shape.
BevelStyle	getBevelInner() Obsolete.
BevelStyle	getBevelOuter() Obsolete.
int	getBevelWidth() Obsolete.
int	getBorderRound() Rounds the Borders of the Chart Shapes.
int	getBottom() Shape rectangle bottom co-ordinate.
ChartBrush	getBrush() Defines the kind of brush used to fill shape background.
Color	getColor() Defines the shape Color.
Gradient	getGradient() Calls the Gradient characteristics for the shape.
int	getHeight()
java.awt.Image	getImage() Rendered Image for Shape background.
ImageBevel	getImageBevel() Sets the bevel characteristics of the Shape.
ImageMode	getImageMode() ImageMode for rendered Shape background Image.
boolean	getImageTransparent() Sets the shape image to transparent.
int	getLeft() Shape rectangle left co-ordinate.
ChartPen	getPen() Specifies the pen used to draw the shape.
int	getRight() Shape rectangle right co-ordinate.
Shadow	getShadow() Defines the shape's Shadow characteristics.
Rectangle	getShapeBounds() Defines the boundaries of the Shape.
int	getTop() Shape rectangle top co-ordinate.
int	getTransparency() The Transparency level from 0 to 100% of shape.
boolean	getTransparent() Enables/disables transparency of shape.
boolean	getVisible() Shows or hides the Shape.
int	getWidth()
void	paint(IGraphics3D g, Rectangle rect)
void	setBevel(Bevel value) Internal use - serialization
void	setBevelInner(BevelStyle value) Defines the inner bevel type of the TChart Panel border.
void	setBevelOuter(BevelStyle value) Defines the outer bevel type of the TChart Panel border.
void	setBevelWidth(int value) Obsolete.
void	setBorderRound(int value) Rounds the Borders of the Chart Shapes.
void	setBottom(int value) Shape rectangle bottom co-ordinate.
void	setBrush(ChartBrush value) Internal use - serialization
void	setChart(IBaseChart c) Chart associated with this object.
void	setColor(java.awt.Color value)
void	setColor(Color value) Defines the shape Color.
void	setDefaultVisible(boolean value)
void	setHeight(int value)
void	setImage(java.awt.Image value) Sets Rendered Image for Shape background.
void	setImageMode(ImageMode value) Sets the ImageMode for rendered Shape background Image.
void	setImageTransparent(boolean value)
void	setLeft(int value) Shape rectangle left co-ordinate.
void	setPen(ChartPen value) Internal use - serialization
void	setRight(int value) Shape rectangle right co-ordinate.
void	setShapeBounds(Rectangle value) Defines the boundaries of the Shape.
void	setTop(int value) Shape rectangle top co-ordinate.
void	setTransparency(int value) Sets Transparency level from 0 to 100% of shape.
void	setTransparent(boolean value) Enables/disables transparency of shape.
void	setVisible(boolean value) Shows or hides the Shape.
void	setWidth(int value)

Methods inherited from class com.steema.teechart.TeeBase

getChart, invalidate, setBooleanProperty, setColorProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultVisible

protected transient boolean defaultVisible

visible

protected boolean visible

bTransparent

protected boolean bTransparent

pPen

protected ChartPen pPen

bBevel

protected Bevel bBevel

shadow

protected Shadow shadow

bImageBevel

protected ImageBevel bImageBevel

bBrush

protected ChartBrush bBrush

shapeBounds

protected Rectangle shapeBounds

bBorderRound

protected int bBorderRound

Constructor Detail

Shape

public Shape()

Shape

public Shape(IBaseChart c)

Method Detail

getShapeBounds

public Rectangle getShapeBounds()

Defines the boundaries of the Shape.

Returns:

Rectangle

setShapeBounds

public void setShapeBounds(Rectangle value)

Defines the boundaries of the Shape.

Parameters:

value - Rectangle

getBevelInner

public BevelStyle getBevelInner()

Obsolete.&ndsp;Please use Bevel.Inner.

Returns:

BevelStyle

setBevelInner

public void setBevelInner(BevelStyle value)

Defines the inner bevel type of the TChart Panel border.
Available types:
None
Lowered
Raised

Parameters:

value - BevelStyle

getBevelWidth

public int getBevelWidth()

Obsolete. Please use Bevel.Width

Returns:

int

setBevelWidth

public void setBevelWidth(int value)

Obsolete. Please use Bevel.Width

Parameters:

value - int

getBevelOuter

public BevelStyle getBevelOuter()

Obsolete. Please use Bevel.Outer

Returns:

BevelStyle

setBevelOuter

public void setBevelOuter(BevelStyle value)

Defines the outer bevel type of the TChart Panel border.
Available types:
None
Lowered
Raised

Parameters:

value - BevelStyle

setChart

public void setChart(IBaseChart c)

Chart associated with this object.

Overrides:

setChart in class TeeBase

Parameters:

c - IBaseChart

getImageBevel

public ImageBevel getImageBevel()

Sets the bevel characteristics of the Shape.

Returns:

ImageBevel

getBevel

public Bevel getBevel()

Sets the bevel characteristics of the Shape.

Returns:

Bevel

setBevel

public void setBevel(Bevel value)

Internal use - serialization

getShadow

public Shadow getShadow()

Defines the shape's Shadow characteristics.

Returns:

Shadow

getBrush

public ChartBrush getBrush()

Defines the kind of brush used to fill shape background.

Returns:

ChartBrush

setBrush

public void setBrush(ChartBrush value)

Internal use - serialization

getBorderRound

public int getBorderRound()

Rounds the Borders of the Chart Shapes.

Returns:

int

setBorderRound

public void setBorderRound(int value)

Rounds the Borders of the Chart Shapes.

Parameters:

value - int

getImage

public java.awt.Image getImage()

Rendered Image for Shape background.
Default value: null

Returns:

Image

setDefaultVisible

public void setDefaultVisible(boolean value)

setImage

public void setImage(java.awt.Image value)

Sets Rendered Image for Shape background.
Default value: null

Parameters:

value - Image

getImageMode

public ImageMode getImageMode()

ImageMode for rendered Shape background Image.
Default value: ImageMode.Stretch

Returns:

ImageMode

setImageMode

public void setImageMode(ImageMode value)

Sets the ImageMode for rendered Shape background Image.
Default value: ImageMode.Stretch

Parameters:

value - ImageMode

getImageTransparent

public boolean getImageTransparent()

Sets the shape image to transparent.

Returns:

boolean

setImageTransparent

public void setImageTransparent(boolean value)

getColor

public Color getColor()

Defines the shape Color.

Returns:

Color

setColor

public void setColor(java.awt.Color value)

setColor

public void setColor(Color value)

Defines the shape Color.

Parameters:

value - Color

getGradient

public Gradient getGradient()

Calls the Gradient characteristics for the shape.

Returns:

Gradient

getVisible

public boolean getVisible()

Shows or hides the Shape.

Returns:

boolean

setVisible

public void setVisible(boolean value)

Shows or hides the Shape.

Parameters:

value - boolean

getTransparent

public boolean getTransparent()

Enables/disables transparency of shape.
See transparency, which sets percentage transparency when Transparent is true.

Returns:

boolean

See Also:

getTransparency()

setTransparent

public void setTransparent(boolean value)

Enables/disables transparency of shape.

Parameters:

value - boolean

getPen

public ChartPen getPen()

Specifies the pen used to draw the shape.

Returns:

ChartPen

setPen

public void setPen(ChartPen value)

Internal use - serialization

getLeft

public int getLeft()

Shape rectangle left co-ordinate.

Returns:

int

setLeft

public void setLeft(int value)

Shape rectangle left co-ordinate.

getTop

public int getTop()

Shape rectangle top co-ordinate.

Returns:

int

setTop

public void setTop(int value)

Shape rectangle top co-ordinate.

Parameters:

value - int

getRight

public int getRight()

Shape rectangle right co-ordinate.

Returns:

int

setRight

public void setRight(int value)

Shape rectangle right co-ordinate.

Parameters:

value - int

getBottom

public int getBottom()

Shape rectangle bottom co-ordinate.

Returns:

int

setBottom

public void setBottom(int value)

Shape rectangle bottom co-ordinate.

Parameters:

value - int

getHeight

public int getHeight()

setHeight

public void setHeight(int value)

getWidth

public int getWidth()

setWidth

public void setWidth(int value)

assign

public void assign(Shape s)

Assign all properties from a shape to another.

Parameters:

s - Shape

paint

public void paint(IGraphics3D g,
                  Rectangle rect)

getTransparency

public int getTransparency()

The Transparency level from 0 to 100% of shape.
Transparency is a value between 0 and 100 which sets the transparency percentage with respect to foreground versus background.
Default value: 0

Returns:

int

setTransparency

public void setTransparency(int value)

Sets Transparency level from 0 to 100% of shape.
Default value: 0

Parameters:

value - int