Package com.storedobject.chart

Class Tooltip

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.VisiblePart

com.storedobject.chart.Tooltip

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasData

public class Tooltip
extends VisiblePart
implements Component, HasData

Tooltip to display.

In most cases, default tooltips are good enough. However, you can still create customized tooltips using these methods: append(String), append(AbstractDataProvider), append(Chart), newline().

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Tooltip.Type	Type of tooltips.

Constructor Summary

Constructors

Constructor	Description
Tooltip()

Method Summary

Modifier and Type	Method	Description
void	addParts(SOChart soChart)	Add parts of this component to the chart.
Tooltip	append(AbstractDataProvider<?> data)	Add a data point to the tooltip.
Tooltip	append(Chart chart)	Add a data point of a specific chart to the tooltip.
Tooltip	append(String part)	Add some text as part of the tooltip.
void	declareData(Set<AbstractDataProvider<?>> dataSet)	Declare the data set owned by this ComponentPart by adding it to the Set provided.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final Tooltip.Type	getType()	Get the type of this tooltip.
Tooltip	newline()	Add a new line to the tooltip.
void	setType(Tooltip.Type type)	Set the type of this tooltip.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class com.storedobject.chart.VisiblePart

hide, show

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getName, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.Component

getEvents

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getId, getName, getRenderingIndex, getSerial, setName, setRenderingIndex, setSerial

Constructor Details

Tooltip

public Tooltip()

Method Details

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class VisiblePart

Parameters:

sb - Encoded JSON string to be appended to this.

validate

public void validate()

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Overrides:

validate in class VisiblePart

getType

public final Tooltip.Type getType()

Get the type of this tooltip.

Returns:

Type.

setType

public void setType(Tooltip.Type type)

Set the type of this tooltip.

Parameters:

type - Type of the tooltip.

append

public Tooltip append(String part)

Add some text as part of the tooltip.

Parameters:

part - Part to be added.

Returns:

Self reference.

newline

public Tooltip newline()

Add a new line to the tooltip.

Returns:

Self reference.

append

public Tooltip append(AbstractDataProvider<?> data)

Add a data point to the tooltip.

Parameters:

data - Data point will be taken from this data.

Returns:

Self reference.

append

public Tooltip append(Chart chart)

Add a data point of a specific chart to the tooltip. Mostly, you can use append(AbstractDataProvider) to add data point but some special charts (such as HeatmapChart) have specialized internal data and data points from such data can be added using this method.

Parameters:

chart - Chart from which data point should be taken.

Returns:

Self reference.

declareData

public void declareData(Set<AbstractDataProvider<?>> dataSet)

Description copied from interface: HasData

Declare the data set owned by this ComponentPart by adding it to the Set provided.

Specified by:

declareData in interface HasData

Parameters:

dataSet - Set to which all the data owned by this ComponentPart needs to be added.

addParts

public void addParts(SOChart soChart)

Description copied from interface: Component

Add parts of this component to the chart. This will be invoked if the component was already added to the chart, and it is about to be rendered.

Specified by:

addParts in interface Component

Parameters:

soChart - Chart to which components to be added.