com.steema.teechart.drawing
Class ChartFont

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.drawing.ChartFont

public final class ChartFont
extends TeeBase

Title: ChartFont class

Description: Common Chart Font. Font methods used at several objects.

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

Company: Steema Software SL


Field Summary
static java.lang.String DEFAULTFAMILY
           
static int DEFAULTSIZE
           
 
Fields inherited from class com.steema.teechart.TeeBase
chart, InternalUse
 
Constructor Summary
ChartFont(IBaseChart c)
           
 
Method Summary
 void assign(ChartFont f)
           
 boolean getBold()
          Bold Font for text.
 ChartBrush getBrush()
          Sets the Brush characteristics of the font.
 Color getColor()
          Defines a Font color for text.
 double getDrawingFontSize()
           
 Gradient getGradient()
          Applies a gradient fill to the font.
 boolean getItalic()
          Italic Font (true or false) for text.
 java.lang.String getName()
          Defines a Font type for text.
 ChartPen getOutline()
           
 Shadow getShadow()
          Accesses the shadow properties of the font.
 int getSize()
          The Font size (in points) for text.
 boolean getStrikeout()
          Font Strikeout on/off.
 boolean getUnderline()
          Underline Font for text.
 void hideOutline()
           
 void hideShadow()
           
 void invalidate()
          Use Invalidate when the entire canvas needs to be repainted.
 void reset()
           
 void setBold(boolean value)
          Sets Font bold for text.
 void setChart(IBaseChart c)
          Chart associated with this object.
 void setColor(Color value)
          Defines a Font color for text.
 void setItalic(boolean value)
          Sets Font italic (true or false) for text.
 void setName(java.lang.String value)
          Specifies a Font type for text.
 void setSize(int value)
          Sets Font sizing (in points) for text.
 void setStrikeout(boolean value)
          Sets Font Strikeout on/off.
 void setUnderline(boolean value)
          Sets Font underline on/off.
 boolean shouldDrawShadow()
           
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, setBooleanProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULTSIZE

public static final transient int DEFAULTSIZE
See Also:
Constant Field Values

DEFAULTFAMILY

public static final transient java.lang.String DEFAULTFAMILY
See Also:
Constant Field Values
Constructor Detail

ChartFont

public ChartFont(IBaseChart c)
Method Detail

getName

public java.lang.String getName()
Defines a Font type for text.
Default value: Arial

Returns:
String

setName

public void setName(java.lang.String value)
Specifies a Font type for text.
Default value: Arial

Parameters:
value - String

invalidate

public void invalidate()
Use Invalidate when the entire canvas needs to be repainted.
When more than one region within the canvas needs repainting, Invalidate will cause the entire window to be repainted in a single pass, avoiding flicker caused by redundant repaints.
There is no performance penalty for calling Invalidate multiple times before the control is actually repainted.

Overrides:
invalidate in class TeeBase

getSize

public int getSize()
The Font size (in points) for text.
When managing Font sizes of Drawing Canvas custom outputted text relative to Chart text (titles, labels, etc.), use Font.Height to size the Canvas text.
Default value: 8

Returns:
int

setSize

public void setSize(int value)
Sets Font sizing (in points) for text.
Default value: 8

Parameters:
value - int

getBold

public boolean getBold()
Bold Font for text.
Default value: false

Returns:
boolean

setBold

public void setBold(boolean value)
Sets Font bold for text.
Default value: false

Parameters:
value - boolean

reset

public void reset()

getItalic

public boolean getItalic()
Italic Font (true or false) for text.
Default value: false

Returns:
boolean

setItalic

public void setItalic(boolean value)
Sets Font italic (true or false) for text.
Default value: false

Parameters:
value - boolean

getUnderline

public boolean getUnderline()
Underline Font for text.
Default value: false

Returns:
boolean

setUnderline

public void setUnderline(boolean value)
Sets Font underline on/off.
Default value: false

Parameters:
value - boolean

getStrikeout

public boolean getStrikeout()
Font Strikeout on/off.
Default value: false

Returns:
boolean

setStrikeout

public void setStrikeout(boolean value)
Sets Font Strikeout on/off.
Default value: false

Parameters:
value - boolean

getColor

public Color getColor()
Defines a Font color for text.

Returns:
Color

setColor

public void setColor(Color value)
Defines a Font color for text.

Parameters:
value - Color

getGradient

public Gradient getGradient()
Applies a gradient fill to the font.

Returns:
Gradient

getShadow

public Shadow getShadow()
Accesses the shadow properties of the font.

Returns:
Shadow

shouldDrawShadow

public boolean shouldDrawShadow()

assign

public void assign(ChartFont f)

setChart

public void setChart(IBaseChart c)
Description copied from class: TeeBase
Chart associated with this object.

Overrides:
setChart in class TeeBase
Parameters:
c - IBaseChart

getBrush

public ChartBrush getBrush()
Sets the Brush characteristics of the font.

Returns:
ChartBrush

getOutline

public ChartPen getOutline()

getDrawingFontSize

public double getDrawingFontSize()

hideOutline

public void hideOutline()

hideShadow

public void hideShadow()