Title (Slothsoft Charts)

java.lang.Object
- de.slothsoft.charts.common.Title

All Implemented Interfaces:

ChartPart, Drawable
```
public class Title
extends Object
implements ChartPart
```
A title over an Chart. On default it's not visible, you need to use setText(String) to get it to be displayed.

Since:

0.1.0

Author:

Stef Schulz

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Title.Position
The position of the Title.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Title.Position` The position of the `Title`.

Constructor Summary

Constructors
Constructor and Description

Title()

Constructors
Constructor and Description
`Title()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRefreshListener(RefreshListener listener)` Adds a refresh listener that is called whenever this `Drawable` needs to be redrawn by the GUI.
`Title`	`alignment(TextAlignment newAlignment)` Sets the alignment of the title.
`Title`	`color(int newColor)` Sets the color as ARGB int, e.g.
`Title`	`font(Font newFont)` Sets the font used to paint the title.
`TextAlignment`	`getAlignment()` Returns the alignment of the title.
`int`	`getColor()` Returns the color as ARGB int, e.g.
`Font`	`getFont()` Returns the font used to paint the title.
`Title.Position`	`getPosition()` Returns the position of the title.
`double`	`getSize()` Returns the height of the title, if one is drawn.
`String`	`getText()` Returns the text that is the title or `null` to show there is no title.
`void`	`paintOn(GraphicContext gc, PaintInstructions instructions)` Paints the current content onto the graphic context.
`Title`	`position(Title.Position newPosition)` Sets the position of the title.
`void`	`removeRefreshListener(RefreshListener listener)` Removes a refresh listener that was called whenever this `Drawable` needed to be redrawn by the GUI.
`void`	`setAlignment(TextAlignment alignment)` Sets the alignment of the title.
`void`	`setColor(int color)` Sets the color as ARGB int, e.g.
`void`	`setFont(Font font)` Sets the font used to paint the title.
`void`	`setPosition(Title.Position position)` Sets the position of the title.
`void`	`setSize(double size)` Sets the height of the title, if one is drawn.
`void`	`setText(String text)` Sets the text that is the title or `null` to show there is no title.
`Title`	`size(double newSize)` Sets the height of the title, if one is drawn.
`Area`	`snipNecessarySpace(Area existingArea)` This method removes space from the existing area to make room for this part.
`Title`	`text(String newText)` Sets the text that is the title or `null` to show there is no title.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Title
```
public Title()
```
- Method Detail
  - paintOn
```
public void paintOn(GraphicContext gc,
                    PaintInstructions instructions)
```
    Description copied from interface: ChartPart
    
    Paints the current content onto the graphic context. Checks the instructions for what to paint. Coordinates are starting from the top left with 0|0 and ending bottom right with something like 800|600.
    
    Specified by:
    
    paintOn in interface ChartPart
    
    Specified by:
    
    paintOn in interface Drawable
    
    Parameters:
    
    gc - graphic context; coordinates are relative to the Chart
    
    instructions - additional instructions like the area to paint on
  - snipNecessarySpace
```
public Area snipNecessarySpace(Area existingArea)
```
    Description copied from interface: ChartPart
    
    This method removes space from the existing area to make room for this part. E.g. a part on the left of the graph would increase the x and decrease the width.
    
    Specified by:
    
    snipNecessarySpace in interface ChartPart
    
    Parameters:
    
    existingArea - the area this part could use
    
    Returns:
    
    the area for the next parts
  - addRefreshListener
```
public void addRefreshListener(RefreshListener listener)
```
    Description copied from interface: Drawable
    
    Adds a refresh listener that is called whenever this Drawable needs to be redrawn by the GUI.
    
    Specified by:
    
    addRefreshListener in interface Drawable
    
    Parameters:
    
    listener - a listener
  - removeRefreshListener
```
public void removeRefreshListener(RefreshListener listener)
```
    Description copied from interface: Drawable
    
    Removes a refresh listener that was called whenever this Drawable needed to be redrawn by the GUI. Does nothing if the listener was never added.
    
    Specified by:
    
    removeRefreshListener in interface Drawable
    
    Parameters:
    
    listener - a listener
  - getText
```
public String getText()
```
    Returns the text that is the title or null to show there is no title.
    
    Returns:
    
    the text
  - text
```
public Title text(String newText)
```
    Sets the text that is the title or null to show there is no title.
    
    Parameters:
    
    newText - the text
    
    Returns:
    
    this instance
  - setText
```
public void setText(String text)
```
    Sets the text that is the title or null to show there is no title.
    
    Parameters:
    
    text - the text
  - getColor
```
public int getColor()
```
    Returns the color as ARGB int, e.g. red is 0xFFFF0000 and blue is 0xFF0000FF.
    
    Returns:
    
    the color
  - color
```
public Title color(int newColor)
```
    Sets the color as ARGB int, e.g. red is 0xFFFF0000 and blue is 0xFF0000FF.
    
    Parameters:
    
    newColor - the color
    
    Returns:
    
    this instance
  - setColor
```
public void setColor(int color)
```
    Sets the color as ARGB int, e.g. red is 0xFFFF0000 and blue is 0xFF0000FF.
    
    Parameters:
    
    color - the color
  - getFont
```
public Font getFont()
```
    Returns the font used to paint the title.
    
    Returns:
    
    the font; never null
  - font
```
public Title font(Font newFont)
```
    Sets the font used to paint the title.
    
    Parameters:
    
    newFont - the font; cannot be null
    
    Returns:
    
    this instance
  - setFont
```
public void setFont(Font font)
```
    Sets the font used to paint the title.
    
    Parameters:
    
    font - the font; cannot be null
  - getSize
```
public double getSize()
```
    Returns the height of the title, if one is drawn.
    
    Returns:
    
    the title's size
  - size
```
public Title size(double newSize)
```
    Sets the height of the title, if one is drawn.
    
    Parameters:
    
    newSize - the title's size
    
    Returns:
    
    this instance
  - setSize
```
public void setSize(double size)
```
    Sets the height of the title, if one is drawn.
    
    Parameters:
    
    size - the title's size
  - getPosition
```
public Title.Position getPosition()
```
    Returns the position of the title.
    
    Returns:
    
    the position; never null
  - position
```
public Title position(Title.Position newPosition)
```
    Sets the position of the title.
    
    Parameters:
    
    newPosition - the position; cannot be null
    
    Returns:
    
    this instance
  - setPosition
```
public void setPosition(Title.Position position)
```
    Sets the position of the title.
    
    Parameters:
    
    position - the position; cannot be null
  - getAlignment
```
public TextAlignment getAlignment()
```
    Returns the alignment of the title.
    
    Returns:
    
    the alignment; never null
  - alignment
```
public Title alignment(TextAlignment newAlignment)
```
    Sets the alignment of the title.
    
    Parameters:
    
    newAlignment - the alignment; cannot be null
    
    Returns:
    
    this instance
  - setAlignment
```
public void setAlignment(TextAlignment alignment)
```
    Sets the alignment of the title.
    
    Parameters:
    
    alignment - the alignment; cannot be null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Title

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Title

Method Detail

paintOn

snipNecessarySpace

addRefreshListener

removeRefreshListener

getText

text

setText

getColor

color

setColor

getFont

font

setFont

getSize

size

setSize

getPosition

position

setPosition

getAlignment

alignment

setAlignment

toString