AnnotationGroup (Event Horizon Fight Statistics)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.eventhorizongilde.ehfs.chart
Class AnnotationGroup

java.lang.Object
  de.eventhorizongilde.ehfs.chart.AnnotationGroup

public class AnnotationGroup
extends Object
extends Object

A group of annotations. The primary purpose of annotation groups is to group similar annotations together under a single title and color, both of which are also used in a graph's legend.

Constructor Summary
`AnnotationGroup(String title, Color color, boolean legendIconAsBox)` Creates a new annotation group.

Method Summary
`void`	`add(IAnnotation annotation)` Adds a new annotation to this annotation group.
`List<IAnnotation>`	`getAnnotations()` Returns all annotations in this annotation group.
`Color`	`getColor()` Returns the color of this annotation group.
`String`	`getTitle()` Returns the title of this annotation group.
`boolean`	`isLegendIconAsBox()` Returns whether the legend item for this annotation group should be displayed as a box instead of a line.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

AnnotationGroup

public AnnotationGroup(String title,
                       Color color,
                       boolean legendIconAsBox)

Creates a new annotation group.

Parameters:: title - the title for the legend item; color - the color for annotations as well as the legend item; legendIconAsBox - true if the legend item should appear as a box instead of a line

Method Detail

getTitle

public String getTitle()

Returns the title of this annotation group. The title will be used for graphs' legends.

getColor

public Color getColor()

Returns the color of this annotation group. The color will be used for graph objects as well as the legends.

isLegendIconAsBox

public boolean isLegendIconAsBox()

Returns whether the legend item for this annotation group should be displayed as a box instead of a line.

add

public void add(IAnnotation annotation)

Adds a new annotation to this annotation group.

getAnnotations

public List<IAnnotation> getAnnotations()

Returns all annotations in this annotation group.