com.steema.teechart
Class Title

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.Shape
          extended by com.steema.teechart.TextShape
              extended by com.steema.teechart.TextShapePosition
                  extended by com.steema.teechart.Title
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
Footer, Header

public class Title
extends TextShapePosition

Title: Title class

Description: Underlying Title characteristics.

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

Company: Steema Software SL

See Also:
Serialized Form

Field Summary
protected  boolean onTop
           
 
Fields inherited from class com.steema.teechart.TextShapePosition
bCustomPosition
 
Fields inherited from class com.steema.teechart.TextShape
defaultText, drawText
 
Fields inherited from class com.steema.teechart.Shape
bBevel, bBorderRound, bBrush, bImageBevel, bTransparent, defaultVisible, pPen, shadow, shapeBounds, visible
 
Fields inherited from class com.steema.teechart.TeeBase
chart
 
Constructor Summary
Title(IBaseChart c)
           
 
Method Summary
 boolean clicked(int x, int y)
          Returns if mouse cursor is inside TChartTitle bound rectangle.
 boolean clicked(java.awt.Point p)
          Returns if mouse cursor is inside TChartTitle bound rectangle.
protected  Rectangle doDraw(IGraphics3D g, Rectangle rect, boolean customOnly)
           
protected  Rectangle draw(IGraphics3D g, Rectangle rect)
           
 boolean getAdjustFrame()
          Resizes Header and Footer frames to full Chart dimensions when true.
 StringAlignment getAlignment()
          Determines how tChart Header and Footer text will be aligned within the Chart rectangle.
protected  java.lang.Object readResolve()
           
 void setAdjustFrame(boolean value)
          Resizes Header and Footer frames to full Chart dimensions when true.
 void setAlignment(StringAlignment value)
          Sets how tChart Header and Footer text will be aligned within the Chart rectangle.
 
Methods inherited from class com.steema.teechart.TextShapePosition
getCustomPosition, setCustomPosition, shouldSerializeBottom, shouldSerializeLeft, shouldSerializeRight, shouldSerializeTop
 
Methods inherited from class com.steema.teechart.TextShape
assign, drawRectRotated, getFont, getLines, getLinesLength, getShadowSize, getShapeStyle, getText, getTextFormat, paint, paint, setChart, setDrawText, setLines, setShadowSize, setShapeStyle, setText, setTextFormat
 
Methods inherited from class com.steema.teechart.Shape
assign, getBevel, getBevelInner, getBevelOuter, getBevelWidth, getBorderRound, getBottom, getBrush, getColor, getGradient, getHeight, getImage, getImageBevel, getImageMode, getImageTransparent, getLeft, getPen, getRight, getShadow, getShapeBounds, getTop, getTransparency, getTransparent, getVisible, getWidth, setBevel, setBevelInner, setBevelOuter, setBevelWidth, setBorderRound, setBottom, setBrush, setColor, setColor, setDefaultVisible, setHeight, setImage, setImageMode, setImageTransparent, setLeft, setPen, setRight, setShapeBounds, setTop, setTransparency, setTransparent, setVisible, setWidth
 
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

onTop

protected transient boolean onTop
Constructor Detail

Title

public Title(IBaseChart c)
Method Detail

readResolve

protected java.lang.Object readResolve()
Overrides:
readResolve in class TextShape

getAdjustFrame

public 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

Returns:
boolean

setAdjustFrame

public void setAdjustFrame(boolean 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

Parameters:
value - boolean

getAlignment

public 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

Returns:
StringAlignment

setAlignment

public void setAlignment(StringAlignment 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

Parameters:
value - StringAlignment

clicked

public boolean clicked(java.awt.Point 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.

Parameters:
p - Point
Returns:
boolean

clicked

public boolean clicked(int x,
                       int 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.

Parameters:
x - int
y - int
Returns:
boolean

doDraw

protected Rectangle doDraw(IGraphics3D g,
                           Rectangle rect,
                           boolean customOnly)

draw

protected Rectangle draw(IGraphics3D g,
                         Rectangle rect)